Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Keyfile Class Reference

#include <Keyfile.hpp>

List of all members.

Public Methods

void put (const char *key, const void *value, int valueSize)
void put (int key, const void *value, int valueSize)
bool get (const char *key, void *value, int &actualSize, int maxSize) const
bool get (const char *key, char **value, int &actualSize) const
bool get (int key, void *value, int &actualSize, int maxSize) const
bool get (int key, char **value, int &actualSize) const
int getSize (const char *key) const
int getSize (int key) const
void remove (const char *key)
 Remove the entry in the b-tree for the given key.

void remove (int key)
 Remove the entry in the b-tree for the given key.

void open (const std::string &filename, int cacheSize=1024 *1024)
 Open a keyfile with the given filename, with cacheSize (default 1MB).

void open (const char *filename, int cacheSize=1024 *1024)
 Open a keyfile with the given filename, with cacheSize (default 1MB).

void create (const std::string &filename, int cacheSize=1024 *1024)
 Createa keyfile with the given filename, with cacheSize (default 1MB).

void create (const char *filename, int cacheSize=1024 *1024)
 Create a keyfile with the given filename, with cacheSize (default 1MB).

void close ()
 Close a keyfile.

void setFirst ()
 Initialize keyfile to first key for iteration.

bool getNext (int &key, void *value, int &actualSize, int maxSize) const
 get the next key and value pair from the keyfile.

bool getNext (char *key, int maxKeySize, void *value, int &actualSize, int maxSize) const
 get the next key and value pair from the keyfile.

 Keyfile ()
 initialize to empty

Detailed Description

Provides C++ interface to the keyfile b-tree package. Arbitrary data can be stored using either int or char * keys.

Constructor & Destructor Documentation

Keyfile::Keyfile (    )  [inline]
 

initialize to empty

Member Function Documentation

void Keyfile::close (    ) 
 

Close a keyfile.

void Keyfile::create (  const char *    filename,
int    cacheSize = 1024 *1024
) 
 

Create a keyfile with the given filename, with cacheSize (default 1MB).

void Keyfile::create (  const std::string &    filename,
int    cacheSize = 1024 *1024
) 
 

Createa keyfile with the given filename, with cacheSize (default 1MB).

bool Keyfile::get (  int    key,
char **    value,
int &    actualSize
)  const
 

Retrieve the value in the b-tree for the given key. Returns false if key does not exist in the b-tree.

bool Keyfile::get (  int    key,
void *    value,
int &    actualSize,
int    maxSize
)  const
 

Retrieve the value in the b-tree for the given key. Returns false if key does not exist in the b-tree.

bool Keyfile::get (  const char *    key,
char **    value,
int &    actualSize
)  const
 

Retrieve the value in the b-tree for the given key. Returns false if key does not exist in the b-tree.

bool Keyfile::get (  const char *    key,
void *    value,
int &    actualSize,
int    maxSize
)  const
 

Retrieve the value in the b-tree for the given key. Returns false if key does not exist in the b-tree.

bool Keyfile::getNext (  char *    key,
int    maxKeySize,
void *    value,
int &    actualSize,
int    maxSize
)  const
 

get the next key and value pair from the keyfile.

bool Keyfile::getNext (  int &    key,
void *    value,
int &    actualSize,
int    maxSize
)  const
 

get the next key and value pair from the keyfile.

int Keyfile::getSize (  int    key )  const
 

Return the size of the data in the b-tree for the given key. Returns -1 if key does not exist in the b-tree.

int Keyfile::getSize (  const char *    key )  const
 

Return the size of the data in the b-tree for the given key. Returns -1 if key does not exist in the b-tree.

void Keyfile::open (  const char *    filename,
int    cacheSize = 1024 *1024
) 
 

Open a keyfile with the given filename, with cacheSize (default 1MB).

void Keyfile::open (  const std::string &    filename,
int    cacheSize = 1024 *1024
) 
 

Open a keyfile with the given filename, with cacheSize (default 1MB).

void Keyfile::put (  int    key,
const void *    value,
int    valueSize
) 
 

Insert value into b-tree for the given key. Throws an Exception if the operation fails.

void Keyfile::put (  const char *    key,
const void *    value,
int    valueSize
) 
 

Insert value into b-tree for the given key. Throws an Exception if the operation fails.

void Keyfile::remove (  int    key ) 
 

Remove the entry in the b-tree for the given key.

void Keyfile::remove (  const char *    key ) 
 

Remove the entry in the b-tree for the given key.

void Keyfile::setFirst (    ) 
 

Initialize keyfile to first key for iteration.

The documentation for this class was generated from the following files:
Generated on Fri Jul 2 16:25:42 2004 for Lemur Toolkit by doxygen1.2.18