Skip to content

Neslib.Iceoryx2.Blackboard

Classes & Records

Name Description
TBlackboardValue<TValue> A wrapper for the value returned by TEntryHandle.Get.
TDynamicConfigBlackboard The dynamic configuration of a TMessagingPattern.Blackboard based service. Contains dynamic parameters like the connected endpoints etc.
TEntryHandle<TKey, TValue> A handle for direct read access to a specific blackboard value.
TEntryHandleMut<TKey, TValue> A handle for direct write access to a specific blackboard value.
TEntryValueUninit<TKey, TValue> Wrapper around an uninitialized entry value that can be used for a zero-copy update.
TEntryValueUninit<TKey, TValue>.PValue
TPortFactoryBlackboard<TKey> Represents the port factory of a service with TMessagingPattern.Blackboard.
TPortFactoryReader<TKey> Factory to create a new reader port/endpoint for TMessagingPattern.Blackboard based communication.
TPortFactoryWriter<TKey> Factory to create a new writer port/endpoint for TMessagingPattern.Blackboard based communication.
TReader<TKey> Reading endpoint of a blackboard based communication.
TReaderDetailsView Contains the communication settings of the connected TReader.
TServiceBuilderBlackboardCreator<TKey> Builder to create new TMessagingPattern.Blackboard based services that create a blackboard.
TServiceBuilderBlackboardOpener<TKey> Builder to create new TMessagingPattern.Blackboard based services that open a blackboard.
TStaticConfigBlackboard The static configuration of an TMessagingPattern.Blackboard based service. Contains all parameters that do not change during the lifetime of a service.
TUniqueReaderId The system-wide unique id of a TReader.
TUniqueWriterId The system-wide unique id of a TWriter.
TWriter<TKey> Producing endpoint of a blackboard based communication.
TWriterDetailsView Contains the communication settings of the connected TWriter.

Types

Name Description
TBlackboardCreateError Errors that can occur when a new TMessagingPattern.Blackboard service shall be created.
TBlackboardOpenError Errors that can occur when an existing TMessagingPattern.Blackboard service shall be opened.
TEntryHandleError Defines a failure that can occur when a TEntryHandle is created with TReader.Entry.
TEntryHandleMutError Defines a failure that can occur when a TEntryHandleMut is created with TWriter.Entry.
TKeyEqualityFunc<TKey> A callback function that checks 2 blackboard keys for equality. Passed to TServiceBuilder.BlackboardCreator
TReaderCreateError Defines a failure that can occur when a TReader is created with TPortFactoryReader.
TWriterCreateError Defines a failure that can occur when a writer is created with TPortFactoryWriter.