The ReaderConfig class specifies configuration options specific to readers. More...
#include <DataStorm/DataStorm.h>
Inheritance diagram for DataStorm::ReaderConfig:
Public Member Functions | |
| ReaderConfig (Ice::optional< int > sampleCount=Ice::nullopt, Ice::optional< int > sampleLifetime=Ice::nullopt, Ice::optional< ClearHistoryPolicy > clearHistory=Ice::nullopt, Ice::optional< DiscardPolicy > discardPolicy=Ice::nullopt) noexcept | |
| Construct a ReaderConfig 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< DiscardPolicy > | discardPolicy |
| Specifies if and how samples are discarded after being received by a reader. 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< ClearHistoryPolicy > | clearHistory |
| The clear history policy specifies when samples are removed from the sample history. More... | |
Detailed Description
The ReaderConfig class specifies configuration options specific to readers.
It extends the Config class and therefore inherits its configuration options.
Constructor & Destructor Documentation
◆ ReaderConfig()
|
inlinenoexcept |
Construct a ReaderConfig object.
The constructor accepts optional parameters for each of the ReaderConfig data members.
- Parameters
-
sampleCount The optional sample count. sampleLifetime The optional sample lifetime. clearHistory The optional clear history policy. discardPolicy The discard policy.
Member Data Documentation
◆ discardPolicy
| Ice::optional<DiscardPolicy> DataStorm::ReaderConfig::discardPolicy |
Specifies if and how samples are discarded after being received by a reader.
The documentation for this class was generated from the following file:
- cpp/include/DataStorm/Types.h
