iceoryx_posh 2.0.3
|
The UntypedClientImpl class implements the untyped client API. More...
#include <iceoryx_posh/internal/popo/untyped_client_impl.hpp>
Public Member Functions | |
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. More... | |
void | releaseRequest (void *const requestPayload) noexcept |
Releases the ownership of the request chunk provided by the payload pointer. More... | |
cxx::expected< ClientSendError > | send (void *const requestPayload) noexcept |
Sends the provided memory chunk as request to the server. More... | |
cxx::expected< const void *, ChunkReceiveResult > | take () noexcept |
Take the response chunk from the top of the receive queue. More... | |
void | releaseResponse (const void *const responsePayload) noexcept |
Releases the ownership of the response chunk provided by the payload pointer. More... | |
![]() | |
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. More... | |
const capro::ServiceDescription & | getServiceDescription () 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. | |
Additional Inherited Members | |
![]() | |
using | SelfType = BaseClient< PortT, TriggerHandleT > |
using | PortType = PortT |
![]() | |
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 | |
![]() | |
PortT | m_port |
TriggerHandleT | m_trigger |
The UntypedClientImpl class implements the untyped client API.
UntypedClient
instead!
|
noexcept |
Get a request chunk from loaned shared memory.
payloadSize | The expected payload size of the chunk. |
payloadAlignment | The expected payload alignment of the chunk. |
|
noexcept |
Releases the ownership of the request chunk provided by the payload pointer.
requestPayload | pointer to the payload of the chunk to be released |
The requestPayload pointer must have been previously provided by loan
and not have been already released. The chunk must not be accessed afterwards as its memory may have been reclaimed.
|
noexcept |
Releases the ownership of the response chunk provided by the payload pointer.
responsePayload | pointer to the payload of the chunk to be released |
The responsePayload pointer must have been previously provided by take
and not have been already released. The chunk must not be accessed afterwards as its memory may have been reclaimed.
|
noexcept |
Sends the provided memory chunk as request to the server.
requestPayload | Pointer to the payload of the allocated shared memory chunk. |
|
noexcept |
Take the response chunk from the top of the receive queue.
No automatic cleanup of the associated chunk is performed and must be manually done by calling releaseResponse