~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_cxx/txn_class.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: DbTxn</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>DbTxn</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
#include &lt;db_cxx.h&gt;
24
 
<p>
25
 
class DbTxn {
26
 
public:
27
 
        DB_TXN *DbTxn::get_DB_TXN();
28
 
        const DB_TXN *DbTxn::get_const_DB_TXN() const;
29
 
        static DbTxn *DbTxn::get_DbTxn(DB_TXN *txn);
30
 
        static const DbTxn *DbTxn::get_const_DbTxn(const DB_TXN *txn);
31
 
        ...
32
 
};
33
 
</pre></h3>
34
 
<h1>Description</h1>
35
 
<p>The DbTxn object is the handle for a transaction.  Methods off
36
 
the DbTxn handle are used to configure, abort and commit the
37
 
transaction.  DbTxn handles are provided to <a href="../api_cxx/db_class.html">Db</a> methods
38
 
in order to transactionally protect those database operations.
39
 
<p>DbTxn handles are not free-threaded; transactions handles may
40
 
be used by multiple threads, but only serially, that is, the application
41
 
must serialize access to the DbTxn handle.  Once the
42
 
<a href="../api_cxx/txn_abort.html">DbTxn::abort</a> or <a href="../api_cxx/txn_commit.html">DbTxn::commit</a> methods are called, the handle may
43
 
not be accessed again, regardless of the method's return. In addition,
44
 
parent transactions may not issue any Berkeley DB operations while they have
45
 
active child transactions (child transactions that have not yet been
46
 
committed or aborted) except for <a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, <a href="../api_cxx/txn_abort.html">DbTxn::abort</a>
47
 
and <a href="../api_cxx/txn_commit.html">DbTxn::commit</a>.
48
 
<p>Each DbTxn object has an associated DB_TXN struct, which
49
 
is used by the underlying implementation of Berkeley DB and its C-language
50
 
API.  The DbTxn::get_DB_TXN method returns a pointer to this struct.
51
 
Given a const DbTxn object, DbTxn::get_const_DB_TXN returns a
52
 
const pointer to the same struct.
53
 
<p>Given a DB_TXN struct, the Db::get_DbTxn method returns the
54
 
corresponding DbTxn object, if there is one.  If the
55
 
DB_TXN object was not associated with a DbTxn (that is,
56
 
it was not returned from a call to DbTxn::get_DB_TXN), then the result
57
 
of DbTxn::get_DbTxn is undefined.  Given a const DB_TXN struct,
58
 
DbTxn::get_const_DbTxn returns the associated const DbTxn
59
 
object, if there is one.
60
 
<p>These methods may be useful for Berkeley DB applications including  both C
61
 
and C++ language software.  It should not be necessary to use these
62
 
calls in a purely C++ application.
63
 
<h1>Class</h1>
64
 
<a href="../api_cxx/env_class.html">DbEnv</a>, DbTxn
65
 
<h1>See Also</h1>
66
 
<a href="../api_cxx/txn_list.html">Transaction Subsystem and Related Methods</a>
67
 
</tt>
68
 
<table width="100%"><tr><td><br></td><td align=right>
69
 
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
70
 
</td></tr></table>
71
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
72
 
</body>
73
 
</html>