rtctk::telSub::ShmPublisherIf Class Reference

Simple interface to class that owns the shared memory queue. More...

#include <rtctk/telSub/shmPublisherIf.hpp>

Inheritance diagram for rtctk::telSub::ShmPublisherIf:

Classes
struct	BlenderError
struct	ShmError

Public Types
using	PublisherError = std::variant<std::monostate, BlenderError, ShmError>

Public Member Functions
virtual	~ShmPublisherIf ()=default
virtual PublisherError	Publish (const DataSamplesView &samples) noexcept=0
	Publish correlated data samples to shared memory.
virtual void	CloseQueue () noexcept=0
	Close shared memory queue.

Detailed Description

Simple interface to class that owns the shared memory queue.

Thread Safety

thread-compatible

Member Typedef Documentation

PublisherError

using rtctk::telSub::ShmPublisherIf::PublisherError = std::variant<std::monostate, BlenderError, ShmError>

Constructor & Destructor Documentation

~ShmPublisherIf()

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

virtualdefault

Member Function Documentation

CloseQueue()

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

pure virtualnoexcept

Close shared memory queue.

Subsequent calls to Publish will fail.

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

Publish()

virtual PublisherError rtctk::telSub::ShmPublisherIf::Publish ( const DataSamplesView & samples )

pure virtualnoexcept

Publish correlated data samples to shared memory.

Parameters

samples

Correlated data samples to publish.

Returns

Error code.

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

---

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

• reusableComponents/telSub/lib/src/include/rtctk/telSub/shmPublisherIf.hpp