diff options
| author | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-07-20 20:00:05 +0100 |
|---|---|---|
| committer | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-07-20 20:00:05 +0100 |
| commit | 3ef782d3745ea8f25a3151561a3cfb882190210e (patch) | |
| tree | 86b9c2f5fde051dd0bced99b3fc9f5a3ba08db69 /docs/api_reference/C/txnset_commit_token.html | |
| download | berkeleydb-3ef782d3745ea8f25a3151561a3cfb882190210e.tar.gz | |
Tarball conversion
Diffstat (limited to 'docs/api_reference/C/txnset_commit_token.html')
| -rw-r--r-- | docs/api_reference/C/txnset_commit_token.html | 179 |
1 files changed, 179 insertions, 0 deletions
diff --git a/docs/api_reference/C/txnset_commit_token.html b/docs/api_reference/C/txnset_commit_token.html new file mode 100644 index 00000000..3ea5251b --- /dev/null +++ b/docs/api_reference/C/txnset_commit_token.html @@ -0,0 +1,179 @@ +<?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->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 10. Replication Methods" /> + <link rel="prev" href="envtxn_applied.html" title="DB_ENV->txn_applied()" /> + <link rel="next" href="seq.html" title="Chapter 11. The DB_SEQUENCE 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">DB_TXN->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 10. + 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>DB_TXN->set_commit_token()</h2> + </div> + </div> + </div> + <pre class="programlisting">#include <db.h> + +int +DB_TXN->set_commit_token(DB_TXN *txn, DB_TXN_TOKEN *buffer); </pre> + <p> + The <code class="methodname">DB_TXN->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">DB_TXN->set_commit_token()</code> method may be + called at any time after the + <a class="xref" href="txnbegin.html" title="DB_ENV->txn_begin()">DB_ENV->txn_begin()</a> + method has been called, and before + <a class="xref" href="txncommit.html" title="DB_TXN->commit()">DB_TXN->commit()</a> + has been called. + </p> + <p> + The <code class="methodname">DB_TXN->set_commit_token()</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="idp62501336"></a>Parameters</h3> + </div> + </div> + </div> + <div class="sect3" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h4 class="title"><a id="idp62507736"></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="idp62508080"></a>Errors</h3> + </div> + </div> + </div> + <p> + The <code class="methodname">DB_TXN->set_commit_token()</code> <span> + <span> + method may fail and 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="idp62467480"></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="idp62511112"></a>Class</h3> + </div> + </div> + </div> + <p> + <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="idp62512384"></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">DB_ENV->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 11. + The DB_SEQUENCE Handle + </td> + </tr> + </table> + </div> + </body> +</html> |