TPortFactoryBlackboard<TKey>
Represents the port factory of a service with TMessagingPattern.Blackboard.
Definition
Unit: Neslib.Iceoryx2.Blackboard
Type Parameters
TKey:
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. |
| ListKeys | Iterates over all keys of the service and calls for every key the provided callback. |
| 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. |
| ReaderBuilder | Returns a TPortFactoryReader to create a new reader port |
| TryCleanupDeadNodes | Removes the stale system resources of all dead TNode's connected to this service. |
| WriterBuilder | Returns a TPortFactoryWriter to create a new writer port |
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: TDynamicConfigBlackboard read GetDynamicConfig
Type: TDynamicConfigBlackboard
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: TStaticConfigBlackboard read GetStaticConfig
Type: TStaticConfigBlackboard
Constructor Descriptions
Assign
constructor Assign(var ADest: TPortFactoryBlackboard<TKey>; const ASrc: TPortFactoryBlackboard<TKey>)
Parameters
ADest: TPortFactoryBlackboard<TKey>
ASrc: TPortFactoryBlackboard<TKey>
Finalize
destructor Finalize
Initialize
constructor Initialize
Operator Descriptions
Equal(TPortFactoryBlackboard, Pointer)
class operator Equal(const ALeft: TPortFactoryBlackboard<TKey>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TPortFactoryBlackboard<TKey>
ARight: Pointer
Returns
Boolean
NotEqual(TPortFactoryBlackboard, Pointer)
class operator NotEqual(const ALeft: TPortFactoryBlackboard<TKey>; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TPortFactoryBlackboard<TKey>
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
ListKeys(TCallback<TKey>)
Iterates over all keys of the service and calls for every key the provided callback.
procedure ListKeys(const ACallback: TCallback<TKey>)
Parameters
ACallback: TCallback<TKey>
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>
ReaderBuilder
Returns a TPortFactoryReader to create a new reader port
function ReaderBuilder: TPortFactoryReader<TKey>; 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
Returns
WriterBuilder
Returns a TPortFactoryWriter to create a new writer port
function WriterBuilder: TPortFactoryWriter<TKey>; inline