Inheritance diagram for iox::popo::UntypedClient:

[legend]

Collaboration diagram for iox::popo::UntypedClient:

[legend]

Additional Inherited Members
Public Member Functions inherited from iox::popo::UntypedClientImpl< BaseClientT >
	UntypedClientImpl (const capro::ServiceDescription &service, const ClientOptions &clientOptions={}) noexcept

	UntypedClientImpl (const UntypedClientImpl &)=delete

	UntypedClientImpl (UntypedClientImpl &&)=delete

UntypedClientImpl &	operator= (const UntypedClientImpl &)=delete

UntypedClientImpl &	operator= (UntypedClientImpl &&)=delete

cxx::expected< void *, AllocationError >	loan (const uint32_t payloadSize, const uint32_t payloadAlignment) noexcept
	Get a request chunk from loaned shared memory.

void	releaseRequest (void *const requestPayload) noexcept
	Releases the ownership of the request chunk provided by the payload pointer.

cxx::expected< ClientSendError >	send (void *const requestPayload) noexcept
	Sends the provided memory chunk as request to the server.

cxx::expected< const void *, ChunkReceiveResult >	take () noexcept
	Take the response chunk from the top of the receive queue.

void	releaseResponse (const void *const responsePayload) noexcept
	Releases the ownership of the response chunk provided by the payload pointer.

Public Member Functions inherited from iox::popo::BaseClient< PortT, TriggerHandleT >
	BaseClient (const BaseClient &other)=delete

BaseClient &	operator= (const BaseClient &)=delete

	BaseClient (BaseClient &&rhs)=delete

BaseClient &	operator= (BaseClient &&rhs)=delete

uid_t	getUid () const noexcept
	Get the unique ID of the client.

const capro::ServiceDescription &	getServiceDescription () const noexcept
	Get the service description of the client.

void	connect () noexcept
	Initiate connection to server when not already connected, otherwise nothing.

ConnectionState	getConnectionState () const noexcept
	Get current connection state.

void	disconnect () noexcept
	Disconnects when already connected, otherwise nothing.

bool	hasResponses () const noexcept
	Check if response are available.

bool	hasMissedResponses () noexcept
	Check if response has been missed since the last call of this method.

void	releaseQueuedResponses () noexcept
	Releases any unread queued response.

Protected Types inherited from iox::popo::BaseClient< PortT, TriggerHandleT >
using	SelfType = BaseClient< PortT, TriggerHandleT >

using	PortType = PortT

Protected Member Functions inherited from iox::popo::BaseClient< PortT, TriggerHandleT >
	BaseClient (const capro::ServiceDescription &service, const ClientOptions &clientOptions) noexcept

void	invalidateTrigger (const uint64_t uniqueTriggerId) noexcept
	Only usable by the WaitSet/Listener, not for public use. Invalidates the internal triggerHandle.

void	enableState (TriggerHandleT &&triggerHandle, const ClientState clientState) noexcept
	Only usable by the WaitSet/Listener, not for public use. Attaches the triggerHandle to the internal trigger.

WaitSetIsConditionSatisfiedCallback	getCallbackForIsStateConditionSatisfied (const ClientState clientState) const noexcept
	Only usable by the WaitSet/Listener, not for public use. Returns method pointer to the event corresponding hasTriggered method callback.

void	disableState (const ClientState clientState) noexcept
	Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle.

void	enableEvent (TriggerHandleT &&triggerHandle, const ClientEvent clientEvent) noexcept
	Only usable by the WaitSet/Listener, not for public use. Attaches the triggerHandle to the internal trigger.

void	disableEvent (const ClientEvent clientEvent) noexcept
	Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle.

const PortT &	port () const noexcept
	const accessor of the underlying port

PortT &	port () noexcept
	accessor of the underlying port

Protected Attributes inherited from iox::popo::BaseClient< PortT, TriggerHandleT >
PortT	m_port

TriggerHandleT	m_trigger

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

iceoryx_posh/popo/untyped_client.hpp

Additional Inherited Members