TNodeState
Describes the state of a TNode.
Definition
Unit: Neslib.Iceoryx2.Types
Properties
| Name | Description |
|---|---|
| NodeId | Returns the TUniqueNodeId of the corresponding TNode. |
| ServiceType | The service type for the corresponding TNode. |
Constructors
| Name | Description |
|---|---|
| Create |
Methods
| Name | Description |
|---|---|
| Alive | If the TNode is alive the provided callback is called with a TAliveNodeView as argument. |
| Dead | If the TNode is dead the provided callback is called with a TDeadNodeView as argument. |
| Inaccessible | If the TNode is inaccessible due to a lack of permissions the provided callback is called with a TUniqueNodeId as argument. |
| Undefined | If the TNode's files are corrupted or some essential constructs are missing the provided callback is called with a TUniqueNodeId as argument. |
Property Descriptions
NodeId
Returns the TUniqueNodeId of the corresponding TNode.
property NodeId: TUniqueNodeId read FNodeId
Type: TUniqueNodeId
ServiceType
The service type for the corresponding TNode.
property ServiceType: TServiceType read FServiceType
Type: TServiceType
Constructor Descriptions
Create
constructor Create(const AState: _iox2_node_state_e; const AServiceType: TServiceType; const ANodeId: TUniqueNodeId; const ADetails: Nullable<TNodeDetails>)
Parameters
AState: _iox2_node_state_e
AServiceType: TServiceType
ANodeId: TUniqueNodeId
ADetails: Nullable<TNodeDetails>
Method Descriptions
Alive(TNodeStateCallback<TAliveNodeView>)
If the TNode is alive the provided callback is called with a TAliveNodeView as argument.
function Alive(const ACallback: TNodeStateCallback<TAliveNodeView>): PNodeState; inline
Parameters
ACallback: TNodeStateCallback<TAliveNodeView>
Returns
Dead(TNodeStateCallback<TDeadNodeView>)
If the TNode is dead the provided callback is called with a TDeadNodeView as argument.
function Dead(const ACallback: TNodeStateCallback<TDeadNodeView>): PNodeState; inline
Parameters
ACallback: TNodeStateCallback<TDeadNodeView>
Returns
Inaccessible(TNodeStateCallback<TUniqueNodeId>)
If the TNode is inaccessible due to a lack of permissions the provided callback is called with a TUniqueNodeId as argument.
function Inaccessible(const ACallback: TNodeStateCallback<TUniqueNodeId>): PNodeState; inline
Parameters
ACallback: TNodeStateCallback<TUniqueNodeId>
Returns
Undefined(TNodeStateCallback<TUniqueNodeId>)
If the TNode's files are corrupted or some essential constructs are missing the provided callback is called with a TUniqueNodeId as argument.
function Undefined(const ACallback: TNodeStateCallback<TUniqueNodeId>): PNodeState; inline
Parameters
ACallback: TNodeStateCallback<TUniqueNodeId>