TDeadNodeView
Contains all details of a TNode that is dead.
Definition
Unit: Neslib.Iceoryx2.Types
Properties
| Name | Description |
|---|---|
| Details | Returns optional TNodeDetails that contains further information about the TNode. Can only be acquired when the process has the access right to read it. |
| Id | Returns the TNodeId. |
| ServiceType | The service type of the TNode. |
Methods
| Name | Description |
|---|---|
| BlockingRemoveStaleResources | Removes all stale resources of a dead TNode. If another instance is already removing the dead TNode it waits until the other instance has cleaned up the dead TNode completely. If the other cleanup instance crashes, it will take over the ownership and continue the cleanup. If the process does not have the permission to cleanup all resources it aborts with an error. |
| TryRemoveStaleResources | Removes all stale resources of the dead TNode. On error it returns a TNodeCleanupFailure. |
Property Descriptions
Details
Returns optional TNodeDetails that contains further information about the TNode. Can only be acquired when the process has the access right to read it.
property Details: Nullable<TNodeDetails> read GetDetails
Type: Nullable<TNodeDetails>
Id
Returns the TNodeId.
property Id: TUniqueNodeId read GetId
Type: TUniqueNodeId
ServiceType
The service type of the TNode.
property ServiceType: TServiceType read GetServiceType
Type: TServiceType
Method Descriptions
BlockingRemoveStaleResources(TDuration)
Removes all stale resources of a dead TNode. If another instance is already removing the dead TNode it waits until the other instance has cleaned up the dead TNode completely. If the other cleanup instance crashes, it will take over the ownership and continue the cleanup. If the process does not have the permission to cleanup all resources it aborts with an error.
If the provided timeout is expired it will return with TNodeCleanupFailure.AnotherInstanceIsCleaningUp.
function BlockingRemoveStaleResources(const ATimeout: TDuration): TResult<Void, TNodeCleanupFailure>
Parameters
ATimeout: TDuration
Returns
TResult<Void, TNodeCleanupFailure>
TryRemoveStaleResources
Removes all stale resources of the dead TNode. On error it returns a TNodeCleanupFailure.
function TryRemoveStaleResources: TResult<Void, TNodeCleanupFailure>
Returns
TResult<Void, TNodeCleanupFailure>