iceoryx_posh 2.0.5
|
The BaseClient class contains the common implementation for the different clients. More...
#include <iceoryx_posh/internal/popo/base_client.hpp>
Public Member Functions | |
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 | |
using | SelfType = BaseClient< PortT, TriggerHandleT > |
using | PortType = PortT |
Protected Member Functions | |
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 | |
PortT | m_port |
TriggerHandleT | m_trigger |
Friends | |
class | NotificationAttorney |
The BaseClient class contains the common implementation for the different clients.
[in] | PortT | type of the underlying port, required for testing |
[in] | TriggerHandleT | type of the underlying trigger handle, required for testing |
Client
or UntypedClient
instead!
|
protectednoexcept |
Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle.
[in] | clientEvent | the event which should be detached |
|
protectednoexcept |
Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle.
[in] | clientState | the state which should be detached |
|
protectednoexcept |
Only usable by the WaitSet/Listener, not for public use. Attaches the triggerHandle to the internal trigger.
[in] | triggerHandle | rvalue reference to the triggerHandle. This class takes the ownership of that handle. |
[in] | clientEvent | the event which should be attached |
|
protectednoexcept |
Only usable by the WaitSet/Listener, not for public use. Attaches the triggerHandle to the internal trigger.
[in] | triggerHandle | rvalue reference to the triggerHandle. This class takes the ownership of that handle. |
[in] | clientState | the state which should be attached |
|
protectednoexcept |
Only usable by the WaitSet/Listener, not for public use. Returns method pointer to the event corresponding hasTriggered method callback.
[in] | clientState | the state to which the hasTriggeredCallback is required |
|
noexcept |
Get current connection state.
|
noexcept |
Get the service description of the client.
|
noexcept |
Get the unique ID of the client.
|
noexcept |
Check if response has been missed since the last call of this method.
Response may be missed due to overflowing receive queue.
|
noexcept |
Check if response are available.
|
protectednoexcept |
Only usable by the WaitSet/Listener, not for public use. Invalidates the internal triggerHandle.
[in] | uniqueTriggerId | the id of the corresponding trigger |