iceoryx2
C++ Bindings
Loading...
Searching...
No Matches
iox2::ResponseHeader Class Reference

Response header used by [MessagingPattern::RequestResponse]. More...

#include <header_request_response.hpp>

Public Member Functions

 ResponseHeader (const ResponseHeader &)=delete
 
 ResponseHeader (ResponseHeader &&rhs) noexcept
 
auto operator= (const ResponseHeader &) -> ResponseHeader &=delete
 
auto operator= (ResponseHeader &&rhs) noexcept -> ResponseHeader &
 
 ~ResponseHeader ()
 
auto server_port_id () -> UniqueServerId
 Returns the [UniqueServerId] of the source [Server].
 
auto number_of_elements () const -> uint64_t
 Returns the number of [Payload] elements in the received [Response].
 
auto payload_offset () const -> uint64_t
 Returns the payload offset.
 

Friends

template<ServiceType , typename , typename >
class Response
 
template<ServiceType , typename , typename >
class ResponseMut
 

Detailed Description

Response header used by [MessagingPattern::RequestResponse].

Definition at line 52 of file header_request_response.hpp.

Constructor & Destructor Documentation

◆ ResponseHeader() [1/2]

iox2::ResponseHeader::ResponseHeader ( const ResponseHeader &  )
delete

◆ ResponseHeader() [2/2]

iox2::ResponseHeader::ResponseHeader ( ResponseHeader &&  rhs)
noexcept

◆ ~ResponseHeader()

iox2::ResponseHeader::~ResponseHeader ( )

Member Function Documentation

◆ number_of_elements()

auto iox2::ResponseHeader::number_of_elements ( ) const -> uint64_t

Returns the number of [Payload] elements in the received [Response].

◆ operator=() [1/2]

auto iox2::ResponseHeader::operator= ( const ResponseHeader &  ) -> ResponseHeader &=delete
delete

◆ operator=() [2/2]

auto iox2::ResponseHeader::operator= ( ResponseHeader &&  rhs) -> ResponseHeader &
noexcept

◆ payload_offset()

auto iox2::ResponseHeader::payload_offset ( ) const -> uint64_t

Returns the payload offset.

◆ server_port_id()

auto iox2::ResponseHeader::server_port_id ( ) -> UniqueServerId

Returns the [UniqueServerId] of the source [Server].

Friends And Related Symbol Documentation

◆ Response

template<ServiceType , typename , typename >
friend class Response
friend

Definition at line 71 of file header_request_response.hpp.

◆ ResponseMut

template<ServiceType , typename , typename >
friend class ResponseMut
friend

Definition at line 73 of file header_request_response.hpp.


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