iox::popo::UntypedSubscriber🔗
The UntypedSubscriber class for the publish-subscribe messaging pattern in iceoryx.
#include <iceoryx_posh/popo/untyped_subscriber.hpp>
Inherits from iox::popo::UntypedSubscriberImpl<>, iox::popo::BaseSubscriber<>
Public Functions🔗
Name | |
---|---|
virtual | ~UntypedSubscriber() |
Additional inherited members🔗
Public Types inherited from iox::popo::UntypedSubscriberImpl<>
Name | |
---|---|
using BaseSubscriberType | BaseSubscriber |
using UntypedSubscriberImpl< BaseSubscriberType > | SelfType |
Public Functions inherited from iox::popo::UntypedSubscriberImpl<>
Name | |
---|---|
UntypedSubscriberImpl(const capro::ServiceDescription & service, const SubscriberOptions & subscriberOptions =SubscriberOptions()) | |
UntypedSubscriberImpl(const UntypedSubscriberImpl & other) | |
UntypedSubscriberImpl & | operator=(const UntypedSubscriberImpl & ) |
UntypedSubscriberImpl(UntypedSubscriberImpl && rhs) | |
UntypedSubscriberImpl & | operator=(UntypedSubscriberImpl && rhs) |
virtual | ~UntypedSubscriberImpl() |
cxx::expected< const void *, ChunkReceiveResult > | take() Take the chunk from the top of the receive queue. |
void | release(const void *const userPayload) Releases the ownership of the chunk provided by the user-payload pointer. |
Protected Types inherited from iox::popo::BaseSubscriber<>
Name | |
---|---|
using BaseSubscriber< port_t > | SelfType Only usable by the WaitSet, not for public use. Invalidates the internal triggerHandle. |
using port_t | PortType |
Public Functions inherited from iox::popo::BaseSubscriber<>
Name | |
---|---|
virtual | ~BaseSubscriber() |
uid_t | getUid() const uid Get the unique ID of the subscriber. |
capro::ServiceDescription | getServiceDescription() const getServiceDescription Get the service description of the subscriber. |
void | subscribe() subscribe Initiate subscription. |
SubscribeState | getSubscriptionState() const getSubscriptionState Get current subscription state. |
void | unsubscribe() unsubscribe Unsubscribes if currently subscribed, otherwise do nothing. |
bool | hasData() const Check if data is available. |
bool | hasMissedData() Check if data has been missed since the last call of this method. |
void | releaseQueuedData() Releases any unread queued data. |
Protected Functions inherited from iox::popo::BaseSubscriber<>
Name | |
---|---|
BaseSubscriber() | |
BaseSubscriber(const capro::ServiceDescription & service, const SubscriberOptions & subscriberOptions) | |
BaseSubscriber(const BaseSubscriber & other) | |
BaseSubscriber & | operator=(const BaseSubscriber & ) |
BaseSubscriber(BaseSubscriber && rhs) | |
BaseSubscriber & | operator=(BaseSubscriber && rhs) |
cxx::expected< const mepoo::ChunkHeader *, ChunkReceiveResult > | takeChunk() small helper method to unwrap the expected<optional<ChunkHeader*>> from the tryGetChunk method of the port |
void | invalidateTrigger(const uint64_t trigger) |
void | enableState(iox::popo::TriggerHandle && triggerHandle, const SubscriberState subscriberState) Only usable by the WaitSet, not for public use. Attaches the triggerHandle to the internal trigger. |
WaitSetIsConditionSatisfiedCallback | getCallbackForIsStateConditionSatisfied(const SubscriberState subscriberState) const Only usable by the WaitSet, not for public use. Returns method pointer to the event corresponding hasTriggered method callback. |
void | disableState(const SubscriberState subscriberState) Only usable by the WaitSet, not for public use. Resets the internal triggerHandle. |
void | enableEvent(iox::popo::TriggerHandle && triggerHandle, const SubscriberEvent subscriberState) Only usable by the WaitSet, not for public use. Attaches the triggerHandle to the internal trigger. |
void | disableEvent(const SubscriberEvent subscriberEvent) Only usable by the WaitSet, not for public use. Resets the internal triggerHandle. |
const port_t & | port() const const accessor of the underlying port |
port_t & | port() accessor of the underlying port |
Protected Attributes inherited from iox::popo::BaseSubscriber<>
Name | |
---|---|
port_t | m_port |
TriggerHandle | m_trigger |
Friends inherited from iox::popo::BaseSubscriber<>
Name | |
---|---|
class | NotificationAttorney |
class | iox::runtime::ServiceDiscovery |
Public Functions Documentation🔗
function ~UntypedSubscriber🔗
inline virtual ~UntypedSubscriber()
Updated on 18 December 2023 at 13:11:43 CET