MCSB  2.0.0
High-throughput shared memory middleware
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
MCSB::VariantClientOptionsHelper Class Reference

An options setter class for creating ClientOptions using libvariant's ArgParse. More...

#include <MCSB/VariantClientOptions.h>

Public Member Functions

 VariantClientOptionsHelper (ArgParse &args_, int shortopts=1)
 Install MCSB options into an ArgParse object. More...
 
VariantClientOptionsHelper & DefaultMinProducerBytes (size_t bytes)
 Set the default number of producer bytes (bytes=0 also sets slabs to 0).
 
VariantClientOptionsHelper & DefaultMinConsumerBytes (size_t bytes)
 Set the default number of consumer bytes (bytes=0 also sets slabs to 0).
 
VariantClientOptionsHelper & DefaultMinProducerSlabs (uint32_t slabs)
 Set the default minimum number of producer slabs.
 
VariantClientOptionsHelper & DefaultMinConsumerSlabs (uint32_t slabs)
 Set the default minimum number of consumer slabs.
 
VariantClientOptionsHelper & DefaultVerbosity (int verbosity)
 Set the default MCSB verbosity using values in dbprinter.h.
 

Static Public Member Functions

static ClientOptions VariantClientOptions (const Variant &v)
 Create a ClientOptions object from the parsed arguments in Variant v.
 

Protected Member Functions

 VariantClientOptionsHelper (ArgParse &args_, const char *dummy)
 Alternate constructor to support deprecated legacy ClientOptionsFromVariant.
 

Detailed Description

An options setter class for creating ClientOptions using libvariant's ArgParse.

Constructor & Destructor Documentation

MCSB::VariantClientOptionsHelper::VariantClientOptionsHelper ( ArgParse &  args_,
int  shortopts = 1 
)
inline

Install MCSB options into an ArgParse object.

Parameters
args_The ArgParse object to be used for parsing.
shortopts0: do not install short options, 1: install non-advanced short options (default), 2: install all short options.
See Also
examples/ex4_VariantClientOptions.cc

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