iceoryx_doc
1.0.1
|
The SubscriberPortRouDi provides the API for accessing a subscriber port from the RouDi middleware daemon side. The subscriber port is divided in the sevaral parts like SubscriberPortData, SubscriberPortRouDi and SubscriberPortUser. The SubscriberPortRouDi provides service discovery functionality that is based on CaPro messages. With this API the dynamic connections between publisher and subscriber ports can be established. More...
#include <subscriber_port_roudi.hpp>
Public Types | |
using | MemberType_t = SubscriberPortData |
![]() | |
using | MemberType_t = BasePortData |
Public Member Functions | |
SubscriberPortRouDi (cxx::not_null< MemberType_t *const > subscriberPortDataPtr) noexcept | |
SubscriberPortRouDi (const SubscriberPortRouDi &other)=delete | |
SubscriberPortRouDi & | operator= (const SubscriberPortRouDi &)=delete |
SubscriberPortRouDi (SubscriberPortRouDi &&rhs)=default | |
SubscriberPortRouDi & | operator= (SubscriberPortRouDi &&rhs)=default |
QueueFullPolicy | getQueueFullPolicy () const noexcept |
Returns behaviour in case of a full delivery queue. More... | |
virtual cxx::optional< capro::CaproMessage > | tryGetCaProMessage () noexcept=0 |
get an optional CaPro message that requests changes to the subscription state of the subscriber More... | |
virtual cxx::optional< capro::CaproMessage > | dispatchCaProMessageAndGetPossibleResponse (const capro::CaproMessage &caProMessage) noexcept=0 |
dispatch a CaPro message to the subscriber for processing More... | |
void | releaseAllChunks () noexcept |
cleanup the subscriber and release all the chunks it currently holds Caution: Contract is that user process is no more running when cleanup is called | |
![]() | |
BasePort (MemberType_t *const basePortDataPtr) noexcept | |
BasePort (const BasePort &other)=delete | |
BasePort & | operator= (const BasePort &)=delete |
BasePort (BasePort &&) noexcept | |
BasePort & | operator= (BasePort &&) noexcept |
operator bool () const noexcept | |
a port can be constructed from a nullptr, additionally it also can be moved and in these cases the member methods would work on a nullptr. to circumvent this problem More... | |
capro::ServiceDescription | getCaProServiceDescription () const noexcept |
Reads Type of actual CaPro Port (publisher/subscriber...) More... | |
RuntimeName_t | getRuntimeName () const noexcept |
Gets name of the application's runtime for the active port. More... | |
UniquePortId | getUniqueID () const noexcept |
Gets Id of the active port. More... | |
NodeName_t | getNodeName () const noexcept |
returns node name for the active port More... | |
void | destroy () noexcept |
Indicate that this port can be destroyed. | |
bool | toBeDestroyed () const noexcept |
Checks whether port can be destroyed. More... | |
Protected Member Functions | |
const MemberType_t * | getMembers () const noexcept |
MemberType_t * | getMembers () noexcept |
![]() | |
const MemberType_t * | getMembers () const noexcept |
MemberType_t * | getMembers () noexcept |
Protected Attributes | |
ChunkReceiver< SubscriberPortData::ChunkReceiverData_t > | m_chunkReceiver |
The SubscriberPortRouDi provides the API for accessing a subscriber port from the RouDi middleware daemon side. The subscriber port is divided in the sevaral parts like SubscriberPortData, SubscriberPortRouDi and SubscriberPortUser. The SubscriberPortRouDi provides service discovery functionality that is based on CaPro messages. With this API the dynamic connections between publisher and subscriber ports can be established.
|
pure virtualnoexcept |
dispatch a CaPro message to the subscriber for processing
[in] | caProMessage | to process |
Implemented in iox::popo::SubscriberPortSingleProducer, and iox::popo::SubscriberPortMultiProducer.
|
noexcept |
Returns behaviour in case of a full delivery queue.
|
pure virtualnoexcept |
get an optional CaPro message that requests changes to the subscription state of the subscriber
Implemented in iox::popo::SubscriberPortSingleProducer, and iox::popo::SubscriberPortMultiProducer.