File: repset_limit.html

package info (click to toggle)
db4.8 4.8.30-12
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 112,656 kB
  • sloc: ansic: 177,324; java: 66,060; tcl: 61,539; cs: 27,778; cpp: 24,761; sh: 15,646; perl: 14,013; xml: 8,309; makefile: 2,199; awk: 1,749; sql: 390; python: 26; php: 22; asm: 14
file content (175 lines) | stat: -rw-r--r-- 7,642 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<?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_set_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="repconfig.html" title="DbEnv::rep_set_config()" />
    <link rel="next" href="repnsites.html" title="DbEnv::rep_set_nsites()" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">DbEnv::rep_set_limit()</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="repconfig.html">Prev</a> </td>
          <th width="60%" align="center">Chapter 11. 
                Replication Methods
        </th>
          <td width="20%" align="right"> <a accesskey="n" href="repnsites.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="repset_limit"></a>DbEnv::rep_set_limit()</h2>
          </div>
        </div>
      </div>
      <pre class="programlisting">#include &lt;db_cxx.h&gt;

int
DbEnv::rep_set_limit(u_int32_t gbytes, u_int32_t bytes); </pre>
      <p>
         The <code class="methodname">DbEnv::rep_set_limit()</code> method sets 
record transmission throttling. This is a 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.  The limit is not a hard limit, and the record that exceeds
         the limit is the last record to be sent.
    </p>
      <p>
         Record transmission throttling is turned on by default with a limit of
         10MB.
    </p>
      <p>
         If the values passed to the <code class="methodname">DbEnv::rep_set_limit()</code> method are both
         zero, then the transmission limit is turned off.
    </p>
      <p>
         The database environment's replication subsystem may also be configured using the
         environment's <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file.  The
         syntax of the entry in that file is a single line with the string "rep_set_limit", one or
         more whitespace characters, and the limit specified in two parts: the 
gigabytes and the
         bytes values. For example, "rep_set_limit 0 1048576" sets a 1 megabyte limit.. Because
         the <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file is read when
         the database environment is opened, it will silently overrule configuration done before
         that time.
    </p>
      <p>
         The <code class="methodname">DbEnv::rep_set_limit()</code> method configures a database environment,
         not only operations performed using the specified <a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>  
         handle.
    </p>
      <p>
         The <code class="methodname">DbEnv::rep_set_limit()</code> method may be called at any time during
         the life of the application.
    </p>
      <p>
         The <code class="methodname">DbEnv::rep_set_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="id1703210"></a>Parameters</h3>
            </div>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="id1703582"></a>bytes</h4>
              </div>
            </div>
          </div>
          <p>
                         The  <span class="bold"><strong>bytes</strong></span> parameter specifies the number of 
                         bytes which, when added to the <span class="bold"><strong>gbytes</strong></span>
                         parameter,  specifies the maximum number of bytes that will be sent in a 
                         single call to the <a class="xref" href="repmessage.html" title="DbEnv::rep_process_message()">DbEnv::rep_process_message()</a> 
                         method.
                     </p>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="id1703106"></a>gbytes</h4>
              </div>
            </div>
          </div>
          <p>
                         The  <span class="bold"><strong>gbytes</strong></span> parameter specifies the number of 
                         gigabytes which, when added to the <span class="bold"><strong>bytes</strong></span>
                         parameter,  specifies the maximum number of bytes that will be sent in a 
                         single call to the <a class="xref" href="repmessage.html" title="DbEnv::rep_process_message()">DbEnv::rep_process_message()</a> 
                         method.
                     </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="id1703716"></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="id1703542"></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> 
                </p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="repconfig.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="repnsites.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">DbEnv::rep_set_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_set_nsites()</td>
        </tr>
      </table>
    </div>
  </body>
</html>