iceoryx_posh 2.0.3
List of all members
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 >:
Inheritance graph
[legend]
Collaboration diagram for iox::popo::Client< Req, Res >:
Collaboration graph
[legend]

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. More...
 
 ClientImpl (const ClientImpl &)=delete
 
 ClientImpl (ClientImpl &&)=delete
 
ClientImploperator= (const ClientImpl &)=delete
 
ClientImploperator= (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. More...
 
cxx::expected< ClientSendError > send (Request< Req > &&request) noexcept override
 Sends the given Request and then releases its loan. More...
 
cxx::expected< Response< const Res >, ChunkReceiveResult > take () noexcept
 Take the Response from the top of the receive queue. More...
 
- Public Member Functions inherited from iox::popo::BaseClient< PortT, TriggerHandleT >
 BaseClient (const BaseClient &other)=delete
 
BaseClientoperator= (const BaseClient &)=delete
 
 BaseClient (BaseClient &&rhs)=delete
 
BaseClientoperator= (BaseClient &&rhs)=delete
 
uid_t getUid () const noexcept
 Get the unique ID of the client. More...
 
const capro::ServiceDescriptiongetServiceDescription () const noexcept
 Get the service description of the client. More...
 
void connect () noexcept
 Initiate connection to server when not already connected, otherwise nothing.
 
ConnectionState getConnectionState () const noexcept
 Get current connection state. More...
 
void disconnect () noexcept
 Disconnects when already connected, otherwise nothing.
 
bool hasResponses () const noexcept
 Check if response are available. More...
 
bool hasMissedResponses () noexcept
 Check if response has been missed since the last call of this method. More...
 
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. More...
 
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. More...
 
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. More...
 
void disableState (const ClientState clientState) noexcept
 Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle. More...
 
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. More...
 
void disableEvent (const ClientEvent clientEvent) noexcept
 Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle. More...
 
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]Reqtype of request data
[in]Restype of response data

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