d9/d4e/flat__file__dictionary__handler_8h_source.html

 /******************************************************************************/
 /******************************************************************************/

 #if !defined(FLAT_FILE_DICTIONARY_HANDLER_H_)
 #define FLAT_FILE_DICTIONARY_HANDLER_H_

 #if defined(__cplusplus)
 extern "C" {
 #endif

 #include "flat_file_types.h"
 #include "flat_file.h"

 void
 ffdict_init(
     ion_dictionary_handler_t *handler
 );

 ion_status_t
 ffdict_insert(
     ion_dictionary_t    *dictionary,
     ion_key_t           key,
     ion_value_t         value
 );

 ion_status_t
 ffdict_get(
     ion_dictionary_t    *dictionary,
     ion_key_t           key,
     ion_value_t         value
 );

 ion_err_t
 ffdict_create_dictionary(
     ion_dictionary_id_t         id,
     ion_key_type_t              key_type,
     ion_key_size_t              key_size,
     ion_value_size_t            value_size,
     ion_dictionary_size_t       dictionary_size,
     ion_dictionary_compare_t    compare,
     ion_dictionary_handler_t    *handler,
     ion_dictionary_t            *dictionary
 );

 ion_status_t
 ffdict_delete(
     ion_dictionary_t    *dictionary,
     ion_key_t           key
 );

 ion_err_t
 ffdict_delete_dictionary(
     ion_dictionary_t *dictionary
 );

 ion_err_t
 ffdict_destroy_dictionary(
     ion_dictionary_id_t id
 );

 ion_status_t
 ffdict_update(
     ion_dictionary_t    *dictionary,
     ion_key_t           key,
     ion_value_t         value
 );

 #if defined(__cplusplus)
 }
 #endif

 #endif
ffdict_update
ion_status_t ffdict_update(ion_dictionary_t *dictionary, ion_key_t key, ion_value_t value)
Updates all records stored at key to have value equal to value.
Definition: flat_file_dictionary_handler.c:461

ion_key_type_t
enum ION_KEY_TYPE ion_key_type_t
This is the available key types for ION_DB. All types will be based on system defines.

ffdict_delete_dictionary
ion_err_t ffdict_delete_dictionary(ion_dictionary_t *dictionary)
Cleans up all files created by the dictionary, and frees any allocated memory.
Definition: flat_file_dictionary_handler.c:435

ion_value_size_t
int ion_value_size_t
The size (length) of a dictionary value in bytes.
Definition: kv_system.h:256

ffdict_delete
ion_status_t ffdict_delete(ion_dictionary_t *dictionary, ion_key_t key)
Removes all instances of any record with key equal to key.
Definition: flat_file_dictionary_handler.c:427

ion_dictionary_id_t
unsigned int ion_dictionary_id_t
A type used to identify dictionaries, specifically in the master table.
Definition: dictionary_types.h:51

ion_dictionary_size_t
unsigned int ion_dictionary_size_t
The implementation specific size of the dictionary.
Definition: kv_system.h:264

ffdict_destroy_dictionary
ion_err_t ffdict_destroy_dictionary(ion_dictionary_id_t id)
Cleans up all files created by the dictionary, and frees any allocated memory, for an already closed ...
Definition: flat_file_dictionary_handler.c:446

key
#define key(k)
Definition: bpp_tree.c:75

ion_dictionary_compare_t
char(* ion_dictionary_compare_t)(ion_key_t, ion_key_t, ion_key_size_t)
Function pointer type for dictionary comparison methods.
Definition: dictionary_types.h:83

ion_err_t
char ion_err_t
The error type used to store error codes.
Definition: kv_system.h:226

ion_key_t
void * ion_key_t
A dictionary key.
Definition: kv_system.h:241

ffdict_init
void ffdict_init(ion_dictionary_handler_t *handler)
Given the handler instance, bind the appropriate flat file functions.
Definition: flat_file_dictionary_handler.c:364

ion_value_t
void * ion_value_t
A dictionary value.
Definition: kv_system.h:246

dictionary
A dictionary contains information regarding an instance of the storage element and the associated han...
Definition: dictionary_types.h:273

ffdict_get
ion_status_t ffdict_get(ion_dictionary_t *dictionary, ion_key_t key, ion_value_t value)
Performs a "get" operation on the dictionary to retrieve a single record.
Definition: flat_file_dictionary_handler.c:389

flat_file_types.h
Implementation specific type definitions for the flat file store.

flat_file.h
Implementation specific declarations for the flat file store.

ffdict_insert
ion_status_t ffdict_insert(ion_dictionary_t *dictionary, ion_key_t key, ion_value_t value)
Given a record ( key, value ), insert it into the dictionary.
Definition: flat_file_dictionary_handler.c:380

ion_key_size_t
int ion_key_size_t
The size (length) of a dictionary key in bytes.
Definition: kv_system.h:251

dictionary_handler
A dictionary_handler is responsible for dealing with the specific interface for an underlying diction...
Definition: dictionary_types.h:207

ion_status_t
A status object that describes the result of a dictionary operation.
Definition: kv_system.h:290

ffdict_create_dictionary
ion_err_t ffdict_create_dictionary(ion_dictionary_id_t id, ion_key_type_t key_type, ion_key_size_t key_size, ion_value_size_t value_size, ion_dictionary_size_t dictionary_size, ion_dictionary_compare_t compare, ion_dictionary_handler_t *handler, ion_dictionary_t *dictionary)
Creates an instance of a flat file backed dictionary.
Definition: flat_file_dictionary_handler.c:398