base class for all types of subscriber
More...
#include <iceoryx_posh/internal/popo/base_subscriber.hpp>
|
uid_t | getUid () const noexcept |
| uid Get the unique ID of the subscriber. More...
|
|
capro::ServiceDescription | getServiceDescription () const noexcept |
| getServiceDescription Get the service description of the subscriber. More...
|
|
void | subscribe () noexcept |
| subscribe Initiate subscription. More...
|
|
SubscribeState | getSubscriptionState () const noexcept |
| getSubscriptionState Get current subscription state. More...
|
|
void | unsubscribe () noexcept |
| unsubscribe Unsubscribes if currently subscribed, otherwise do nothing.
|
|
bool | hasData () const noexcept |
| Check if data is available. More...
|
|
bool | hasMissedData () noexcept |
| Check if data has been missed since the last call of this method. More...
|
|
void | releaseQueuedData () noexcept |
| Releases any unread queued data.
|
|
|
class | NotificationAttorney |
|
class | iox::runtime::ServiceDiscovery |
|
template<typename port_t = iox::SubscriberPortUserType>
class iox::popo::BaseSubscriber< port_t >
base class for all types of subscriber
- Parameters
-
[in] | port_t | type of the underlying port, required for testing |
- Note
- Not intended for public usage! Use the
Subscriber
or UntypedSubscriber
instead!
◆ SelfType
template<typename port_t = iox::SubscriberPortUserType>
Only usable by the WaitSet, not for public use. Invalidates the internal triggerHandle.
- Parameters
-
[in] | uniqueTriggerId | the id of the corresponding trigger |
Only usable by the WaitSet, not for public use
◆ disableEvent()
template<typename port_t = iox::SubscriberPortUserType>
Only usable by the WaitSet, not for public use. Resets the internal triggerHandle.
- Parameters
-
[in] | subscriberEvent | the event which should be detached |
◆ disableState()
template<typename port_t = iox::SubscriberPortUserType>
Only usable by the WaitSet, not for public use. Resets the internal triggerHandle.
- Parameters
-
[in] | subscriberState | the state which should be detached |
◆ enableEvent()
template<typename port_t = iox::SubscriberPortUserType>
Only usable by the WaitSet, not for public use. Attaches the triggerHandle to the internal trigger.
- Parameters
-
[in] | triggerHandle | rvalue reference to the triggerHandle. This class takes the ownership of that handle. |
[in] | subscriberEvent | the event which should be attached |
◆ enableState()
template<typename port_t = iox::SubscriberPortUserType>
Only usable by the WaitSet, not for public use. Attaches the triggerHandle to the internal trigger.
- Parameters
-
[in] | triggerHandle | rvalue reference to the triggerHandle. This class takes the ownership of that handle. |
[in] | subscriberState | the state which should be attached |
◆ getCallbackForIsStateConditionSatisfied()
template<typename port_t = iox::SubscriberPortUserType>
WaitSetIsConditionSatisfiedCallback iox::popo::BaseSubscriber< port_t >::getCallbackForIsStateConditionSatisfied |
( |
const SubscriberState |
subscriberState | ) |
const |
|
protectednoexcept |
Only usable by the WaitSet, not for public use. Returns method pointer to the event corresponding hasTriggered method callback.
- Parameters
-
[in] | subscriberState | the state to which the hasTriggeredCallback is required |
◆ getServiceDescription()
template<typename port_t = iox::SubscriberPortUserType>
getServiceDescription Get the service description of the subscriber.
- Returns
- The service description.
◆ getSubscriptionState()
template<typename port_t = iox::SubscriberPortUserType>
getSubscriptionState Get current subscription state.
- Returns
- The current subscription state.
◆ getUid()
template<typename port_t = iox::SubscriberPortUserType>
uid Get the unique ID of the subscriber.
- Returns
- The subscriber's unique ID.
◆ hasData()
template<typename port_t = iox::SubscriberPortUserType>
Check if data is available.
- Returns
- True if data is available.
◆ hasMissedData()
template<typename port_t = iox::SubscriberPortUserType>
Check if data has been missed since the last call of this method.
- Returns
- True if data has been missed.
Data may be missed due to overflowing receive queue.
◆ subscribe()
template<typename port_t = iox::SubscriberPortUserType>
subscribe Initiate subscription.
- Returns
The documentation for this class was generated from the following file: