iceoryx_posh 2.0.5
|
The BaseServer class contains the common implementation for the different server. More...
#include <iceoryx_posh/internal/popo/base_server.hpp>
Public Member Functions | |
BaseServer (const BaseServer &other)=delete | |
BaseServer & | operator= (const BaseServer &)=delete |
BaseServer (BaseServer &&rhs)=delete | |
BaseServer & | operator= (BaseServer &&rhs)=delete |
uid_t | getUid () const noexcept |
Get the UID of the server. | |
const capro::ServiceDescription & | getServiceDescription () const noexcept |
Get the service description of the server. | |
void | offer () noexcept |
Offer the service to be connected to when not already offering, otherwise nothing. | |
void | stopOffer () noexcept |
Stop offering the service when already offering, otherwise nothing. | |
bool | isOffered () const noexcept |
Check if the server is offering. | |
bool | hasClients () const noexcept |
Check if the server has clients. | |
bool | hasRequests () const noexcept |
Check if requests are available. | |
bool | hasMissedRequests () noexcept |
Check if requests has been missed since the last call of this method. | |
void | releaseQueuedRequests () noexcept |
Releases any unread queued requests. | |
Protected Types | |
using | SelfType = BaseServer< PortT, TriggerHandleT > |
using | PortType = PortT |
Protected Member Functions | |
BaseServer (const capro::ServiceDescription &service, const ServerOptions &serverOptions) 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 ServerState serverState) noexcept |
Only usable by the WaitSet/Listener, not for public use. Attaches the triggerHandle to the internal trigger. | |
WaitSetIsConditionSatisfiedCallback | getCallbackForIsStateConditionSatisfied (const ServerState serverState) 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 ServerState serverState) noexcept |
Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle. | |
void | enableEvent (TriggerHandleT &&triggerHandle, const ServerEvent serverEvent) noexcept |
Only usable by the WaitSet/Listener, not for public use. Attaches the triggerHandle to the internal trigger. | |
void | disableEvent (const ServerEvent serverEvent) noexcept |
Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle. | |
const PortT & | port () const noexcept |
port | |
PortT & | port () noexcept |
port | |
Protected Attributes | |
PortT | m_port |
TriggerHandleT | m_trigger |
Friends | |
class | NotificationAttorney |
The BaseServer class contains the common implementation for the different server.
[in] | PortT | type of the underlying port, required for testing specializations. |
[in] | TriggerHandleT | type of the underlying trigger handle, required for testing |
Server
or UntypedServer
instead!
|
protectednoexcept |
Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle.
[in] | serverEvent | the event which should be detached |
|
protectednoexcept |
Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle.
[in] | serverState | 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] | serverEvent | 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] | serverState | 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] | serverState | the state to which the hasTriggeredCallback is required |
|
noexcept |
Get the service description of the server.
|
noexcept |
Get the UID of the server.
|
noexcept |
Check if the server has clients.
|
noexcept |
Check if requests has been missed since the last call of this method.
Requests may be missed due to overflowing receive queue.
|
noexcept |
Check if requests 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 |
|
noexcept |
Check if the server is offering.
|
protectednoexcept |
port
|
protectednoexcept |
port