iox::popo::Request🔗
The Request class is a mutable abstraction over types which are written to loaned shared memory. These requests are sent to the server via the iceoryx system. More...
#include <iceoryx_posh/popo/request.hpp>
Inherits from SmartChunk< RpcInterface< Request< T >, ClientSendError >, T, cxx::add_const_conditionally_t< RequestHeader, T > >
Public Functions🔗
Name | |
---|---|
template <typename S =T,typename =ForClientOnly cxx::expected< ClientSendError > |
send() Sends the request via the client from which it was loaned and automatically release ownership to it. |
cxx::add_const_conditionally_t< RequestHeader, T > & | getRequestHeader() Retrieve the request-header of the underlying memory chunk loaned to the sample. |
const RequestHeader & | getRequestHeader() const Retrieve the request-header of the underlying memory chunk loaned to the sample. |
Friends🔗
Name | |
---|---|
class | ClientImpl |
class | ServerImpl |
Detailed Description🔗
template <typename T >
class iox::popo::Request;
The Request class is a mutable abstraction over types which are written to loaned shared memory. These requests are sent to the server via the iceoryx system.
Public Functions Documentation🔗
function send🔗
template <typename S =T,
typename =ForClientOnly<S, T>>
cxx::expected< ClientSendError > send()
Sends the request via the client from which it was loaned and automatically release ownership to it.
Only available for client (non-const type T)
function getRequestHeader🔗
cxx::add_const_conditionally_t< RequestHeader, T > & getRequestHeader()
Retrieve the request-header of the underlying memory chunk loaned to the sample.
Return: The request-header of the underlying memory chunk.
function getRequestHeader🔗
const RequestHeader & getRequestHeader() const
Retrieve the request-header of the underlying memory chunk loaned to the sample.
Return: The request-header of the underlying memory chunk.
Friends🔗
friend ClientImpl🔗
friend class ClientImpl(
ClientImpl
);
friend ServerImpl🔗
friend class ServerImpl(
ServerImpl
);
Updated on 17 March 2022 at 12:15:57 CET