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

A sample provides information about a data element update. More...

#include <DataStorm/DataStorm.h>

Public Types
using	KeyType = Key
	The type of the sample key.
using	UpdateTagType = UpdateTag
	The type of the update tag.
using	ValueType = Value
	The type of the sample value.

Public Member Functions
SampleEvent	getEvent () const noexcept
	Gets the event associated with the sample.
const Key &	getKey () const noexcept
	Gets the key of the sample.
const std::string &	getOrigin () const noexcept
	Gets the origin of the sample.
const std::string &	getSession () const noexcept
	Gets the session identifier of the session that received this sample.
std::chrono::time_point< std::chrono::system_clock >	getTimeStamp () const noexcept
	Gets the timestamp of the sample.
UpdateTag	getUpdateTag () const
	Gets the update tag for the partial update.
const Value &	getValue () const noexcept
	Gets the value of the sample.

Detailed Description

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

A sample provides information about a data element update.

The Sample template provides access to the key, value as well as additional information such as the event, timestamp, update tag. Samples are generated and published by writers and received by readers.

Definition at line 29 of file DataStorm.h.

---

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

• DataStorm/DataStorm.h