iceoryx_posh 2.0.5
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
iox::popo::BasePublisher< port_t > Class Template Reference

The BasePublisher class contains the common implementation for the different publisher specializations. More...

#include <iceoryx_posh/internal/popo/base_publisher.hpp>

Inheritance diagram for iox::popo::BasePublisher< port_t >:
Inheritance graph
[legend]

Public Types

using PortType = port_t
 

Public Member Functions

 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

 BasePublisher (const capro::ServiceDescription &service, const PublisherOptions &publisherOptions)
 
const port_tport () const noexcept
 port
 
port_tport () noexcept
 port
 

Protected Attributes

port_t m_port {nullptr}
 

Detailed Description

template<typename port_t = iox::PublisherPortUserType>
class iox::popo::BasePublisher< port_t >

The BasePublisher class contains the common implementation for the different publisher specializations.

Note
Not intended for public usage! Use the Publisher or UntypedPublisher instead!

Member Function Documentation

◆ getServiceDescription()

template<typename port_t = iox::PublisherPortUserType>
capro::ServiceDescription iox::popo::BasePublisher< port_t >::getServiceDescription ( ) const
noexcept

getServiceDescription Get the service description of the publisher.

Returns
The service description.

◆ getUid()

template<typename port_t = iox::PublisherPortUserType>
uid_t iox::popo::BasePublisher< port_t >::getUid ( ) const
noexcept

uid Get the UID of the publisher.

Returns
The publisher's UID.

◆ hasSubscribers()

template<typename port_t = iox::PublisherPortUserType>
bool iox::popo::BasePublisher< port_t >::hasSubscribers ( ) const
noexcept

hasSubscribers

Returns
True if currently has subscribers to the service.

◆ isOffered()

template<typename port_t = iox::PublisherPortUserType>
bool iox::popo::BasePublisher< port_t >::isOffered ( ) const
noexcept

isOffered

Returns
True if service is currently being offered.

◆ port() [1/2]

template<typename port_t = iox::PublisherPortUserType>
const port_t & iox::popo::BasePublisher< port_t >::port ( ) const
protectednoexcept

port

Returns
const accessor of the underlying port

◆ port() [2/2]

template<typename port_t = iox::PublisherPortUserType>
port_t & iox::popo::BasePublisher< port_t >::port ( )
protectednoexcept

port

Returns
accessor of the underlying port

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