modelstorage.h

Go to the documentation of this file.

/**********************************************************************
 *
 * Verball Model Storage Library, Common Information Model Library 
 * for integration of Intelligent Services.
 * Copyright (C) 2005 Nikita Vinokurov, Orgway LLC.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; 
 * version 2.1 of the License.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, 
 * Boston, MA  02110-1301  USA
 *
 * $Id: modelstorage.h,v 1.49 2006/12/10 10:21:26 yagel Exp $
 **********************************************************************/

#ifndef _MODEL_STORAGE_H_
#define _MODEL_STORAGE_H_

#if defined(_WIN32) || defined(__declspec)
#ifdef _MODEL_STORAGE_SOURCE
#define MS_STORAGE_TYPE __declspec(dllexport)
#else
#define MS_STORAGE_TYPE __declspec(dllimport)
#endif
#else
#define MS_STORAGE_TYPE extern
#endif

#include"stmt/statement.h"
#define MODELSTORAGE_ERR_LOCKED    -2011
#define MODELSTORAGE_ERR_ENCRYPTED -2014
#define MODELSTORAGE_ERR_READING    -2015
#define MODELSTORAGE_ERR_UNDECRYPTED -2016

#define MODEL_STORAGE_MAX_READINGS 6000

#define MODEL_STORAGE_MAX_UPDATINGS 400

#define MODEL_STORAGE_MAX_TXNS 100

#define MODEL_STORAGE_MAX_GRULES 100

#define MODEL_STORAGE_MAX_SRULES 100

#define MODEL_STORAGE_MAX_CLIENTS 100

#define MS_MAX_PATH 1024
#define MS_MAX_URI  1024

#define ID_COUNTER_FILE ".ic"
#define MODEL_STORAGE_LOG "modelstorage.log"
#define MODEL_STORAGE_DB "modelstorage.db"

typedef struct _ms_transaction MSTxn;
typedef struct _ms_blob MSBlob;
typedef struct _model_storage_env ModelStorageEnv;

typedef struct _model_storage ModelStorage;

typedef void (*MSNotify)(const Statement *list, void *data);



typedef void (MSProgress)(double percent, char *message, void *data);

typedef enum {
    MS_OPT_LOGFILE = 1,
    MS_OPT_IDFILE = 2,
    MS_OPT_SERVER = 3,
    MS_OPT_DBFILE = 4,  

} MSOption;

#ifdef __cplusplus
extern "C"
{
#endif/* __cplusplus */

MS_STORAGE_TYPE
ModelStorage *model_storage_new(ModelStorageEnv *env);

MS_STORAGE_TYPE
int model_storage_init_env(const char *filename, ModelStorageEnv **env);


MS_STORAGE_TYPE
int model_storage_init_env_se(const char *filename, int descrypt, const char *passphrase, ModelStorageEnv **env);

MS_STORAGE_TYPE
int model_storage_set_context_key(ModelStorage *ms, const char *context_key);

MS_STORAGE_TYPE
const char *model_storage_get_context_key(ModelStorage *ms);

MS_STORAGE_TYPE
int notification_read(ModelStorage *ms, Statement *op);

MS_STORAGE_TYPE int model_storage_get_new_id(ModelStorage *ms, Node *idnode);


MS_STORAGE_TYPE
int model_storage_set(ModelStorage *ms, MSTxn *txn, Statement *stmt);

MS_STORAGE_TYPE
int model_storage_get(ModelStorage *ms, MSTxn *txn, Statement *mask, Statement **result);

MS_STORAGE_TYPE
int model_storage_get_count(ModelStorage *ms, MSTxn *txn, Statement *mask, unsigned long *result_count);

MS_STORAGE_TYPE
int model_storage_batch_get(ModelStorage *ms, MSTxn *txn, Statement *mask_list, Statement **result);

MS_STORAGE_TYPE
int model_storage_free_env(ModelStorageEnv *env);

MS_STORAGE_TYPE void model_storage_free(ModelStorage *ms);

MS_STORAGE_TYPE
int model_storage_begin_transaction(ModelStorageEnv *env, MSTxn **txn);

MS_STORAGE_TYPE
int model_storage_rollback_transaction(ModelStorage *ms, MSTxn *txn);

MS_STORAGE_TYPE int model_storage_commit_transaction(ModelStorage *ms, MSTxn *txn);


MS_STORAGE_TYPE void model_storage_dump(ModelStorageEnv *env);

MS_STORAGE_TYPE int model_storage_restore(ModelStorageEnv *env);

MS_STORAGE_TYPE int model_storage_set_time(ModelStorage *ms, time_t time);

MS_STORAGE_TYPE int model_storage_get_time(ModelStorage *ms, time_t *time);


MS_STORAGE_TYPE
const char * model_storage_get_filename(ModelStorageEnv *env);

MS_STORAGE_TYPE int model_storage_set_notify(ModelStorage *ms, MSNotify cb, void *data);

MS_STORAGE_TYPE void model_storage_save(ModelStorageEnv *env);

MS_STORAGE_TYPE int model_storage_save_se(ModelStorageEnv *env, const char *passphrase);

MS_STORAGE_TYPE int model_storage_save_as(ModelStorageEnv *env, const char *filename);

MS_STORAGE_TYPE ModelStorageEnv *model_storage_get_env(ModelStorage *ms);


MS_STORAGE_TYPE int model_storage_blob_open(ModelStorage *ms, Node *n, MSBlob **blob);

MS_STORAGE_TYPE int model_storage_blob_read(MSBlob *blob, void *buffer, size_t size, size_t *read);

MS_STORAGE_TYPE int model_storage_blob_write(MSBlob *blob, void *buffer, size_t size);

MS_STORAGE_TYPE int model_storage_blob_seek(MSBlob *blob, long offset);

MS_STORAGE_TYPE int model_storage_blob_tell(MSBlob *blob, long *offset);

MS_STORAGE_TYPE int model_storage_blob_truncate(MSBlob *blob, size_t size);

MS_STORAGE_TYPE int model_storage_blob_close(MSBlob *blob);

MS_STORAGE_TYPE int model_storage_configure(ModelStorageEnv *env, MSOption opt, void *value);

MS_STORAGE_TYPE int model_storage_n4_export(ModelStorage *ms, char *filename, MSProgress cb, void *data);

MS_STORAGE_TYPE int model_storage_n4_import(ModelStorage *ms, char *filename, MSProgress cb, void *data);


#ifdef __cplusplus
}
#endif/* __cplusplus */

#endif /* _MODEL_STORAGE_H */
#ifdef DMALLOC
#include <dmalloc.h>
#endif

---