The UntypedSubscriber class for the publish-subscribe messaging pattern in iceoryx. More...
#include <iceoryx_posh/popo/untyped_subscriber.hpp>
Inheritance diagram for iox::popo::UntypedSubscriber:
Collaboration diagram for iox::popo::UntypedSubscriber:
Additional Inherited Members | |
 Public Types inherited from iox::popo::UntypedSubscriberImpl< BaseSubscriberType > | |
| using | BaseSubscriber = BaseSubscriberType |
| using | SelfType = UntypedSubscriberImpl< BaseSubscriberType > |
| Public Member Functions inherited from iox::popo::UntypedSubscriberImpl< BaseSubscriberType > | |
| UntypedSubscriberImpl (const capro::ServiceDescription &service, const SubscriberOptions &subscriberOptions=SubscriberOptions()) | |
| UntypedSubscriberImpl (const UntypedSubscriberImpl &other)=delete | |
| UntypedSubscriberImpl & | operator= (const UntypedSubscriberImpl &)=delete |
| UntypedSubscriberImpl (UntypedSubscriberImpl &&rhs)=delete | |
| UntypedSubscriberImpl & | operator= (UntypedSubscriberImpl &&rhs)=delete |
| cxx::expected< const void *, ChunkReceiveResult > | take () noexcept |
| Take the chunk from the top of the receive queue. | |
| void | release (const void *const userPayload) noexcept |
| Releases the ownership of the chunk provided by the user-payload pointer. | |
| Public Member Functions inherited from iox::popo::BaseSubscriber< port_t > | |
| uid_t | getUid () const noexcept |
| uid Get the unique ID of the subscriber. | |
| capro::ServiceDescription | getServiceDescription () const noexcept |
| getServiceDescription Get the service description of the subscriber. | |
| void | subscribe () noexcept |
| subscribe Initiate subscription. | |
| SubscribeState | getSubscriptionState () const noexcept |
| getSubscriptionState Get current subscription state. | |
| void | unsubscribe () noexcept |
| unsubscribe Unsubscribes if currently subscribed, otherwise do nothing. | |
| bool | hasData () const noexcept |
| Check if data is available. | |
| bool | hasMissedData () noexcept |
| Check if data has been missed since the last call of this method. | |
| void | releaseQueuedData () noexcept |
| Releases any unread queued data. | |
| Protected Types inherited from iox::popo::BaseSubscriber< port_t > | |
| using | SelfType = BaseSubscriber< port_t > |
| Only usable by the WaitSet, not for public use. Invalidates the internal triggerHandle. | |
| using | PortType = port_t |
| Protected Member Functions inherited from iox::popo::BaseSubscriber< port_t > | |
| BaseSubscriber (const capro::ServiceDescription &service, const SubscriberOptions &subscriberOptions) noexcept | |
| BaseSubscriber (const BaseSubscriber &other)=delete | |
| BaseSubscriber & | operator= (const BaseSubscriber &)=delete |
| BaseSubscriber (BaseSubscriber &&rhs)=delete | |
| BaseSubscriber & | operator= (BaseSubscriber &&rhs)=delete |
| cxx::expected< const mepoo::ChunkHeader *, ChunkReceiveResult > | takeChunk () noexcept |
small helper method to unwrap the expected<optional<ChunkHeader*>> from the tryGetChunk method of the port | |
| void | invalidateTrigger (const uint64_t trigger) noexcept |
| void | enableState (iox::popo::TriggerHandle &&triggerHandle, const SubscriberState subscriberState) noexcept |
| Only usable by the WaitSet, not for public use. Attaches the triggerHandle to the internal trigger. | |
| WaitSetIsConditionSatisfiedCallback | getCallbackForIsStateConditionSatisfied (const SubscriberState subscriberState) const noexcept |
| Only usable by the WaitSet, not for public use. Returns method pointer to the event corresponding hasTriggered method callback. | |
| void | disableState (const SubscriberState subscriberState) noexcept |
| Only usable by the WaitSet, not for public use. Resets the internal triggerHandle. | |
| void | enableEvent (iox::popo::TriggerHandle &&triggerHandle, const SubscriberEvent subscriberState) noexcept |
| Only usable by the WaitSet, not for public use. Attaches the triggerHandle to the internal trigger. | |
| void | disableEvent (const SubscriberEvent subscriberEvent) noexcept |
| Only usable by the WaitSet, not for public use. Resets the internal triggerHandle. | |
| const port_t & | port () const noexcept |
| const accessor of the underlying port | |
| port_t & | port () noexcept |
| accessor of the underlying port | |
| Protected Attributes inherited from iox::popo::BaseSubscriber< port_t > | |
| port_t | m_port {nullptr} |
| TriggerHandle | m_trigger |
Detailed Description
The UntypedSubscriber class for the publish-subscribe messaging pattern in iceoryx.
The documentation for this class was generated from the following file:
- iceoryx_posh/popo/untyped_subscriber.hpp
