<?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>DbEnv::rep_get_timeout()</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="repget_request.html" title="DbEnv::rep_get_request()" /> <link rel="next" href="repmessage.html" title="DbEnv::rep_process_message()" /> </head> <body> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">DbEnv::rep_get_timeout()</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="repget_request.html">Prev</a> </td> <th width="60%" align="center">Chapter 11. Replication Methods </th> <td width="20%" align="right"> <a accesskey="n" href="repmessage.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="repget_timeout"></a>DbEnv::rep_get_timeout()</h2> </div> </div> </div> <pre class="programlisting">#include <db_cxx.h> int DbEnv::rep_get_timeout(int which, u_int32_t *timeoutp);</pre> <p> The <code class="methodname">DbEnv::rep_get_timeout()</code> method returns the timeout value for the specified <span class="bold"><strong>which</strong></span> parameter. Timeout values can be managed using the <a class="xref" href="repset_timeout.html" title="DbEnv::rep_set_timeout()">DbEnv::rep_set_timeout()</a> method. </p> <p> The <code class="methodname">DbEnv::rep_get_timeout()</code> method may be called at any time during the life of the application. </p> <p> The <code class="methodname">DbEnv::rep_get_timeout()</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="id1701915"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1702120"></a>timeoutp</h4> </div> </div> </div> <p> The <span class="bold"><strong>timeoutp</strong></span> parameter references memory into which the timeout value of the specified <span class="bold"><strong>which</strong></span> parameter is copied. </p> <p> The returned timeout value is in microseconds. </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1701864"></a>which</h4> </div> </div> </div> <p> The <span class="bold"><strong>which</strong></span> parameter is the timeout for which the value is being returned. See the <a class="xref" href="repset_timeout.html" title="DbEnv::rep_set_timeout()">DbEnv::rep_set_timeout()</a> method for a list of timeouts that you can provide to this parameter. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="id1701865"></a>Errors</h3> </div> </div> </div> <p> The <code class="methodname">DbEnv::rep_get_timeout()</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="id1702028"></a>EINVAL</h4> </div> </div> </div> <p> An invalid flag value or parameter was specified. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="id1702292"></a>Class</h3> </div> </div> </div> <p> <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="id1701987"></a>See Also</h3> </div> </div> </div> <p> <a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a>, <a class="xref" href="repset_timeout.html" title="DbEnv::rep_set_timeout()">DbEnv::rep_set_timeout()</a> </p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="repget_request.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="repmessage.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">DbEnv::rep_get_request() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> DbEnv::rep_process_message()</td> </tr> </table> </div> </body> </html>