DataStorm  0.1
Data Distribution Service
Public Member Functions | Public Attributes | List of all members
DataStorm::WriterConfig Class Reference

The WriterConfig class specifies configuration options specific to writers. More...

#include <DataStorm/DataStorm.h>

Inheritance diagram for DataStorm::WriterConfig:
DataStorm::Config

Public Member Functions

 WriterConfig (Ice::optional< int > sampleCount=Ice::nullopt, Ice::optional< int > sampleLifetime=Ice::nullopt, Ice::optional< ClearHistoryPolicy > clearHistory=Ice::nullopt, Ice::optional< int > priority=Ice::nullopt) noexcept
 Construct a WriterConfig object. More...
 
- Public Member Functions inherited from DataStorm::Config
 Config (Ice::optional< int > sampleCount=Ice::nullopt, Ice::optional< int > sampleLifetime=Ice::nullopt, Ice::optional< ClearHistoryPolicy > clearHistory=Ice::nullopt) noexcept
 Construct a Config object. More...
 

Public Attributes

Ice::optional< int > priority
 Specifies the writer priority. More...
 
- Public Attributes inherited from DataStorm::Config
Ice::optional< int > sampleCount
 The sampleCount configuration specifies how many samples are kept by the reader or writer in its sample history. More...
 
Ice::optional< int > sampleLifetime
 The sampleLifetime configuration specifies samples to keep in the writer or reader history based on their age. More...
 
Ice::optional< ClearHistoryPolicyclearHistory
 The clear history policy specifies when samples are removed from the sample history. More...
 

Detailed Description

The WriterConfig class specifies configuration options specific to writers.

It extends the Config class and therefore inherits its configuration options.

Constructor & Destructor Documentation

◆ WriterConfig()

DataStorm::WriterConfig::WriterConfig ( Ice::optional< int >  sampleCount = Ice::nullopt,
Ice::optional< int >  sampleLifetime = Ice::nullopt,
Ice::optional< ClearHistoryPolicy clearHistory = Ice::nullopt,
Ice::optional< int >  priority = Ice::nullopt 
)
inlinenoexcept

Construct a WriterConfig object.

The constructor accepts optional parameters for each of the WriterConfig data members.

Parameters
sampleCountThe optional sample count.
sampleLifetimeThe optional sample lifetime.
clearHistoryThe optional clear history policy.
priorityThe writer priority.

Member Data Documentation

◆ priority

Ice::optional<int> DataStorm::WriterConfig::priority

Specifies the writer priority.

The priority is used by readers using the priority discard policy.


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