1<!--$Id: rep_limit.so,v 1.27 2008/04/29 22:39:21 mbrey Exp $-->
2<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
3<!--See the file LICENSE for redistribution information.-->
4<html>
5<head>
6<title>Berkeley DB: DB_ENV-&gt;rep_set_limit</title>
7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
9</head>
10<body bgcolor=white>
11<table width="100%"><tr valign=top>
12<td>
13<b>DB_ENV-&gt;rep_set_limit</b>
14</td>
15<td align=right>
16<a href="../api_c/api_core.html"><img src="../images/api.gif" alt="API"></a>
17<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
18</tr></table>
19<hr size=1 noshade>
20<tt>
21<b><pre>
22#include &lt;db.h&gt;
23<p>
24int
25DB_ENV-&gt;rep_set_limit(DB_ENV *env, u_int32_t gbytes, u_int32_t bytes);
26<p>
27int
28DB_ENV-&gt;rep_get_limit(DB_ENV *dbenv, u_int32_t *gbytesp, u_int32_t *bytesp);
29</pre></b>
30<hr size=1 noshade>
31<b>Description: DB_ENV-&gt;rep_set_limit</b>
32<p>The DB_ENV-&gt;rep_set_limit method sets a byte-count limit on the amount of data
33that will be transmitted from a site in response to a single message
34processed by the <a href="../api_c/rep_message.html">DB_ENV-&gt;rep_process_message</a> method.  The limit is not a hard limit,
35and the record that exceeds the limit is the last record to be sent.</p>
36<p>Record transmission throttling is turned on by default with a limit of
3710MB.</p>
38<p>If the values passed to the DB_ENV-&gt;rep_set_limit method are both zero, then
39the transmission limit is turned off.</p>
40<p>The database environment's replication subsystem may also be configured using the
41environment's <a href="../ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file.  The syntax of the entry in that
42file is a single line with the string "rep_set_limit", one or more whitespace
43characters, and the limit specified in two parts: the gigabytes and the bytes parameters.
44For example, "rep_set_limit 0 1048576" sets a 1 megabyte limit.
45Because the <a href="../ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file is read when the database environment
46is opened, it will silently overrule configuration done before that
47time.</p>
48<p>The DB_ENV-&gt;rep_set_limit method configures a database environment, not only operations
49performed using the specified <a href="../api_c/env_class.html">DB_ENV</a> handle.</p>
50<p>The DB_ENV-&gt;rep_set_limit method may be called at any time during the life of the
51application.</p>
52<p>The DB_ENV-&gt;rep_set_limit method
53returns a non-zero error value on failure
54and 0 on success.
55</p>
56<b>Parameters</b> <br>
57 <b>bytes</b><ul compact><li>The <b>gbytes</b> and <b>bytes</b> parameters specify the maximum
58number of bytes that will be sent in a single call to <a href="../api_c/rep_message.html">DB_ENV-&gt;rep_process_message</a> method.</ul>
59 <b>gbytes</b><ul compact><li>The <b>gbytes</b> and <b>bytes</b> parameters specify the maximum
60number of bytes that will be sent in a single call to <a href="../api_c/rep_message.html">DB_ENV-&gt;rep_process_message</a> method.</ul>
61<br>
62<hr size=1 noshade>
63<b>Description: rep_get_limit</b>
64<p>The DB_ENV-&gt;rep_get_limit method may be called at any time during the life of the
65application.</p>
66<p>The DB_ENV-&gt;rep_get_limit method
67returns a non-zero error value on failure
68and 0 on success.
69</p>
70<b>Parameters</b> <br>
71 <b>bytesp</b><ul compact><li>The <b>bytesp</b> parameter references memory into which
72 the additional bytes of memory in the current transmit limit is copied.</ul> 
73 <b>gbytesp</b><ul compact><li>The <b>gbytesp</b> parameter references memory into which
74 the gigabytes of memory in the in the current transmit limit is copied.</ul> 
75<br>
76<hr size=1 noshade>
77<br><b>Class</b>
78<a href="../api_c/env_class.html">DB_ENV</a>
79<br><b>See Also</b>
80<a href="../api_c/rep_list.html">Replication and Related Methods</a>
81</tt>
82<table width="100%"><tr><td><br></td><td align=right>
83<a href="../api_c/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
84</td></tr></table>
85<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
86</body>
87</html>
88