QOF: qofsession-p.h Source File

QOF 0.7.5

qofsession-p.h
1 /********************************************************************\
2 * qofsession-p.h -- private functions for QOF sessions. *
3 * *
4 * This program is free software; you can redistribute it and/or *
5 * modify it under the terms of the GNU General Public License as *
6 * published by the Free Software Foundation; either version 2 of *
7 * the License, or (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License*
15 * along with this program; if not, contact: *
16 * *
17 * Free Software Foundation Voice: +1-617-542-5942 *
18 * 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
19 * Boston, MA 02110-1301, USA gnu@gnu.org *
20 * *
21 \********************************************************************/
22
23 /*
24 Copyright (c) 2001 Linux Developers Group
25 Copyright (c) 1998-2003 Linas Vepstas <linas@linas.org>
26 Copyright (c) 2006 Neil Williams <linux@codehelp.co.uk>
27 */
28
29 #ifndef QOF_SESSION_P_H
30 #define QOF_SESSION_P_H
31
32 #include "qofbook.h"
33 #include "qofsession.h"
34
35 struct _QofSession
36 {
41 QofEntity entity;
42
43 /* A book holds pointers to the various types of datasets.
44 * A session may have multiple books. */
45 GList *books;
46
47 /* The requested book id, in the form or a URI, such as
48 * file:/some/where, or sql:server.host.com:555
49 */
50 gchar *book_id;
51
53 QofErrorId last_err;
54
56 gchar *error_message;
57
58 /* Pointer to the backend that is actually used to move data
59 * between the persistent store and the local engine. */
60 QofBackend *backend;
61 };
62
63 QofBackend *
64 qof_session_get_backend (QofSession * session);
65
66 #endif
qofsession.h
Encapsulates a connection to a backend (persistent store)
_QofSession::entity
QofEntity entity
Definition: qofsession-p.h:41
_QofSession
Definition: qofsession-p.h:35
QofEntity_s
Definition: qofid.h:147
QofErrorId
gint32 QofErrorId
The ID of this error.
Definition: qofbackend.h:54
qofbook.h
Encapsulate all the information about a dataset.
_QofSession::last_err
QofErrorId last_err
Definition: qofsession-p.h:53
QofBackend_s
Definition: qofbackend-p.h:283
_QofSession::error_message
gchar * error_message
Definition: qofsession-p.h:56