The UntypedPublisher class for the publish-subscribe messaging pattern in iceoryx. More...
#include <iceoryx_posh/popo/untyped_publisher.hpp>
Inheritance diagram for iox::popo::UntypedPublisher:
Collaboration diagram for iox::popo::UntypedPublisher:
Additional Inherited Members | |
 Public Types inherited from iox::popo::BasePublisher< port_t > | |
| using | PortType = port_t |
| Public Member Functions inherited from iox::popo::UntypedPublisherImpl< BasePublisherType > | |
| UntypedPublisherImpl (const capro::ServiceDescription &service, const PublisherOptions &publisherOptions=PublisherOptions()) | |
| UntypedPublisherImpl (const UntypedPublisherImpl &other)=delete | |
| UntypedPublisherImpl & | operator= (const UntypedPublisherImpl &)=delete |
| UntypedPublisherImpl (UntypedPublisherImpl &&rhs)=delete | |
| UntypedPublisherImpl & | operator= (UntypedPublisherImpl &&rhs)=delete |
| cxx::expected< void *, AllocationError > | loan (const uint32_t userPayloadSize, const uint32_t userPayloadAlignment=iox::CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT, const uint32_t userHeaderSize=iox::CHUNK_NO_USER_HEADER_SIZE, const uint32_t userHeaderAlignment=iox::CHUNK_NO_USER_HEADER_ALIGNMENT) noexcept |
| Get a chunk from loaned shared memory. | |
| void | publish (void *const userPayload) noexcept |
| Publish the provided memory chunk. | |
| void | release (void *const userPayload) noexcept |
| Releases the ownership of the chunk provided by the user-payload pointer. | |
| Public Member Functions inherited from iox::popo::BasePublisher< port_t > | |
| BasePublisher (const BasePublisher &other)=delete | |
| BasePublisher & | operator= (const BasePublisher &)=delete |
| BasePublisher (BasePublisher &&rhs)=delete | |
| BasePublisher & | operator= (BasePublisher &&rhs)=delete |
| uid_t | getUid () const noexcept |
| uid Get the UID of the publisher. | |
| capro::ServiceDescription | getServiceDescription () const noexcept |
| getServiceDescription Get the service description of the publisher. | |
| void | offer () noexcept |
| offer Offer the service to be subscribed to. | |
| void | stopOffer () noexcept |
| stopOffer Stop offering the service. | |
| bool | isOffered () const noexcept |
| isOffered | |
| bool | hasSubscribers () const noexcept |
| hasSubscribers | |
| Protected Member Functions inherited from iox::popo::BasePublisher< port_t > | |
| BasePublisher (const capro::ServiceDescription &service, const PublisherOptions &publisherOptions) | |
| const port_t & | port () const noexcept |
| port | |
| port_t & | port () noexcept |
| port | |
| Protected Attributes inherited from iox::popo::BasePublisher< port_t > | |
| port_t | m_port {nullptr} |
Detailed Description
The UntypedPublisher class for the publish-subscribe messaging pattern in iceoryx.
The documentation for this class was generated from the following file:
- iceoryx_posh/popo/untyped_publisher.hpp
