Skip to content

iox::popo::Sample🔗

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>

Inherits from SmartChunk< PublisherInterface< T, cxx::add_const_conditionally_t< mepoo::NoUserHeader, T > >, T, cxx::add_const_conditionally_t< mepoo::NoUserHeader, T > >

Public Types🔗

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

Public Functions🔗

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

Friends🔗

Name
class PublisherImpl

Detailed Description🔗

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

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

Public Types Documentation🔗

using ForPublisherOnly🔗

template <typename T1 ,
typename T2 >
using iox::popo::Sample< T, H >::ForPublisherOnly =  typename BaseType::template ForProducerOnly<T1, T2>;

Public Functions Documentation🔗

function publish🔗

template <typename S  =T,
typename  =ForPublisherOnly<S, T>>
void publish()

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

Only available for non-const type T.

Friends🔗

friend PublisherImpl🔗

friend class PublisherImpl;

Updated on 18 December 2023 at 13:11:43 CET