rtctk::standaloneTools::ShmSubscriber< Topic, ConditionPolicy, ShmTraits > Class Template Reference

Implements basic features for a simple shared memory subscriber program. More...

#include <rtctk/standaloneTools/shmSubscriber.hpp>

Inheritance diagram for rtctk::standaloneTools::ShmSubscriber< Topic, ConditionPolicy, ShmTraits >:

Public Member Functions
	ShmSubscriber ()=default
	~ShmSubscriber () override=default
	ShmSubscriber (const ShmSubscriber &rhs)=delete
ShmSubscriber &	operator= (const ShmSubscriber &rhs)=delete
	ShmSubscriber (ShmSubscriber &&rhs) noexcept=default
ShmSubscriber &	operator= (ShmSubscriber &&rhs) noexcept=default
Public Member Functions inherited from rtctk::standaloneTools::ShmSubscriberBase
	ShmSubscriberBase ()=default
	ShmSubscriberBase (const ShmSubscriberBase &rhs)=delete
ShmSubscriberBase &	operator= (const ShmSubscriberBase &rhs)=delete
	ShmSubscriberBase (ShmSubscriberBase &&rhs)=default
ShmSubscriberBase &	operator= (ShmSubscriberBase &&rhs)=default
virtual	~ShmSubscriberBase ()=default
int	Run (int argc, char *argv[])
	Executes the shared memory subscriber program.

Protected Member Functions
virtual void	PrintSample (const Topic &sample)
	Prints a hex dump of the sample.
Protected Member Functions inherited from rtctk::standaloneTools::ShmSubscriberBase
const std::string &	GetQueueName () const
const std::string &	GetFilename () const
const int64_t	GetSampleNumber () const
const int64_t	PrintWihtLongFormat () const

Detailed Description

template<typename Topic, class ConditionPolicy = ipcq::BoostConditionPolicy, class ShmTraits = ipcq::detail::BoostInterprocessTraits>
class rtctk::standaloneTools::ShmSubscriber< Topic, ConditionPolicy, ShmTraits >

Implements basic features for a simple shared memory subscriber program.

This class should be used to quickly instantiate a shared memory subscriber program that allows basic monitoring of the shared memory and dumping of the raw data to file. This can be useful for testing and debugging.

Constructor & Destructor Documentation

ShmSubscriber() [1/3]

template<typename Topic, class ConditionPolicy = ipcq::BoostConditionPolicy, class ShmTraits = ipcq::detail::BoostInterprocessTraits>

rtctk::standaloneTools::ShmSubscriber< Topic, ConditionPolicy, ShmTraits >::ShmSubscriber ( )

default

~ShmSubscriber()

template<typename Topic, class ConditionPolicy = ipcq::BoostConditionPolicy, class ShmTraits = ipcq::detail::BoostInterprocessTraits>

rtctk::standaloneTools::ShmSubscriber< Topic, ConditionPolicy, ShmTraits >::~ShmSubscriber ( )

overridedefault

ShmSubscriber() [2/3]

template<typename Topic, class ConditionPolicy = ipcq::BoostConditionPolicy, class ShmTraits = ipcq::detail::BoostInterprocessTraits>

rtctk::standaloneTools::ShmSubscriber< Topic, ConditionPolicy, ShmTraits >::ShmSubscriber ( const ShmSubscriber< Topic, ConditionPolicy, ShmTraits > & rhs )

delete

ShmSubscriber() [3/3]

template<typename Topic, class ConditionPolicy = ipcq::BoostConditionPolicy, class ShmTraits = ipcq::detail::BoostInterprocessTraits>

rtctk::standaloneTools::ShmSubscriber< Topic, ConditionPolicy, ShmTraits >::ShmSubscriber ( ShmSubscriber< Topic, ConditionPolicy, ShmTraits > && rhs )

defaultnoexcept

Member Function Documentation

operator=() [1/2]

template<typename Topic, class ConditionPolicy = ipcq::BoostConditionPolicy, class ShmTraits = ipcq::detail::BoostInterprocessTraits>

ShmSubscriber & rtctk::standaloneTools::ShmSubscriber< Topic, ConditionPolicy, ShmTraits >::operator= ( const ShmSubscriber< Topic, ConditionPolicy, ShmTraits > & rhs )

delete

operator=() [2/2]

template<typename Topic, class ConditionPolicy = ipcq::BoostConditionPolicy, class ShmTraits = ipcq::detail::BoostInterprocessTraits>

ShmSubscriber & rtctk::standaloneTools::ShmSubscriber< Topic, ConditionPolicy, ShmTraits >::operator= ( ShmSubscriber< Topic, ConditionPolicy, ShmTraits > && rhs )

defaultnoexcept

PrintSample()

template<typename Topic, class ConditionPolicy = ipcq::BoostConditionPolicy, class ShmTraits = ipcq::detail::BoostInterprocessTraits>

virtual void rtctk::standaloneTools::ShmSubscriber< Topic, ConditionPolicy, ShmTraits >::PrintSample ( const Topic & sample )

inlineprotectedvirtual

Prints a hex dump of the sample.

If the –print-long option was used on the command line then the whole buffer is printed, otherwise only the first 64 bytes is printed.

Parameters

[in]

sample

The data for the sample read from shared memory.

To print better human readable information this method needs to be overridden.

---

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

• standaloneTools/shmSub/src/include/rtctk/standaloneTools/shmSubscriber.hpp