1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DbTxn::set_commit_token()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="rep.html" title="Chapter 11. Replication Methods" />
<link rel="prev" href="envtxn_applied.html" title="DbEnv::txn_applied()" />
<link rel="next" href="seq.html" title="Chapter 12. The DbSequence Handle" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbTxn::set_commit_token()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envtxn_applied.html">Prev</a> </td>
<th width="60%" align="center">Chapter 11.
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="seq.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="txnset_commit_token"></a>DbTxn::set_commit_token()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbTxn::set_commit_token(DB_TXN_TOKEN *buffer);</pre>
<p>
The <code class="methodname">DbTxn::set_commit_token()</code> method
configures the transaction for commit token generation, and accepts
the address of an application-supplied buffer to receive the token.
The actual generation of the token contents does not occur until
commit time.
</p>
<p>
Commit tokens are used to enable some consistency guarantees for
replicated applications. Please see the
<a href="../../programmer_reference/rep_ryw.html" class="olink">Read your writes consistency</a>
section in the <em class="citetitle">Berkeley DB Programmer's Reference Guide</em>
for more information.
</p>
<p>
The <code class="methodname">DbTxn::set_commit_token()</code> method may be
called at any time after the
<a class="xref" href="txnbegin.html" title="DbEnv::txn_begin()">DbEnv::txn_begin()</a>
method has been called, and before
<a class="xref" href="txncommit.html" title="DbTxn::commit()">DbTxn::commit()</a>
has been called.
</p>
<p>
The <code class="methodname">DbTxn::set_commit_token()</code> <span>
<span>
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp10035808"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp10036408"></a>buffer</h4>
</div>
</div>
</div>
<p>
The address of an application-supplied buffer.
The buffer memory must remain available, and will
be filled in later by Berkeley DB, at the time of
the commit() call.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp10037752"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbTxn::set_commit_token()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp10041560"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If the transaction is a nested transaction; if
this method is called on a replication client;
if the database environment is not configured
for logging.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp10039864"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="txn.html" title="Chapter 13. The DbTxn Handle">DbTxn</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp10023568"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="txn.html#txnlist" title="Transaction Subsystem and Related Methods">Transaction Subsystem and Related Methods</a>,
<a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="envtxn_applied.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="rep.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="seq.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::txn_applied() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Chapter 12.
The DbSequence Handle
</td>
</tr>
</table>
</div>
</body>
</html>
|
