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

Sample header used by [MessagingPattern::PublishSubscribe]. More...

#include <header_publish_subscribe.hpp>

Public Member Functions

 HeaderPublishSubscribe (const HeaderPublishSubscribe &)=delete
 
 HeaderPublishSubscribe (HeaderPublishSubscribe &&rhs) noexcept
 
auto operator= (const HeaderPublishSubscribe &) -> HeaderPublishSubscribe &=delete
 
auto operator= (HeaderPublishSubscribe &&rhs) noexcept -> HeaderPublishSubscribe &
 
 ~HeaderPublishSubscribe ()
 
auto publisher_id () const -> UniquePublisherId
 Returns the [UniquePublisherId] of the source [Publisher].
 
auto number_of_elements () const -> uint64_t
 Returns the number of [Payload] elements in the received [Sample].
 

Friends

template<ServiceType , typename , typename >
class Sample
 
template<ServiceType , typename , typename >
class SampleMut
 

Detailed Description

Sample header used by [MessagingPattern::PublishSubscribe].

Definition at line 21 of file header_publish_subscribe.hpp.

Constructor & Destructor Documentation

◆ HeaderPublishSubscribe() [1/2]

iox2::HeaderPublishSubscribe::HeaderPublishSubscribe ( const HeaderPublishSubscribe )
delete

◆ HeaderPublishSubscribe() [2/2]

iox2::HeaderPublishSubscribe::HeaderPublishSubscribe ( HeaderPublishSubscribe &&  rhs)
noexcept

◆ ~HeaderPublishSubscribe()

iox2::HeaderPublishSubscribe::~HeaderPublishSubscribe ( )

Member Function Documentation

◆ number_of_elements()

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

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ publisher_id()

auto iox2::HeaderPublishSubscribe::publisher_id ( ) const -> UniquePublisherId

Returns the [UniquePublisherId] of the source [Publisher].

Friends And Related Symbol Documentation

◆ Sample

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

Definition at line 37 of file header_publish_subscribe.hpp.

◆ SampleMut

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

Definition at line 39 of file header_publish_subscribe.hpp.


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