Skip to content

Neslib.Iceoryx2.Types

Classes & Records

Name Description
TAliveNodeView Contains all details of a TNode that is alive.
TAttributeSet Represents all service attributes. They can be set when the service is created.
TAttributeSetView Represents all service attributes. They can be set when the service is created.
TAttributeSpecifier Represents the set of attributes that are defined when the service is created.
TAttributeVerifier Represents the set of attributes that are required when the service is opened.
TAttributeView Represents a single view service attribute (key-value) pair that can be defined when the service is being created.
TBackpressureInfo The info passed to the TBackpressureHandler
TCleanupState Returned by TNode.TryCleanupDeadNodes. Contains the cleanup report of the call and contains the number of dead nodes that were successfully cleaned up and how many could not be cleaned up. This does not have to be an error, for instance when the current process does not have the permission to access the corresponding resources.
TConfig Represents the configuration that iceoryx2 will utilize. It is divided into two sections: * [Global] settings, which must align with the iceoryx2 instance the application intends to join * [Defaults] for communication within that iceoryx2 instance. The user has the flexibility to override both sections.
TConfig.TBlackboard Default settings for the blackboard messaging pattern. These settings are used unless the user specifies custom QoS or port settings.
TConfig.TDefaults Default settings. These values are used when the user in the code does not specify anything else.
TConfig.TEvent Default settings for the event messaging pattern. These settings are used unless the user specifies custom QoS or port settings.
TConfig.TGlobal The global settings
TConfig.TNode All configurable settings of a TNode.
TConfig.TPublishSubscribe Default settings for the publish-subscribe messaging pattern. These settings are used unless the user specifies custom QoS or port settings.
TConfig.TRequestResponse Default settings for the request response messaging pattern. These settings are used unless the user specifies custom QoS or port settings.
TConfig.TService All configurable settings of a TService.
TConfigView Non-owning view of a TConfig.
TDeadNodeView Contains all details of a TNode that is dead.
TDegradationInfo The degradation info passed to the TDegradationHandler
TDuration A duration with nanosecond precision
TMessageTypeDetails Contains all type information to the header and payload type.
TNodeDetails Contains details of a TNode.
TNodeName Represent the name for a TNode.
TNodeNameView Non-owning view of an TNodeName.
TNodeState Describes the state of a TNode.
TPortName Represent the name for a port.
TPortNameView Non-owning view of an TPortName.
TRawId The raw version of a unique port id
TServiceHash Represents the hash of a TService.
TServiceName Represent the name for a service.
TServiceNameView Non-owning view of an TServiceName.
TTypeDetail Contains all type details required to connect to a service.
TUniqueNodeId The system-wide unique id of a [Node]

Types

Name Description
PNodeState
TAllocationStrategy Describes generically an allocation strategy, meaning how the memory is increased when the available memory is insufficient.
TAttributeDefinitionError Failures that can occur when defining attributes with TAttributeSpecifier.Define/DefineUtf8.
TAttributeVerificationError Failures that can occur when the TAttributeVerifier fails the verification.
TBackpressureAction Defines the action that shall be take when data cannot be delivered.
TBackpressureHandler The backpressure handler invoked when a sample could not be delivered
TBackpressureStrategy Defines the strategy a sender shall pursue when the buffer of the receiver is full and the service does not overflow.
TCallback<T> A generic callback function.
TCallbackProgression Determines how to process from a wait or enumeration callback.
TConfigCreationError Failures occurring while creating a new TConfig object with TConfig.FromFile.
TConnectionFailure Describes the errors that can occur when a connection between two endpoints (ports) is established
TDegradationAction Defines the action that shall be taken when an degradation is detected. This can happen when data cannot be delivered, or when the system is corrupted and files are modified by non-iceoryx2 instances. Is used as return value of the TDegradationHandler to define a custom behavior.
TDegradationCause Defines the cause of a degradation and is a parameter of the TDegradationHandler.
TDegradationHandler The degradation handler invoked when a degradation is detected
TLoanError Defines a failure that can occur in TPublisher.Loan/LoanUnit.
TNodeCleanupFailure Failures of TDeadNodeView.TryRemoveStaleResources that occur when the stale resources of a dead TNode are removed.
TNodeListFailure All failures that can occur in TNode.List.
TNodeStateCallback<T> Callback method used by TNodeState
TOverridePreallocationCallback The callback for TPortFactoryPublisher.OverridePreallocatedCallback.
TRawIdType The raw version of a unique port id
TReceiveError Defines the failure that can occur when receiving data with TSubscriber.Receive.
TSemanticStringError Defines errors which can occur when modifying or creating a semantic string
TSendError Failure that can be emitted when data is sent.
TServiceType Type of service
TTypeVariant Defines if the type is a slice with a runtime-size (Dynamic) or if its a type that satisfies sized (FixedSize).
TUniqueIdGeneratorDetailsError