Wiretap API  <small>Wiretap 2021.2</small>
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
WireTapDictionary Class Reference

Public Member Functions

bool getInteger (const char *field, int &value) const
 
const char * getStream () const
 
bool getString (const char *field, WireTapStr &value) const
 
bool isEmpty () const
 
void setInteger (const char *field, int value)
 
void setString (const char *field, const char *value)
 
 WireTapDictionary (const char *stream="")
 
 ~WireTapDictionary ()
 

Constructor & Destructor Documentation

WireTapDictionary::WireTapDictionary ( const char *  stream = "")
explicit
WireTapDictionary::~WireTapDictionary ( )

Member Function Documentation

bool WireTapDictionary::getInteger ( const char *  field,
int &  value 
) const
const char* WireTapDictionary::getStream ( ) const

Serialize dictionnary.

bool WireTapDictionary::getString ( const char *  field,
WireTapStr value 
) const

Retrieve a value from the dictionary

Parameters
[in]fieldField name
[out]valueValue retrieved.
Returns
false if the field could not be found, in which case value remains untouched.
bool WireTapDictionary::isEmpty ( ) const
void WireTapDictionary::setInteger ( const char *  field,
int  value 
)
void WireTapDictionary::setString ( const char *  field,
const char *  value 
)

Store a value in the dictionary.

Parameters
[in]fieldField name
[in]valueValue to store.
Note
will overwrite previous value if already defined

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