1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>DbEnv::rep_get_timeout()</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" /> 10 <link rel="up" href="rep.html" title="Chapter 11. Replication Methods" /> 11 <link rel="prev" href="repget_request.html" title="DbEnv::rep_get_request()" /> 12 <link rel="next" href="repmessage.html" title="DbEnv::rep_process_message()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbEnv::rep_get_timeout()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="repget_request.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 11. 23 Replication Methods 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="repmessage.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="sect1" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title" style="clear: both"><a id="repget_timeout"></a>DbEnv::rep_get_timeout()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbEnv::rep_get_timeout(int which, u_int32_t *timeoutp);</pre> 42 <p> 43 The <code class="methodname">DbEnv::rep_get_timeout()</code> method returns the timeout value for 44 the specified <span class="bold"><strong>which</strong></span> parameter. Timeout values can be 45 managed using the <a class="xref" href="repset_timeout.html" title="DbEnv::rep_set_timeout()">DbEnv::rep_set_timeout()</a> method. 46 </p> 47 <p> 48 The <code class="methodname">DbEnv::rep_get_timeout()</code> method may be called at any time during 49 the life of the application. 50 </p> 51 <p> 52 The <code class="methodname">DbEnv::rep_get_timeout()</code> <span> 53 54 <span> 55 method either returns a non-zero error value or throws an 56 exception that encapsulates a non-zero error value on 57 failure, and returns 0 on success. 58 </span> 59 </span> 60 </p> 61 <div class="sect2" lang="en" xml:lang="en"> 62 <div class="titlepage"> 63 <div> 64 <div> 65 <h3 class="title"><a id="id1701619"></a>Parameters</h3> 66 </div> 67 </div> 68 </div> 69 <div class="sect3" lang="en" xml:lang="en"> 70 <div class="titlepage"> 71 <div> 72 <div> 73 <h4 class="title"><a id="id1701726"></a>timeoutp</h4> 74 </div> 75 </div> 76 </div> 77 <p> 78 The <span class="bold"><strong>timeoutp</strong></span> parameter references 79 memory into which the timeout value of the specified <span class="bold"><strong>which</strong></span> parameter is copied. 80 </p> 81 <p> 82 The returned timeout value is in microseconds. 83 </p> 84 </div> 85 <div class="sect3" lang="en" xml:lang="en"> 86 <div class="titlepage"> 87 <div> 88 <div> 89 <h4 class="title"><a id="id1701791"></a>which</h4> 90 </div> 91 </div> 92 </div> 93 <p> 94 The <span class="bold"><strong>which</strong></span> parameter is the timeout 95 for which the value is being returned. 96 See the <a class="xref" href="repset_timeout.html" title="DbEnv::rep_set_timeout()">DbEnv::rep_set_timeout()</a> 97 method for a list of timeouts that you can 98 provide to this parameter. 99</p> 100 </div> 101 </div> 102 <div class="sect2" lang="en" xml:lang="en"> 103 <div class="titlepage"> 104 <div> 105 <div> 106 <h3 class="title"><a id="id1701620"></a>Errors</h3> 107 </div> 108 </div> 109 </div> 110 <p> 111 The <code class="methodname">DbEnv::rep_get_timeout()</code> <span> 112 113 <span> 114 method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> 115 exception, encapsulating one of the following non-zero errors, or return one 116 of the following non-zero errors: 117 </span> 118 </span> 119 </p> 120 <div class="sect3" lang="en" xml:lang="en"> 121 <div class="titlepage"> 122 <div> 123 <div> 124 <h4 class="title"><a id="id1702173"></a>EINVAL</h4> 125 </div> 126 </div> 127 </div> 128 <p> 129 An invalid flag value or parameter was specified. 130 </p> 131 </div> 132 </div> 133 <div class="sect2" lang="en" xml:lang="en"> 134 <div class="titlepage"> 135 <div> 136 <div> 137 <h3 class="title"><a id="id1701609"></a>Class</h3> 138 </div> 139 </div> 140 </div> 141 <p> 142 <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> 143 </p> 144 </div> 145 <div class="sect2" lang="en" xml:lang="en"> 146 <div class="titlepage"> 147 <div> 148 <div> 149 <h3 class="title"><a id="id1701481"></a>See Also</h3> 150 </div> 151 </div> 152 </div> 153 <p> 154 <a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a>, 155 <a class="xref" href="repset_timeout.html" title="DbEnv::rep_set_timeout()">DbEnv::rep_set_timeout()</a> 156 </p> 157 </div> 158 </div> 159 <div class="navfooter"> 160 <hr /> 161 <table width="100%" summary="Navigation footer"> 162 <tr> 163 <td width="40%" align="left"><a accesskey="p" href="repget_request.html">Prev</a> </td> 164 <td width="20%" align="center"> 165 <a accesskey="u" href="rep.html">Up</a> 166 </td> 167 <td width="40%" align="right"> <a accesskey="n" href="repmessage.html">Next</a></td> 168 </tr> 169 <tr> 170 <td width="40%" align="left" valign="top">DbEnv::rep_get_request() </td> 171 <td width="20%" align="center"> 172 <a accesskey="h" href="index.html">Home</a> 173 </td> 174 <td width="40%" align="right" valign="top"> DbEnv::rep_process_message()</td> 175 </tr> 176 </table> 177 </div> 178 </body> 179</html> 180