Elektra  0.8.10
Namespaces | Data Structures | Functions
kdb Namespace Reference

This is the main namespace for the C++ binding and libraries. More...

Namespaces

namespace  tools
 This namespace is for the libtool library.
 

Data Structures

class  Context
 Provides a context for configuration. More...
 
class  DefaultGetPolicy
 simply lookup without spec More...
 
class  DefaultSetPolicy
 Implements update when key is not found. More...
 
class  Discriminator
 
class  GetPolicyIs
 
class  SetPolicyIs
 
class  KDB
 Opens the session with the Key database. More...
 
class  Key
 A Key is the essential class that encapsulates key name , value and metainfo . More...
 
class  KeySet
 A keyset holds together a set of keys. More...
 
class  KeySetIterator
 
class  KeySetReverseIterator
 

Functions

std::ostream & operator<< (std::ostream &os, kdb::Key const &k)
 Stream the name of a key.
 
std::istream & operator>> (std::istream &is, kdb::Key &k)
 Reads a line with a keys name.
 
std::ostream & operator<< (std::ostream &os, kdb::KeySet const &cks)
 Outputs line per line the keynames.
 
std::istream & operator>> (std::istream &is, kdb::KeySet &ks)
 Reads line per line key names and appends those keys to ks.
 

Detailed Description

This is the main namespace for the C++ binding and libraries.

Classes or Functions directly below this namespace are header-only. Sub namespaces are intended for libraries and you need to link the library if you want to use them.

Function Documentation

std::ostream& kdb::operator<< ( std::ostream &  os,
kdb::Key const &  k 
)
inline

Stream the name of a key.

If you also want to stream the value, use the plugin framework.

Parameters
osthe stream to write to
kthe key which name should be streamed
Returns
the stream
std::ostream& kdb::operator<< ( std::ostream &  os,
kdb::KeySet const &  cks 
)
inline

Outputs line per line the keynames.

To output values you should use the plugin framework.

Parameters
osthe stream to write to
cksthe keyset which should be streamed

Use unsetf(std::ios_base::skipws) or use noskipws iomanip on the stream if you want a null terminated sequence of key names.

Use setf(std::ios_base::unitbuf) on the stream if you want to flush the buffer after each key.

Returns
the stream
std::istream& kdb::operator>> ( std::istream &  is,
kdb::Key k 
)
inline

Reads a line with a keys name.

Parameters
isthe stream to read from
kthe key whose name will be set

Use unsetf(std::ios_base::skipws) on the stream if the keyname is terminated with an null character and not a newline.

Returns
the stream
std::istream& kdb::operator>> ( std::istream &  is,
kdb::KeySet ks 
)
inline

Reads line per line key names and appends those keys to ks.

To input values you need to use the plugin framework.

Parameters
isthe stream to read from
ksthe keyset to append to
Returns
the stream