Skip to content

iox::popo::Server🔗

The Server class for the request-response messaging pattern in iceoryx. More...

#include <iceoryx_posh/popo/server.hpp>

Inherits from iox::popo::ServerImpl< Req, Res >, iox::popo::BaseServer<>, iox::popo::RpcInterface< Response< Res >, ServerSendError >

Public Functions🔗

Name
virtual ~Server()

Additional inherited members🔗

Public Functions inherited from iox::popo::ServerImpl< Req, Res >

Name
ServerImpl(const capro::ServiceDescription & service, const ServerOptions & serverOptions ={})
Constructor for a sserver.
virtual ~ServerImpl()
ServerImpl(const ServerImpl & )
ServerImpl(ServerImpl && )
ServerImpl & operator=(const ServerImpl & )
ServerImpl & operator=(ServerImpl && )
cxx::expected< Request< const Req >, ServerRequestResult > take()
Take the Request from the top of the receive queue.
template <typename... Args>
cxx::expected< Response< Res >, AllocationError >
loan(const Request< const Req > & request, Args &&... args)
Get a Response from loaned shared memory and construct the data with the given arguments.
cxx::expected< ServerSendError > send(Response< Res > && response) override
Sends the given Response and then releases its loan.

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

Detailed Description🔗

template <typename Req ,
typename Res >
class iox::popo::Server;

The Server class for the request-response messaging pattern in iceoryx.

Parameters:

  • Req type of request data
  • Res type of response data

Public Functions Documentation🔗

function ~Server🔗

inline virtual ~Server()

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