TUniqueNodeId
The system-wide unique id of a [Node]
Definition
Unit: Neslib.Iceoryx2.Types
Properties
| Name | Description |
|---|---|
| Handle | |
| ValueHigh | Returns the high bits of the underlying value of the TNodeId. |
| ValueLow | Returns the low bits of the underlying value of the TNodeId. |
Constructors
| Name | Description |
|---|---|
| Assign | |
| Create | |
| Finalize | |
| Initialize |
Operators
| Name | Description |
|---|---|
| Equal(TUniqueNodeId, TUniqueNodeId) | Checks two Id's for equality |
| Equal(TUniqueNodeId, Pointer) | |
| NotEqual(TUniqueNodeId, TUniqueNodeId) | Checks two Id's for inequality |
| NotEqual(TUniqueNodeId, Pointer) |
Methods
| Name | Description |
|---|---|
| CreationTime | Returns the time the TNode was created. |
| Pid | Returns the process id of the process that owns the TNode. |
| ToString | Converts id to a string for debugging purposes. |
Property Descriptions
Handle
property Handle: THandle read GetHandle
Type: THandle
ValueHigh
Returns the high bits of the underlying value of the TNodeId.
property ValueHigh: UInt64 read GetValueHigh
Type: UInt64
ValueLow
Returns the low bits of the underlying value of the TNodeId.
property ValueLow: UInt64 read GetValueLow
Type: UInt64
Constructor Descriptions
Assign
constructor Assign(var ADest: TUniqueNodeId; const ASrc: TUniqueNodeId)
Parameters
ADest: TUniqueNodeId
ASrc: TUniqueNodeId
Create
constructor Create(const AHandle: THandle); overload
Parameters
AHandle: THandle
Finalize
destructor Finalize
Initialize
constructor Initialize
Operator Descriptions
Equal(TUniqueNodeId, TUniqueNodeId)
Checks two Id's for equality
class operator Equal(const ALeft, ARight: TUniqueNodeId): Boolean; static
Parameters
ALeft: TUniqueNodeId
ARight: TUniqueNodeId
Returns
Boolean
Equal(TUniqueNodeId, Pointer)
class operator Equal(const ALeft: TUniqueNodeId; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TUniqueNodeId
ARight: Pointer
Returns
Boolean
NotEqual(TUniqueNodeId, TUniqueNodeId)
Checks two Id's for inequality
class operator NotEqual(const ALeft, ARight: TUniqueNodeId): Boolean; inline; static
Parameters
ALeft: TUniqueNodeId
ARight: TUniqueNodeId
Returns
Boolean
NotEqual(TUniqueNodeId, Pointer)
class operator NotEqual(const ALeft: TUniqueNodeId; const ARight: Pointer): Boolean; inline; static
Parameters
ALeft: TUniqueNodeId
ARight: Pointer
Returns
Boolean
Method Descriptions
CreationTime(TServiceType)
Returns the time the TNode was created.
function CreationTime(const AServiceType: TServiceType): TResult<TDateTime, TUniqueIdGeneratorDetailsError>; inline
Parameters
AServiceType: TServiceType
Returns
TResult<TDateTime, TUniqueIdGeneratorDetailsError>
Pid(TServiceType)
Returns the process id of the process that owns the TNode.
function Pid(const AServiceType: TServiceType): TResult<Int32, TUniqueIdGeneratorDetailsError>; inline
Parameters
AServiceType: TServiceType
Returns
TResult<Int32, TUniqueIdGeneratorDetailsError>
ToString
Converts id to a string for debugging purposes.
function ToString: String
Returns
String