#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 (DataSamplesView const &samples) noexcept override |
| Publish correlated DDS samples to shared memory, transforming it first using DataBlender to a UserTopicType. More... | |
| void | CloseQueue () noexcept override |
| Close shared memory queue. More... | |
 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 >
|
overridevirtualnoexcept |
Close shared memory queue.
Subsequent calls to Publish will fail.
Implements rtctk::telSub::ShmPublisherIf.
◆ Publish()
template<class UserTopicType , class DataBlender , class ShmWriter >
|
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
