hamsterdb_int.h

About: hamsterdb is a database engine written in ANSI C. It supports a B+Tree index structure, uses

/**
 * \file hamsterdb_int.h
 * \brief Internal hamsterdb functions.
 * \author Christoph Rupp, [e-mail]
 *
 * Copyright (C) 2005-2007 Christoph Rupp ([e-mail]).
 * All rights reserved. See file LICENSE for licence and copyright
 * information.
 *
 */

#ifndef HAM_HAMSTERDB_INT_H__
#define HAM_HAMSTERDB_INT_H__

#ifdef __cplusplus
extern "C" {
#endif 

#include <ham/hamsterdb.h>


/**
 * a callback function for dump - dumps a single key to stdout
 */
typedef void (*ham_dump_cb_t)(const ham_u8_t *key, ham_size_t keysize);

/** 
 * dump the whole tree to stdout
 *
 * @remark you can pass a callback function pointer, or NULL for the default
 * function (dumps the first 16 bytes of the key)
 *
 * @remark This function returns HAM_NOT_IMPLEMENTED unless hamsterdb
 * was built with HAM_ENABLE_INTERNAL (run ./configure --enable-internal)
 *
 * @remark set 'reserved' to NULL
 */
HAM_EXPORT ham_status_t
ham_dump(ham_db_t *db, void *reserved, ham_dump_cb_t cb);

/** 
 * verify the whole tree - this is only useful when you debug hamsterdb
 *
 * @remark This function returns HAM_NOT_IMPLEMENTED unless hamsterdb
 * was built with HAM_ENABLE_INTERNAL (run ./configure --enable-internal)
 *
 * @remark set 'reserved' to NULL
 */
HAM_EXPORT ham_status_t
ham_check_integrity(ham_db_t *db, void *reserved);


#ifdef __cplusplus
} // extern "C"
#endif 

#endif /* HAM_HAMSTERDB_INT_H__ */