iox::popo::UntypedClient🔗
Inherits from iox::popo::UntypedClientImpl<>, iox::popo::BaseClient<>
Public Functions🔗
Name | |
---|---|
virtual | ~UntypedClient() |
Additional inherited members🔗
Public Functions inherited from iox::popo::UntypedClientImpl<>
Name | |
---|---|
UntypedClientImpl(const capro::ServiceDescription & service, const ClientOptions & clientOptions ={}) | |
virtual | ~UntypedClientImpl() |
UntypedClientImpl(const UntypedClientImpl & ) | |
UntypedClientImpl(UntypedClientImpl && ) | |
UntypedClientImpl & | operator=(const UntypedClientImpl & ) |
UntypedClientImpl & | operator=(UntypedClientImpl && ) |
cxx::expected< void *, AllocationError > | loan(const uint32_t payloadSize, const uint32_t payloadAlignment) Get a request chunk from loaned shared memory. |
void | releaseRequest(void *const requestPayload) Releases the ownership of the request chunk provided by the payload pointer. |
cxx::expected< ClientSendError > | send(void *const requestPayload) Sends the provided memory chunk as request to the server. |
cxx::expected< const void *, ChunkReceiveResult > | take() Take the response chunk from the top of the receive queue. |
void | releaseResponse(const void *const responsePayload) Releases the ownership of the response chunk provided by the payload pointer. |
Protected Types inherited from iox::popo::BaseClient<>
Name | |
---|---|
using BaseClient< PortT, TriggerHandleT > | SelfType |
using PortT | PortType |
Public Functions inherited from iox::popo::BaseClient<>
Name | |
---|---|
virtual | ~BaseClient() |
BaseClient(const BaseClient & other) | |
BaseClient & | operator=(const BaseClient & ) |
BaseClient(BaseClient && rhs) | |
BaseClient & | operator=(BaseClient && rhs) |
uid_t | getUid() const Get the unique ID of the client. |
const capro::ServiceDescription & | getServiceDescription() const Get the service description of the client. |
void | connect() Initiate connection to server when not already connected, otherwise nothing. |
ConnectionState | getConnectionState() const Get current connection state. |
void | disconnect() Disconnects when already connected, otherwise nothing. |
bool | hasResponses() const Check if response are available. |
bool | hasMissedResponses() Check if response has been missed since the last call of this method. |
void | releaseQueuedResponses() Releases any unread queued response. |
Protected Functions inherited from iox::popo::BaseClient<>
Name | |
---|---|
BaseClient(const capro::ServiceDescription & service, const ClientOptions & clientOptions) | |
void | invalidateTrigger(const uint64_t uniqueTriggerId) Only usable by the WaitSet/Listener, not for public use. Invalidates the internal triggerHandle. |
void | enableState(TriggerHandleT && triggerHandle, const ClientState clientState) Only usable by the WaitSet/Listener, not for public use. Attaches the triggerHandle to the internal trigger. |
WaitSetIsConditionSatisfiedCallback | getCallbackForIsStateConditionSatisfied(const ClientState clientState) const 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) Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle. |
void | enableEvent(TriggerHandleT && triggerHandle, const ClientEvent clientEvent) Only usable by the WaitSet/Listener, not for public use. Attaches the triggerHandle to the internal trigger. |
void | disableEvent(const ClientEvent clientEvent) Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle. |
const PortT & | port() const const accessor of the underlying port |
PortT & | port() accessor of the underlying port |
Protected Attributes inherited from iox::popo::BaseClient<>
Name | |
---|---|
PortT | m_port |
TriggerHandleT | m_trigger |
Friends inherited from iox::popo::BaseClient<>
Name | |
---|---|
class | NotificationAttorney |
Public Functions Documentation🔗
function ~UntypedClient🔗
inline virtual ~UntypedClient()
Updated on 2 April 2022 at 16:37:47 CEST