iceoryx_posh 2.0.3
Public Types | Public Member Functions | Friends | List of all members
iox::popo::Sample< T, H > Class Template Reference

The Sample class is a mutable abstraction over types which are written to loaned shared memory. These samples are publishable to the iceoryx system. More...

#include <iceoryx_posh/popo/sample.hpp>

Inheritance diagram for iox::popo::Sample< T, H >:
Inheritance graph
[legend]
Collaboration diagram for iox::popo::Sample< T, H >:
Collaboration graph
[legend]

Public Types

template<typename T1 , typename T2 >
using ForPublisherOnly = typename BaseType::template ForProducerOnly< T1, T2 >
 

Public Member Functions

template<typename S = T, typename = ForPublisherOnly<S, T>>
void publish () noexcept
 Publish the sample via the publisher from which it was loaned and automatically release ownership to it. More...
 

Friends

template<typename , typename , typename >
class PublisherImpl
 

Detailed Description

template<typename T, typename H = cxx::add_const_conditionally_t<mepoo::NoUserHeader, T>>
class iox::popo::Sample< T, H >

The Sample class is a mutable abstraction over types which are written to loaned shared memory. These samples are publishable to the iceoryx system.

Member Function Documentation

◆ publish()

template<typename T , typename H = cxx::add_const_conditionally_t<mepoo::NoUserHeader, T>>
template<typename S = T, typename = ForPublisherOnly<S, T>>
void iox::popo::Sample< T, H >::publish ( )
noexcept

Publish the sample via the publisher from which it was loaned and automatically release ownership to it.

Only available for non-const type T.


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