Skip to content

TPortFactoryPublishSubscribe<TPayload, TUserHeader>

The factory for TMessagingPattern.PublishSubscribe. It can acquire dynamic and static service information and create Publisher or Subscriber ports.

Definition

Unit: Neslib.Iceoryx2.PublishSubscribe

type TPortFactoryPublishSubscribe<TPayload, TUserHeader> = record ... end;

Type Parameters

TPayload:

TUserHeader:

Properties

Name Description
Attributes Returns the attributes defined in the service
DynamicConfig Returns the DynamicConfig of the service. Contains all dynamic settings, like the current participants etc.
Handle
Name Returns the TServiceName of the service
ServiceHash Returns the TServiceHash of the service
StaticConfig Returns the StaticConfig of the service. Contains all settings that never change during the lifetime of the service.

Constructors

Name Description
Assign
Finalize
Initialize

Operators

Name Description
Equal
NotEqual

Methods

Name Description
BlockingCleanupDeadNodes Removes the stale system resources of all dead TNode's connected to this service.
Nodes Iterates over all TNode's of the service and calls for every TNode the provided callback. If an error occurs while acquiring the TNode's corresponding TNodeState the error is forwarded to the callback as input argument.
PublisherBuilder Returns a TPortFactoryPublisher to create a new publisher port.
SubscriberBuilder Returns a TPortFactorySubscriber to create a new subscriber port.
TryCleanupDeadNodes Removes the stale system resources of all dead TNode's connected to this service.

Property Descriptions

Attributes

Returns the attributes defined in the service

property Attributes: TAttributeSetView read GetAttributes

Type: TAttributeSetView


DynamicConfig

Returns the DynamicConfig of the service. Contains all dynamic settings, like the current participants etc.

property DynamicConfig: TDynamicConfigPublishSubscribe read GetDynamicConfig

Type: TDynamicConfigPublishSubscribe


Handle

property Handle: THandle read GetHandle

Type: THandle


Name

Returns the TServiceName of the service

property Name: TServiceNameView read GetName

Type: TServiceNameView


ServiceHash

Returns the TServiceHash of the service

property ServiceHash: TServiceHash read GetServiceHash

Type: TServiceHash


StaticConfig

Returns the StaticConfig of the service. Contains all settings that never change during the lifetime of the service.

property StaticConfig: TStaticConfigPublishSubscribe read GetStaticConfig

Type: TStaticConfigPublishSubscribe


Constructor Descriptions

Assign

constructor Assign(var ADest: TPortFactoryPublishSubscribe<TPayload, TUserHeader>; const ASrc: TPortFactoryPublishSubscribe<TPayload, TUserHeader>)

Parameters

ADest: TPortFactoryPublishSubscribe<TPayload, TUserHeader>

ASrc: TPortFactoryPublishSubscribe<TPayload, TUserHeader>


Finalize

destructor Finalize


Initialize

constructor Initialize


Operator Descriptions

Equal(TPortFactoryPublishSubscribe, Pointer)

class operator Equal(const ALeft: TPortFactoryPublishSubscribe<TPayload, TUserHeader>; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TPortFactoryPublishSubscribe<TPayload, TUserHeader>

ARight: Pointer

Returns

Boolean


NotEqual(TPortFactoryPublishSubscribe, Pointer)

class operator NotEqual(const ALeft: TPortFactoryPublishSubscribe<TPayload, TUserHeader>; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TPortFactoryPublishSubscribe<TPayload, TUserHeader>

ARight: Pointer

Returns

Boolean


Method Descriptions

BlockingCleanupDeadNodes(TDuration)

Removes the stale system resources of all dead TNode's connected to this service.

If a TNode cannot be cleaned up since the process has insufficient permissions then the TNode is skipped. If it is currently being cleaned up by another process then the cleaner will wait until the timeout as either passed or the cleaned was finished.

The timeout is applied to every individual dead TNode the function needs to wait on.

function BlockingCleanupDeadNodes(const ATimeout: TDuration): TCleanupState; inline

Parameters

ATimeout: TDuration

Returns

TCleanupState


Nodes(TCallback<TNodeState>)

Iterates over all TNode's of the service and calls for every TNode the provided callback. If an error occurs while acquiring the TNode's corresponding TNodeState the error is forwarded to the callback as input argument.

function Nodes(const ACallback: TCallback<TNodeState>): TResult<Void, TNodeListFailure>

Parameters

ACallback: TCallback<TNodeState>

Returns

TResult<Void, TNodeListFailure>


PublisherBuilder

Returns a TPortFactoryPublisher to create a new publisher port.

function PublisherBuilder: TPortFactoryPublisher<TPayload, TUserHeader>; inline

Returns

TPortFactoryPublisher<TPayload, TUserHeader>


SubscriberBuilder

Returns a TPortFactorySubscriber to create a new subscriber port.

function SubscriberBuilder: TPortFactorySubscriber<TPayload, TUserHeader>; inline

Returns

TPortFactorySubscriber<TPayload, TUserHeader>


TryCleanupDeadNodes

Removes the stale system resources of all dead TNode's connected to this service.

If a TNode cannot be cleaned up since the process has insufficient permissions or it is currently being cleaned up by another process then the TNode is skipped.

function TryCleanupDeadNodes: TCleanupState; inline

Returns

TCleanupState