The UntypedSubscriberImpl class implements the untyped subscriber API.
More...
#include <iceoryx_posh/internal/popo/untyped_subscriber_impl.hpp>
|
using | SelfType = BaseSubscriber< port_t > |
| Only usable by the WaitSet, not for public use. Invalidates the internal triggerHandle. More...
|
|
using | PortType = 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. More...
|
|
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. More...
|
|
void | disableState (const SubscriberState subscriberState) noexcept |
| Only usable by the WaitSet, not for public use. Resets the internal triggerHandle. More...
|
|
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. More...
|
|
void | disableEvent (const SubscriberEvent subscriberEvent) noexcept |
| Only usable by the WaitSet, not for public use. Resets the internal triggerHandle. More...
|
|
const port_t & | port () const noexcept |
| const accessor of the underlying port
|
|
port_t & | port () noexcept |
| accessor of the underlying port
|
|
port_t | m_port {nullptr} |
|
TriggerHandle | m_trigger |
|
template<typename BaseSubscriberType = BaseSubscriber<>>
class iox::popo::UntypedSubscriberImpl< BaseSubscriberType >
The UntypedSubscriberImpl class implements the untyped subscriber API.
- Note
- Not intended for public usage! Use the
UntypedSubscriber
instead!
◆ release()
template<typename BaseSubscriberType = BaseSubscriber<>>
Releases the ownership of the chunk provided by the user-payload pointer.
- Parameters
-
userPayload | pointer to the user-payload of the chunk to be released |
The userPayload pointer must have been previously provided by take and not have been already released. The chunk must not be accessed afterwards as its memory may have been reclaimed.
◆ take()
template<typename BaseSubscriberType = BaseSubscriber<>>
Take the chunk from the top of the receive queue.
- Returns
- The user-payload pointer of the chunk taken.
No automatic cleanup of the associated chunk is performed and must be manually done by calling release
The documentation for this class was generated from the following file: