Skip to content

Neslib.Iceoryx2.PublishSubscribe

Classes & Records

Name Description
TDynamicConfigPublishSubscribe The dynamic configuration of a TMessagingPattern.PublishSubscribe based service. Contains dynamic parameters like the connected endpoints etc.
THeaderPublishSubscribe Sample header used by TMessagingPattern.PublishSubscribe.
TPortFactoryPublisher<TPayload, TUserHeader> Factory to create a new Publisher port/endpoint for TMessagingPattern.PublishSubscribe based communication.
TPortFactoryPublishSubscribe<TPayload, TUserHeader> The factory for TMessagingPattern.PublishSubscribe. It can acquire dynamic and static service information and create Publisher or Subscriber ports.
TPortFactorySubscriber<TPayload, TUserHeader> Factory to create a new subscriber port/endpoint for TMessagingPattern.PublishSubscribe based communication.
TPublisher<TPayload, TUserHeader> Sending endpoint of a publish-subscriber based communication.
TPublisher<TPayload, TUserHeader>.PPayload
TPublisherDetailsView Contains the communication settings of the connected TPublisher.
TSample<TPayload, TUserHeader> Stores the payload and is acquired by the TSubscriber whenever it receives new data from a TPublisher via TSubscriber.Receive.
TSample<TPayload, TUserHeader>.PPayload
TSample<TPayload, TUserHeader>.PUserHeader
TSampleMut<TPayload, TUserHeader> Acquired by a TPublisher * TPublisher.Loan * TPublisher.LoanUninit * TPublisher.LoanSlice * TPublisher.LoanSliceUninit
TSampleMut<TPayload, TUserHeader>.PPayload
TSampleMut<TPayload, TUserHeader>.PUserHeader
TSampleMutUninit<TPayload, TUserHeader> An uninitialized version of TSampleMut
TSampleMutUninit<TPayload, TUserHeader>.PPayload
TSampleMutUninit<TPayload, TUserHeader>.PUserHeader
TServiceBuilderPublishSubscribe<TPayload, TUserHeader> Builder to create new TMessagingPattern.PublishSubscribe based services
TStaticConfigPublishSubscribe The static configuration of a TMessagingPattern.PublishSubscribe based service. Contains all parameters that do not change during the lifetime of a service.
TSubscriber<TPayload, TUserHeader> Receiving endpoint of a publish-subscriber based communication.
TSubscriberDetailsView Contains the communication settings of the connected TSubscriber.
TUniquePublisherId The system-wide unique id of a TPublisher.
TUniqueSubscriberId The system-wide unique id of a TSubscriber.

Types

Name Description
TPublisherCreateError Defines a failure that can occur when a TPublisher is created with TPortFactoryPublisher.
TPublishSubscribeCreateError Errors that can occur when a new TMessagingPattern.PublishSubscribe service shall be created.
TPublishSubscribeOpenError Errors that can occur when an existing TMessagingPattern.PublishSubscribe service shall be opened.
TPublishSubscribeOpenOrCreateError Errors that can occur when a TMessagingPattern.PublishSubscribe service shall be created or opened.
TSubscriberCreateError Describes the failures when a new subscriber is created via the TPortFactorySubscriber.