iceoryx_posh 2.0.3
List of all members
iox::popo::Server< Req, Res > Class Template Reference

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

#include <iceoryx_posh/popo/server.hpp>

Inheritance diagram for iox::popo::Server< Req, Res >:
Inheritance graph
[legend]
Collaboration diagram for iox::popo::Server< Req, Res >:
Collaboration graph
[legend]

Additional Inherited Members

- Public Member Functions inherited from iox::popo::ServerImpl< Req, Res, BaseServerT >
 ServerImpl (const capro::ServiceDescription &service, const ServerOptions &serverOptions={}) noexcept
 Constructor for a sserver. More...
 
 ServerImpl (const ServerImpl &)=delete
 
 ServerImpl (ServerImpl &&)=delete
 
ServerImploperator= (const ServerImpl &)=delete
 
ServerImploperator= (ServerImpl &&)=delete
 
cxx::expected< Request< const Req >, ServerRequestResult > take () noexcept
 Take the Request from the top of the receive queue. More...
 
template<typename... Args>
cxx::expected< Response< Res >, AllocationError > loan (const Request< const Req > &request, Args &&... args) noexcept
 Get a Response from loaned shared memory and construct the data with the given arguments. More...
 
cxx::expected< ServerSendError > send (Response< Res > &&response) noexcept override
 Sends the given Response and then releases its loan. More...
 
- Public Member Functions inherited from iox::popo::BaseServer< PortT, TriggerHandleT >
 BaseServer (const BaseServer &other)=delete
 
BaseServeroperator= (const BaseServer &)=delete
 
 BaseServer (BaseServer &&rhs)=delete
 
BaseServeroperator= (BaseServer &&rhs)=delete
 
uid_t getUid () const noexcept
 Get the UID of the server. More...
 
const capro::ServiceDescriptiongetServiceDescription () const noexcept
 Get the service description of the server. More...
 
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. More...
 
bool hasClients () const noexcept
 Check if the server has clients. More...
 
bool hasRequests () const noexcept
 Check if requests are available. More...
 
bool hasMissedRequests () noexcept
 Check if requests has been missed since the last call of this method. More...
 
void releaseQueuedRequests () noexcept
 Releases any unread queued requests.
 
- Protected Types inherited from iox::popo::BaseServer< PortT, TriggerHandleT >
using SelfType = BaseServer< PortT, TriggerHandleT >
 
using PortType = PortT
 
- Protected Member Functions inherited from iox::popo::BaseServer< PortT, TriggerHandleT >
 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. More...
 
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. More...
 
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. More...
 
void disableState (const ServerState serverState) noexcept
 Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle. More...
 
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. More...
 
void disableEvent (const ServerEvent serverEvent) noexcept
 Only usable by the WaitSet/Listener, not for public use. Resets the internal triggerHandle. More...
 
const PortT & port () const noexcept
 port More...
 
PortT & port () noexcept
 port More...
 
- Protected Attributes inherited from iox::popo::BaseServer< PortT, TriggerHandleT >
PortT m_port
 
TriggerHandleT m_trigger
 

Detailed Description

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

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

Parameters
[in]Reqtype of request data
[in]Restype of response data

The documentation for this class was generated from the following file: