qofsession-p.h

00001 /********************************************************************\
00002  * qofsession-p.h -- private functions for QOF sessions.            *
00003  *                                                                  *
00004  * This program is free software; you can redistribute it and/or    *
00005  * modify it under the terms of the GNU General Public License as   *
00006  * published by the Free Software Foundation; either version 2 of   *
00007  * the License, or (at your option) any later version.              *
00008  *                                                                  *
00009  * This program is distributed in the hope that it will be useful,  *
00010  * but WITHOUT ANY WARRANTY; without even the implied warranty of   *
00011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    *
00012  * GNU General Public License for more details.                     *
00013  *                                                                  *
00014  * You should have received a copy of the GNU General Public License*
00015  * along with this program; if not, contact:                        *
00016  *                                                                  *
00017  * Free Software Foundation           Voice:  +1-617-542-5942       *
00018  * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
00019  * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
00020  *                                                                  *
00021 \********************************************************************/
00022 
00023 /*
00024 Copyright (c) 2001 Linux Developers Group
00025 Copyright (c) 1998-2003 Linas Vepstas <linas@linas.org>
00026 Copyright (c) 2006 Neil Williams <linux@codehelp.co.uk> 
00027  */
00028 
00029 #ifndef QOF_SESSION_P_H
00030 #define QOF_SESSION_P_H
00031 
00032 #include "qofbook.h"
00033 #include "qofsession.h"
00034 
00035 struct _QofSession
00036 {
00041     QofEntity entity;
00042 
00043     /* A book holds pointers to the various types of datasets.
00044      * A session may have multiple books. */
00045     GList *books;
00046 
00047     /* The requested book id, in the form or a URI, such as
00048      * file:/some/where, or sql:server.host.com:555
00049      */
00050     gchar *book_id;
00051 
00053     QofErrorId last_err;
00054 
00056     gchar *error_message;
00057 
00058     /* Pointer to the backend that is actually used to move data
00059      * between the persistent store and the local engine.  */
00060     QofBackend *backend;
00061 };
00062 
00063 QofBackend *
00064 qof_session_get_backend (QofSession * session);
00065 
00066 #endif

Generated on Thu Jan 31 22:50:26 2008 for QOF by  doxygen 1.5.4