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

The Response class is a mutable abstraction over types which are written to loaned shared memory. These responses are sent to the client via the iceoryx system. More...

#include <iceoryx_posh/popo/response.hpp>

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

Public Member Functions

template<typename S = T, typename = ForServerOnly<S, T>>
cxx::expected< ServerSendErrorsend () noexcept
 Sends the response via the server from which it was loaned and automatically release ownership to it.
 
cxx::add_const_conditionally_t< ResponseHeader, T > & getResponseHeader () noexcept
 Retrieve the response-header of the underlying memory chunk loaned to the sample.
 
const ResponseHeadergetResponseHeader () const noexcept
 Retrieve the response-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::Response< T >

The Response class is a mutable abstraction over types which are written to loaned shared memory. These responses are sent to the client via the iceoryx system.

Member Function Documentation

◆ getResponseHeader() [1/2]

template<typename T >
const ResponseHeader & iox::popo::Response< T >::getResponseHeader ( ) const
noexcept

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

Returns
The response-header of the underlying memory chunk.

◆ getResponseHeader() [2/2]

template<typename T >
cxx::add_const_conditionally_t< ResponseHeader, T > & iox::popo::Response< T >::getResponseHeader ( )
noexcept

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

Returns
The response-header of the underlying memory chunk.

◆ send()

template<typename T >
template<typename S = T, typename = ForServerOnly<S, T>>
cxx::expected< ServerSendError > iox::popo::Response< T >::send ( )
noexcept

Sends the response via the server from which it was loaned and automatically release ownership to it.

Only available for server (non-const type T)


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