iox::popo::UntypedPublisher🔗

The UntypedPublisher class for the publish-subscribe messaging pattern in iceoryx. #include <iceoryx_posh/popo/untyped_publisher.hpp>

Additional inherited members🔗

Public Functions inherited from iox::popo::UntypedPublisherImpl<>

	Name
	UntypedPublisherImpl(const capro::ServiceDescription & service, const PublisherOptions & publisherOptions =PublisherOptions())
	UntypedPublisherImpl(const UntypedPublisherImpl & other)
UntypedPublisherImpl &	operator=(const UntypedPublisherImpl & )
	UntypedPublisherImpl(UntypedPublisherImpl && rhs)
UntypedPublisherImpl &	operator=(UntypedPublisherImpl && rhs)
virtual	~UntypedPublisherImpl() =default
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) Get a chunk from loaned shared memory.
void	publish(void *const userPayload) Publish the provided memory chunk.
void	release(void *const userPayload) Releases the ownership of the chunk provided by the user-payload pointer.

Public Types inherited from iox::popo::BasePublisher<>

	Name
using port_t	PortType

Public Functions inherited from iox::popo::BasePublisher<>

	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 inherited from iox::popo::BasePublisher<>

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

Protected Attributes inherited from iox::popo::BasePublisher<>

	Name
port_t	m_port

Updated on 10 February 2023 at 12:43:22 CET