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

#include <shmPublisher.hpp>

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

Public Member Functions
	ShmPublisher (ShmWriter &&shm_writer, DataBlender &blender)
std::error_code	Publish (CorrelatedDataSamplesRef const &dds_samples) noexcept override
void	CloseQueue () noexcept override
Public Member Functions inherited from rtctk::telSub::ShmPublisherIf
virtual	~ShmPublisherIf ()

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 >

std::error_code rtctk::telSub::ShmPublisher< UserTopicType, DataBlender, ShmWriter >::Publish ( CorrelatedDataSamplesRef const &  dds_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/library/src/include/rtctk/telSub/shmPublisher.hpp