libdb/docs/api_reference/CXX/repget_limit.html
2011-09-13 13:44:24 -04:00

149 lines
5.8 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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_limit()</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_config.html" title="DbEnv::rep_get_config()" />
<link rel="next" href="repget_nsites.html" title="DbEnv::rep_get_nsites()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::rep_get_limit()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="repget_config.html">Prev</a> </td>
<th width="60%" align="center">Chapter 11. 
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="repget_nsites.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_limit"></a>DbEnv::rep_get_limit()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
int
DbEnv::rep_get_limit(u_int32_t *gbytesp, u_int32_t *bytesp);</pre>
<p>
The <code class="methodname">DbEnv::rep_get_limit()</code> method returns the byte-count limit on
the amount of data that will be transmitted from a site in response to a single message
processed by the <a class="xref" href="repmessage.html" title="DbEnv::rep_process_message()">DbEnv::rep_process_message()</a>
method. This value is configurable using the <a class="xref" href="repset_limit.html" title="DbEnv::rep_set_limit()">DbEnv::rep_set_limit()</a>
method.
</p>
<p>
The <code class="methodname">DbEnv::rep_get_limit()</code> method may be called at any time during
the life of the application.
</p>
<p>
The <code class="methodname">DbEnv::rep_get_limit()</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="id3657725"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3657718"></a>gbytesp</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>gbytesp</strong></span> parameter references
memory into which the gigabytes component of the current transmission
limit is copied.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3657465"></a>bytesp</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>bytesp</strong></span> parameter references
memory into which the bytes component of the current transmission
limit is copied.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3656673"></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="id3657728"></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_limit.html" title="DbEnv::rep_set_limit()">DbEnv::rep_set_limit()</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_config.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="repget_nsites.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::rep_get_config() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::rep_get_nsites()</td>
</tr>
</table>
</div>
</body>
</html>