qofbackend.h

Go to the documentation of this file.

/********************************************************************\
 * qofbackend.h: api for data storage backend                       *
 * This program is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU General Public License as   *
 * published by the Free Software Foundation; either version 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program 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 General Public License for more details.                     *
 *                                                                  *
 * You should have received a copy of the GNU General Public License*
 * along with this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       [email protected]                   *
 *                                                                  *
\********************************************************************/
#ifndef QOF_BACKEND_H
#define QOF_BACKEND_H

#include "qofinstance.h"
#ifdef __cplusplus
extern "C"
{
#endif

#define QOF_MOD_BACKEND "qof.backend"

typedef enum
{
    ERR_BACKEND_NO_ERR = 0,
    ERR_BACKEND_NO_HANDLER,   
    ERR_BACKEND_NO_BACKEND,   
    ERR_BACKEND_BAD_URL,      
    ERR_BACKEND_NO_SUCH_DB,   
    ERR_BACKEND_CANT_CONNECT, 
    ERR_BACKEND_CONN_LOST,    
    ERR_BACKEND_LOCKED,       
    ERR_BACKEND_STORE_EXISTS, 
    ERR_BACKEND_READONLY,           
    ERR_BACKEND_TOO_NEW,      
    ERR_BACKEND_DATA_CORRUPT, 
    ERR_BACKEND_SERVER_ERR,   
    ERR_BACKEND_ALLOC,        
    ERR_BACKEND_PERM,         
    ERR_BACKEND_MODIFIED,     
    ERR_BACKEND_MOD_DESTROY,  
    ERR_BACKEND_MISC,         
    ERR_QOF_OVERFLOW,                   
    /* fileio errors */
    ERR_FILEIO_FILE_BAD_READ = 1000,  
    ERR_FILEIO_FILE_EMPTY,     
    ERR_FILEIO_FILE_LOCKERR,   
    ERR_FILEIO_FILE_NOT_FOUND, 
    ERR_FILEIO_FILE_TOO_OLD,   
    ERR_FILEIO_UNKNOWN_FILE_TYPE, 
    ERR_FILEIO_PARSE_ERROR,    
    ERR_FILEIO_BACKUP_ERROR,   
    ERR_FILEIO_WRITE_ERROR,    
    ERR_FILEIO_READ_ERROR,     
    ERR_FILEIO_NO_ENCODING,    
    ERR_FILEIO_FILE_EACCES,    
    ERR_FILEIO_RESERVED_WRITE, 
    ERR_FILEIO_FILE_UPGRADE,   
    /* network errors */
    ERR_NETIO_SHORT_READ = 2000,  
    ERR_NETIO_WRONG_CONTENT_TYPE, 
    ERR_NETIO_NOT_GNCXML,         
    /* database errors */
    ERR_SQL_MISSING_DATA = 3000,  
    ERR_SQL_DB_TOO_OLD,           
    ERR_SQL_DB_TOO_NEW,           
    ERR_SQL_DB_BUSY,              
    ERR_SQL_BAD_DBI,              
    ERR_SQL_DBI_UNTESTABLE,       
    /* RPC errors */
    ERR_RPC_HOST_UNK = 4000,      
    ERR_RPC_CANT_BIND,            
    ERR_RPC_CANT_ACCEPT,          
    ERR_RPC_NO_CONNECTION,        
    ERR_RPC_BAD_VERSION,          
    ERR_RPC_FAILED,               
    ERR_RPC_NOT_ADDED,            
} QofBackendError;

typedef struct QofBackendProvider_s QofBackendProvider;

typedef struct QofBackend_s QofBackend;

typedef void (*QofBePercentageFunc) (/*@ null @*/ const char *message, double percent);


void qof_backend_run_begin(QofBackend *be, QofInstance *inst);

gboolean qof_backend_begin_exists(const QofBackend *be);

void qof_backend_run_commit(QofBackend *be, QofInstance *inst);

gboolean qof_backend_commit_exists(const QofBackend *be);

void qof_backend_set_error (QofBackend *be, QofBackendError err);

QofBackendError qof_backend_get_error (QofBackend *be);


gboolean
qof_load_backend_library(const gchar *directory, const gchar* module_name);

void qof_finalize_backend_libraries(void);

QofBackend* qof_book_get_backend (const QofBook *book);

void qof_book_set_backend (QofBook *book, QofBackend *);

#ifdef __cplusplus
}
#endif

#endif /* QOF_BACKEND_H */