iox::popo::BasePublisher🔗

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

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

Inherited by iox::popo::PublisherImpl< T, mepoo::NoUserHeader >, iox::popo::PublisherImpl< T, H, BasePublisherType >, iox::popo::UntypedPublisherImpl< BasePublisherType >

Public Types🔗

	Name
using port_t	PortType

Public Functions🔗

	Name
	BasePublisher(const BasePublisher & other)
BasePublisher &	operator=(const BasePublisher & )
	BasePublisher(BasePublisher && rhs)
BasePublisher &	operator=(BasePublisher && rhs)
virtual	~BasePublisher()
uid_t	getUid() const uid Get the UID of the publisher.
capro::ServiceDescription	getServiceDescription() const getServiceDescription Get the service description of the publisher.
void	offer() offer Offer the service to be subscribed to.
void	stopOffer() stopOffer Stop offering the service.
bool	isOffered() const isOffered
bool	hasSubscribers() const hasSubscribers

Protected Functions🔗

	Name
	BasePublisher() =default
	BasePublisher(const capro::ServiceDescription & service, const PublisherOptions & publisherOptions)
const port_t &	port() const port
port_t &	port() port

Protected Attributes🔗

	Name
port_t	m_port

Detailed Description🔗

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

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

Note: Not intended for public usage! Use the [Publisher](/v2.0.1/API-reference/posh/Classes/classiox_1_1popo_1_1Publisher/) or [UntypedPublisher](/v2.0.1/API-reference/posh/Classes/classiox_1_1popo_1_1UntypedPublisher/) instead!

Public Types Documentation🔗

using PortType🔗

using iox::popo::BasePublisher< port_t >::PortType =  port_t;

Public Functions Documentation🔗

function BasePublisher🔗

BasePublisher(
    const BasePublisher & other
)

function operator=🔗

BasePublisher & operator=(
    const BasePublisher & 
)

function BasePublisher🔗

BasePublisher(
    BasePublisher && rhs
)

function operator=🔗

BasePublisher & operator=(
    BasePublisher && rhs
)

function ~BasePublisher🔗

virtual ~BasePublisher()

function getUid🔗

uid_t getUid() const

uid Get the UID of the publisher.

Return: The publisher's UID.

function getServiceDescription🔗

capro::ServiceDescription getServiceDescription() const

getServiceDescription Get the service description of the publisher.

Return: The service description.

function offer🔗

void offer()

offer Offer the service to be subscribed to.

function stopOffer🔗

void stopOffer()

stopOffer Stop offering the service.

function isOffered🔗

bool isOffered() const

isOffered

Return: True if service is currently being offered.

function hasSubscribers🔗

bool hasSubscribers() const

hasSubscribers

Return: True if currently has subscribers to the service.

Protected Functions Documentation🔗

function BasePublisher🔗

BasePublisher() =default

function BasePublisher🔗

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

function port🔗

const port_t & port() const

port

Return: const accessor of the underlying port

function port🔗

port_t & port()

port

Return: accessor of the underlying port

Protected Attributes Documentation🔗

variable m_port🔗

port_t m_port {nullptr};

Updated on 2 April 2022 at 16:37:47 CEST