iceoryx_posh 2.0.5
Loading...
Searching...
No Matches
List of all members
iox::popo::Publisher< T, H > Class Template Reference

The Publisher class for the publish-subscribe messaging pattern in iceoryx. More...

#include <iceoryx_posh/popo/publisher.hpp>

Inheritance diagram for iox::popo::Publisher< T, H >:
Inheritance graph
[legend]
Collaboration diagram for iox::popo::Publisher< T, H >:
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::PublisherImpl< T, H, BasePublisherType >
 PublisherImpl (const capro::ServiceDescription &service, const PublisherOptions &publisherOptions=PublisherOptions())
 
 PublisherImpl (const PublisherImpl &other)=delete
 
PublisherImploperator= (const PublisherImpl &)=delete
 
 PublisherImpl (PublisherImpl &&rhs)=delete
 
PublisherImploperator= (PublisherImpl &&rhs)=delete
 
template<typename... Args>
cxx::expected< Sample< T, H >, AllocationErrorloan (Args &&... args) noexcept
 loan Get a sample from loaned shared memory and consctruct the data with the given arguments.
 
void publish (Sample< T, H > &&sample) noexcept override
 publish Publishes the given sample and then releases its loan.
 
cxx::expected< AllocationErrorpublishCopyOf (const T &val) noexcept
 publishCopyOf Copy the provided value into a loaned shared memory chunk and publish it.
 
template<typename Callable , typename... ArgTypes>
cxx::expected< AllocationErrorpublishResultOf (Callable c, ArgTypes... args) noexcept
 publishResultOf Loan a sample from memory, execute the provided callable to write to it, then publish it.
 
- 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.
 
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_tport () const noexcept
 port
 
port_tport () noexcept
 port
 
- Protected Attributes inherited from iox::popo::BasePublisher< port_t >
port_t m_port {nullptr}
 

Detailed Description

template<typename T, typename H = mepoo::NoUserHeader>
class iox::popo::Publisher< T, H >

The Publisher class for the publish-subscribe messaging pattern in iceoryx.

Parameters
[in]Tuser payload type
[in]Huser header type

The documentation for this class was generated from the following file: