iox::popo::Client< Req, Res > Class Template Reference

The Client class for the request-response messaging pattern in iceoryx. More...

#include <iceoryx_posh/popo/client.hpp>

Inheritance diagram for iox::popo::Client< Req, Res >:

Collaboration diagram for iox::popo::Client< Req, Res >:

Additional Inherited Members
Public Member Functions inherited from iox::popo::ClientImpl< Req, Res, BaseClientT >
	ClientImpl (const capro::ServiceDescription &service, const ClientOptions &clientOptions={}) noexcept
	Constructor for a client.
	ClientImpl (const ClientImpl &)=delete
	ClientImpl (ClientImpl &&)=delete
ClientImpl &	operator= (const ClientImpl &)=delete
ClientImpl &	operator= (ClientImpl &&)=delete
template<typename... Args>
cxx::expected< Request< Req >, AllocationError >	loan (Args &&... args) noexcept
	Get a Request from loaned shared memory and construct the data with the given arguments.
cxx::expected< ClientSendError >	send (Request< Req > &&request) noexcept override
	Sends the given Request and then releases its loan.
cxx::expected< Response< const Res >, ChunkReceiveResult >	take () noexcept
	Take the Response from the top of the receive queue.
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

Detailed Description

template<typename Req, typename Res>
class iox::popo::Client< Req, Res >

The Client class for the request-response messaging pattern in iceoryx.

Parameters

[in]	Req	type of request data
[in]	Res	type of response data

---

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

• iceoryx_posh/popo/client.hpp