File: txnprepare.html

package info (click to toggle)
db4.8 4.8.30-12
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 112,656 kB
  • sloc: ansic: 177,324; java: 66,060; tcl: 61,539; cs: 27,778; cpp: 24,761; sh: 15,646; perl: 14,013; xml: 8,309; makefile: 2,199; awk: 1,749; sql: 390; python: 26; php: 22; asm: 14
file content (141 lines) | stat: -rw-r--r-- 5,905 bytes parent folder | download | duplicates (2)
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
<?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>DB_TXN-&gt;prepare()</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="txn.html" title="Chapter 12.  The DB_TXN Handle" />
    <link rel="prev" href="txnid.html" title="DB_TXN-&gt;id()" />
    <link rel="next" href="txnrecover.html" title="DB_ENV-&gt;txn_recover()" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">DB_TXN-&gt;prepare()</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="txnid.html">Prev</a> </td>
          <th width="60%" align="center">Chapter 12. 
                The DB_TXN Handle 
        </th>
          <td width="20%" align="right"> <a accesskey="n" href="txnrecover.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="txnprepare"></a>DB_TXN-&gt;prepare()</h2>
          </div>
        </div>
      </div>
      <pre class="programlisting">#include &lt;db.h&gt;

int
DB_TXN-&gt;prepare(DB_TXN *tid, u_int8_t gid[DB_XIDDATASIZE]);  </pre>
      <p>
         The <code class="methodname">DB_TXN-&gt;prepare()</code> method initiates the beginning of a two-phase
         commit.
    </p>
      <p>
         In a distributed transaction environment, Berkeley DB can be used as a
         local transaction manager.  In this case, the distributed transaction
         manager must send <span class="emphasis"><em>prepare</em></span> messages to each local
         manager.  The local manager must then issue a <code class="methodname">DB_TXN-&gt;prepare()</code> and
         await its successful return before responding to the distributed
         transaction manager.  Only after the distributed transaction manager
         receives successful responses from all of its
         <span class="emphasis"><em>prepare</em></span> messages should it issue any
         <span class="emphasis"><em>commit</em></span> messages.
    </p>
      <p>
         In the case of nested transactions, preparing the parent causes all
         unresolved children of the parent transaction to be committed.  Child
         transactions should never be explicitly prepared.  Their fate will be
         resolved along with their parent's during global recovery.
    </p>
      <p>
         The <code class="methodname">DB_TXN-&gt;prepare()</code> <span>
            <span>
                  method returns a non-zero error value on failure and 0 on success.
            </span>
            
        </span>
    </p>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="id1709775"></a>Parameters</h3>
            </div>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="id1709784"></a>gid</h4>
              </div>
            </div>
          </div>
          <p>
                          The <span class="bold"><strong>gid</strong></span> parameter specifies the
                          global transaction ID by which this transaction will be known.  This
                          global transaction ID will be returned in calls
                          to <a class="xref" href="txnrecover.html" title="DB_ENV-&gt;txn_recover()">DB_ENV-&gt;txn_recover()</a>
                          telling the application which global transactions must be resolved.
                     </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="id1709682"></a>Class</h3>
            </div>
          </div>
        </div>
        <p>
                 <a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>, <a class="link" href="txn.html" title="Chapter 12.  The DB_TXN Handle">DB_TXN</a> 
            </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="id1709837"></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> 
                </p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="txnid.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="txn.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="txnrecover.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">DB_TXN-&gt;id() </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> DB_ENV-&gt;txn_recover()</td>
        </tr>
      </table>
    </div>
  </body>
</html>