TPortFactoryEvent
Represents the port factory of a service with TMessagingPattern.Event.
Definition
Unit: Neslib.Iceoryx2.Event
Properties
| Name | Description |
|---|---|
| Attributes | Returns the attributes defined in the service |
| DynamicConfig | Returns the dynamic config 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 static config 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. |
| ListenerBuilder | Returns a TPortFactoryListener to create a new listener port |
| 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. |
| NotifierBuilder | Returns a TPortFactoryNotifier to create a new notifier 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 dynamic config of the service. Contains all dynamic settings, like the current participants etc.
property DynamicConfig: TDynamicConfigEvent read GetDynamicConfig
Type: TDynamicConfigEvent
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 static config of the service. Contains all settings that never change during the lifetime of the service.
property StaticConfig: TStaticConfigEvent read GetStaticConfig
Type: TStaticConfigEvent
Constructor Descriptions
Assign
constructor Assign(var ADest: TPortFactoryEvent; const ASrc: TPortFactoryEvent)
Parameters
ADest: TPortFactoryEvent
ASrc: TPortFactoryEvent
Finalize
destructor Finalize
Initialize
constructor Initialize
Operator Descriptions
Equal(TPortFactoryEvent, Pointer)
class operator Equal(const ALeft: TPortFactoryEvent; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TPortFactoryEvent
ARight: Pointer
Returns
Boolean
NotEqual(TPortFactoryEvent, Pointer)
class operator NotEqual(const ALeft: TPortFactoryEvent; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TPortFactoryEvent
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
ListenerBuilder
Returns a TPortFactoryListener to create a new listener port
function ListenerBuilder: TPortFactoryListener; inline
Returns
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>
NotifierBuilder
Returns a TPortFactoryNotifier to create a new notifier port
function NotifierBuilder: TPortFactoryNotifier; inline
Returns
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