iceoryx_posh 2.0.3
List of all members
iox::popo::UntypedPublisher Class Reference

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:
Inheritance graph
[legend]
Collaboration diagram for iox::popo::UntypedPublisher:
Collaboration graph
[legend]

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
 
UntypedPublisherImploperator= (const UntypedPublisherImpl &)=delete
 
 UntypedPublisherImpl (UntypedPublisherImpl &&rhs)=delete
 
UntypedPublisherImploperator= (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. More...
 
void publish (void *const userPayload) noexcept
 Publish the provided memory chunk. More...
 
void release (void *const userPayload) noexcept
 Releases the ownership of the chunk provided by the user-payload pointer. More...
 
- Public Member Functions inherited from iox::popo::BasePublisher< port_t >
 BasePublisher (const BasePublisher &other)=delete
 
BasePublisheroperator= (const BasePublisher &)=delete
 
 BasePublisher (BasePublisher &&rhs)=delete
 
BasePublisheroperator= (BasePublisher &&rhs)=delete
 
uid_t getUid () const noexcept
 uid Get the UID of the publisher. More...
 
capro::ServiceDescription getServiceDescription () const noexcept
 getServiceDescription Get the service description of the publisher. More...
 
void offer () noexcept
 offer Offer the service to be subscribed to.
 
void stopOffer () noexcept
 stopOffer Stop offering the service.
 
bool isOffered () const noexcept
 isOffered More...
 
bool hasSubscribers () const noexcept
 hasSubscribers More...
 
- 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 More...
 
port_t & port () noexcept
 port More...
 
- 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: