Skip to content

iox::popo::UntypedServer🔗

Inherits from iox::popo::UntypedServerImpl<>, iox::popo::BaseServer<>

Public Functions🔗

Name
virtual ~UntypedServer()

Additional inherited members🔗

Public Functions inherited from iox::popo::UntypedServerImpl<>

Name
UntypedServerImpl(const capro::ServiceDescription & service, const ServerOptions & serverOptions ={})
virtual ~UntypedServerImpl()
UntypedServerImpl(const UntypedServerImpl & )
UntypedServerImpl(UntypedServerImpl && )
UntypedServerImpl & operator=(const UntypedServerImpl & )
UntypedServerImpl & operator=(UntypedServerImpl && )
cxx::expected< const void *, ServerRequestResult > take()
Take the request chunk from the top of the receive queue.
void releaseRequest(const void *const requestPayload)
Releases the ownership of the request chunk provided by the payload pointer.
cxx::expected< void *, AllocationError > loan(const RequestHeader *const requestHeader, const uint32_t payloadSize, const uint32_t payloadAlignment)
Get a response chunk from loaned shared memory.
cxx::expected< ServerSendError > send(void *const responsePayload)
Sends the provided memory chunk as response to the client.
void releaseResponse(void *const responsePayload)
Releases the ownership of the response chunk provided by the payload pointer.

Protected Types inherited from iox::popo::BaseServer<>

Name
using BaseServer< PortT, TriggerHandleT > SelfType
using PortT PortType

Public Functions inherited from iox::popo::BaseServer<>

Name
virtual ~BaseServer()
BaseServer(const BaseServer & other)
BaseServer & operator=(const BaseServer & )
BaseServer(BaseServer && rhs)
BaseServer & operator=(BaseServer && rhs)
uid_t getUid() const
Get the UID of the server.
const capro::ServiceDescription & getServiceDescription() const
Get the service description of the server.
void offer()
Offer the service to be connected to when not already offering, otherwise nothing.
void stopOffer()
Stop offering the service when already offering, otherwise nothing.
bool isOffered() const
Check if the server is offering.
bool hasClients() const
Check if the server has clients.
bool hasRequests() const
Check if requests are available.
bool hasMissedRequests()
Check if requests has been missed since the last call of this method.
void releaseQueuedRequests()
Releases any unread queued requests.

Protected Functions inherited from iox::popo::BaseServer<>

Name
BaseServer(const capro::ServiceDescription & service, const ServerOptions & serverOptions)
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 ServerState serverState)
Only usable by the WaitSet/Listener, not for public use. Attaches the triggerHandle to the internal trigger.
WaitSetIsConditionSatisfiedCallback getCallbackForIsStateConditionSatisfied(const ServerState serverState) const
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)
Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle.
void enableEvent(TriggerHandleT && triggerHandle, const ServerEvent serverEvent)
Only usable by the WaitSet/Listener, not for public use. Attaches the triggerHandle to the internal trigger.
void disableEvent(const ServerEvent serverEvent)
Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle.
const PortT & port() const
port
PortT & port()
port

Protected Attributes inherited from iox::popo::BaseServer<>

Name
PortT m_port
TriggerHandleT m_trigger

Friends inherited from iox::popo::BaseServer<>

Name
class NotificationAttorney

Public Functions Documentation🔗

function ~UntypedServer🔗

inline virtual ~UntypedServer()

Updated on 18 December 2023 at 13:11:43 CET