RTC Toolkit  0.1.0-alpha
Public Member Functions | List of all members
rtctk::telSub::ShmPublisherIf Class Referenceabstract

#include <shmPublisherIf.hpp>

Inheritance diagram for rtctk::telSub::ShmPublisherIf:
rtctk::telSub::MockShmPublisherIf rtctk::telSub::ShmPublisher< UserTopicType, DataBlender, ShmWriter >

Public Member Functions

virtual ~ShmPublisherIf ()
 
virtual std::error_code Publish (CorrelatedDataSamplesRef const &dds_samples) RTCTK_NOEXCEPT=0
 
virtual void CloseQueue () RTCTK_NOEXCEPT=0
 

Detailed Description

Class that owns the shared memory queue.

@threadcompatible{}

Constructor & Destructor Documentation

◆ ~ShmPublisherIf()

virtual rtctk::telSub::ShmPublisherIf::~ShmPublisherIf ( )
inlinevirtual

Member Function Documentation

◆ CloseQueue()

virtual void rtctk::telSub::ShmPublisherIf::CloseQueue ( )
pure virtual

Close shared memory queue.

Subsequent calls to Publish will fail.

Implemented in rtctk::telSub::ShmPublisher< UserTopicType, DataBlender, ShmWriter >.

◆ Publish()

virtual std::error_code rtctk::telSub::ShmPublisherIf::Publish ( CorrelatedDataSamplesRef const &  dds_samples)
pure virtual

Publish correlated DDS samples to shared memory.

Returns
Error code.

Implemented in rtctk::telSub::ShmPublisher< UserTopicType, DataBlender, ShmWriter >.


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