iceoryx_posh 2.0.5
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
iox::popo::Request< T > Class Template Reference

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>

Inheritance diagram for iox::popo::Request< T >:
Inheritance graph
[legend]
Collaboration diagram for iox::popo::Request< T >:
Collaboration graph
[legend]

Public Member Functions

template<typename S = T, typename = ForClientOnly<S, T>>
cxx::expected< ClientSendErrorsend () noexcept
 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 () noexcept
 Retrieve the request-header of the underlying memory chunk loaned to the sample.
 
const RequestHeadergetRequestHeader () const noexcept
 Retrieve the request-header of the underlying memory chunk loaned to the sample.
 

Friends

template<typename , typename , typename >
class ClientImpl
 
template<typename , typename , typename >
class ServerImpl
 

Detailed Description

template<typename T>
class iox::popo::Request< T >

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.

Member Function Documentation

◆ getRequestHeader() [1/2]

template<typename T >
const RequestHeader & iox::popo::Request< T >::getRequestHeader ( ) const
noexcept

Retrieve the request-header of the underlying memory chunk loaned to the sample.

Returns
The request-header of the underlying memory chunk.

◆ getRequestHeader() [2/2]

template<typename T >
cxx::add_const_conditionally_t< RequestHeader, T > & iox::popo::Request< T >::getRequestHeader ( )
noexcept

Retrieve the request-header of the underlying memory chunk loaned to the sample.

Returns
The request-header of the underlying memory chunk.

◆ send()

template<typename T >
template<typename S = T, typename = ForClientOnly<S, T>>
cxx::expected< ClientSendError > iox::popo::Request< T >::send ( )
noexcept

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)


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