DataStorm::Topic< Key, Value, UpdateTag > Class Template Reference

The Topic class. More...

#include <DataStorm/DataStorm.h>

Public Types
using	KeyType = Key
	The topic's key type.
using	ReaderType = Reader<Key, Value, UpdateTag>
	The topic's reader type.
using	SampleType = Sample<Key, Value, UpdateTag>
	The topic's sample type.
using	UpdateTagType = UpdateTag
	The topic's update tag type (defaults to std::string if not specified).
using	ValueType = Value
	The topic's value type.
using	WriterType = Writer<Key, Value, UpdateTag>
	The topic's writer type.

Public Member Functions
	Topic (const Node &node, std::string name) noexcept
	Constructs a new Topic for the topic with the given name.
	Topic (Topic &&topic) noexcept
	Move constructor.
	~Topic ()
	Destructor.
bool	hasReaders () const noexcept
	Indicates whether or not data readers are online.
bool	hasWriters () const noexcept
	Indicates whether or not data writers are online.
Topic &	operator= (Topic &&topic) noexcept
	Move assignment operator.
template<typename Criteria>
void	setKeyFilter (std::string name, std::function< std::function< bool(const Key &)>(const Criteria &)> factory) noexcept
	Sets a key filter factory.
void	setReaderDefaultConfig (const ReaderConfig &config) noexcept
	Sets the default configuration used to construct readers.
template<typename Criteria>
void	setSampleFilter (std::string name, std::function< std::function< bool(const SampleType &)>(const Criteria &)> factory) noexcept
	Sets a sample filter factory.
template<typename UpdateValue>
void	setUpdater (const UpdateTag &tag, std::function< void(Value &, UpdateValue)> updater) noexcept
	Sets an updater function for the given update tag.
void	setWriterDefaultConfig (const WriterConfig &config) noexcept
	Sets the default configuration used to construct readers.
void	waitForNoReaders () const
	Waits for data readers to be offline.
void	waitForNoWriters () const
	Waits for data writers to be offline.
void	waitForReaders (unsigned int count=1) const
	Waits for the given number of data readers to be online.
void	waitForWriters (unsigned int count=1) const
	Waits for the given number of data writers to be online.

Friends
template<typename, typename, typename>
class	FilteredKeyReader
template<typename, typename, typename>
class	MultiKeyReader
template<typename, typename, typename>
class	MultiKeyWriter
template<typename, typename, typename>
class	SingleKeyReader
template<typename, typename, typename>
class	SingleKeyWriter

Detailed Description

template<typename Key, typename Value, typename UpdateTag = std::string>
class DataStorm::Topic< Key, Value, UpdateTag >

The Topic class.

This class allows constructing reader and writer objects. It's also used to setup filter and updater functions.

Definition at line 294 of file DataStorm.h.

---

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

• DataStorm/DataStorm.h