qofbackend.h File Reference

API for data storage Backend. More...

#include "qofinstance.h"

Go to the source code of this file.

Defines
#define	QOF_MOD_BACKEND   "qof.backend"
Typedefs
typedef struct QofBackendProvider_s	QofBackendProvider
typedef struct QofBackend_s	QofBackend
	Pseudo-object providing an interface between the engine and a persistant data store (e.g. a server, a database, or a file).
typedef void(*	QofBePercentageFunc )(const char *message, double percent)
	DOCUMENT ME!
Enumerations
enum	QofBackendError {   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, 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, ERR_NETIO_SHORT_READ = 2000, ERR_NETIO_WRONG_CONTENT_TYPE, ERR_NETIO_NOT_GNCXML,   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, 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 }
	The errors that can be reported to the GUI & other front-end users. More...
Functions
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)
	Load a QOF-compatible backend shared library.
void	qof_finalize_backend_libraries (void)
	Finalize all loaded backend sharable libraries.
QofBackend *	qof_book_get_backend (const QofBook *book)
	Retrieve the backend used by this book.
void	qof_book_set_backend (QofBook *book, QofBackend *)
Allow access to the begin routine for this backend.
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)

---

Detailed Description

API for data storage Backend.

Author:

Copyright (C) 2000-2001 Linas Vepstas <linas@linas.org>

Copyright 2004-2005 Neil Williams <linux@codehelp.co.uk>

Definition in file qofbackend.h.