rtctk::telSub::ShmPublisher< UserTopicType, DataBlender, ShmWriter > Class Template Reference

#include <rtctk/telSub/shmPublisher.hpp>

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

Public Member Functions
	ShmPublisher (ShmWriter &&shm_writer, DataBlender &blender)
PublisherError	Publish (const DataSamplesView &samples) noexcept override
	Publish correlated DDS samples to shared memory, transforming it first using DataBlender to a UserTopicType.
void	CloseQueue () noexcept override
	Close shared memory queue.
Public Member Functions inherited from rtctk::telSub::ShmPublisherIf
virtual	~ShmPublisherIf ()

Additional Inherited Members
Public Types inherited from rtctk::telSub::ShmPublisherIf
using	PublisherError = std::variant<std::monostate, BlenderError, ShmError>

Detailed Description

template<class UserTopicType, class DataBlender, class ShmWriter = ipcq::Writer<UserTopicType>>
class rtctk::telSub::ShmPublisher< UserTopicType, DataBlender, ShmWriter >

Note

Object size depends mainly on UserTopicType. It is recommended to heap-allocate ShmPublisher for large types of UserTopicType.

Constructor & Destructor Documentation

ShmPublisher()

template<class UserTopicType , class DataBlender , class ShmWriter >

rtctk::telSub::ShmPublisher< UserTopicType, DataBlender, ShmWriter >::ShmPublisher	(	ShmWriter &&	shm_writer,
		DataBlender &	blender )

Member Function Documentation

CloseQueue()

template<class UserTopicType , class DataBlender , class ShmWriter >

void rtctk::telSub::ShmPublisher< UserTopicType, DataBlender, ShmWriter >::CloseQueue ( )

overridevirtualnoexcept

Close shared memory queue.

Subsequent calls to Publish will fail.

Implements rtctk::telSub::ShmPublisherIf.

Publish()

template<class UserTopicType , class DataBlender , class ShmWriter >

ShmPublisherIf::PublisherError rtctk::telSub::ShmPublisher< UserTopicType, DataBlender, ShmWriter >::Publish ( const DataSamplesView & samples )

overridevirtualnoexcept

Publish correlated DDS samples to shared memory, transforming it first using DataBlender to a UserTopicType.

Implements rtctk::telSub::ShmPublisherIf.

---

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

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