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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
<?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::set_backup_callbacks()</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="env.html" title="Chapter 5. The DbEnv Handle" />
<link rel="prev" href="envset_app_dispatch.html" title="DbEnv::set_app_dispatch()" />
<link rel="next" href="envset_backup_config.html" title="DbEnv::set_backup_config()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::set_backup_callbacks()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envset_app_dispatch.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5.
The DbEnv Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envset_backup_config.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="envset_backup_callbacks"></a>DbEnv::set_backup_callbacks()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
DB_ENV->set_backup_callbacks(
int (*open_func)(DB_ENV *, const char *dbname,
const char *target, void **handle),
int (*write_func)(DB_ENV *, u_int32_t offset_gbytes,
u_int32_t offset_bytes, u_int32_t size,
u_int8_t *buf, void *handle),
int (*close_func)(DB_ENV *, const char *dbname, void *handle)); </pre>
<p>
The <code class="methodname">DbEnv::set_backup_callbacks()</code> method
configures three callback functions which can be used by the
<a class="xref" href="envbackup.html" title="DbEnv::backup()">DbEnv::backup()</a>
or
<a class="xref" href="envdbbackup.html" title="DbEnv::dbbackup()">DbEnv::dbbackup()</a>
methods to override their default behavior. If one callback is
configured, then all three callbacks must be configured.
These callbacks are required if the <code class="literal">target</code> parameter is
set to <code class="literal">NULL</code> for the
<a class="xref" href="envbackup.html" title="DbEnv::backup()">DbEnv::backup()</a>
or
<a class="xref" href="envdbbackup.html" title="DbEnv::dbbackup()">DbEnv::dbbackup()</a>
methods.
</p>
<p>
The <code class="methodname">DbEnv::set_backup_callbacks()</code> method
configures operations performed using the specified
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> handle, not all operations
performed on the underlying database environment.
</p>
<p>
The <code class="methodname">DbEnv::set_backup_callbacks()</code> method may
be called at any time during the life of the application.
</p>
<p>
The <code class="methodname">DbEnv::set_backup_callbacks()</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="idp7155192"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp7140248"></a>open_func</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>open_func</strong></span> parameter
is the function used when a target location is opened
during a backup. This function should do whatever is
necessary to prepare the backup destination for
writing the data.
</p>
<p>
This function takes four parameters:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">dbenv</code>
</p>
<p>
The <span class="bold"><strong>dbenv</strong></span>
parameter is the enclosing database environment
handle.
</p>
</li>
<li>
<p>
<code class="literal">dbname</code>
</p>
<p>
The <span class="bold"><strong>dbname</strong></span> parameter is the
name of the database being backed up.
</p>
</li>
<li>
<p>
<code class="literal">target</code>
</p>
<p>
The <span class="bold"><strong>target</strong></span> parameter is the
backup's directory destination.
</p>
</li>
<li>
<p>
<code class="literal">handle</code>
</p>
<p>
The <span class="bold"><strong>handle</strong></span> parameter references
the handle (usually a file handle) to which the backup will be
written.
</p>
</li>
</ul>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp7133616"></a>write_func</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>write_func</strong></span> parameter
is the function used to write data during a backup.
The function takes six parameters:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">dbenv</code>
</p>
<p>
The <span class="bold"><strong>dbenv</strong></span>
parameter is the enclosing database environment
handle.
</p>
</li>
<li>
<p>
<code class="literal">offset_gbytes</code>
</p>
<p>
The <span class="bold"><strong>offset_gbytes</strong></span>
parameter specifies the number of gigabytes into
the output handle where the data can should be
written. This value, plus the value specified on
<code class="literal">offset_bytes</code>, indicates the
offset within the output handle where the backup
should begin.
</p>
</li>
<li>
<p>
<code class="literal">offset_bytes</code>
</p>
<p>
The <span class="bold"><strong>offset_bytes</strong></span>
parameter specifies the number of bytes into the
output handle where the data can be located. This
value, plus the value specified on
<code class="literal">offset_gbytes</code>, indicates the
offset within the output handle where the backup
should begin.
</p>
</li>
<li>
<p>
<code class="literal">size</code>
</p>
<p>
The <span class="bold"><strong>size</strong></span>
parameter specifies the number of bytes to back up
from the buffer.
</p>
</li>
<li>
<p>
<code class="literal">buf</code>
</p>
<p>
The <span class="bold"><strong>buf</strong></span>
parameter is the buffer which contains the data to
be backed up.
</p>
</li>
<li>
<p>
<code class="literal">handle</code>
</p>
<p>
The <span class="bold"><strong>handle</strong></span>
parameter references the handle (usually a file
handle) to which the backup will be written.
</p>
</li>
</ul>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp7142656"></a>close_func</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>close_func</strong></span> parameter
is the function used when ending a backup and closing a
backup target. The function takes three parameters:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">dbenv</code>
</p>
<p>
The <span class="bold"><strong>dbenv</strong></span>
parameter is the enclosing database environment
handle.
</p>
</li>
<li>
<p>
<code class="literal">dbname</code>
</p>
<p>
The <span class="bold"><strong>dbname</strong></span> parameter is the
name of the database that has now been backed up.
</p>
</li>
<li>
<p>
<code class="literal">handle</code>
</p>
<p>
The <span class="bold"><strong>handle</strong></span>
parameter references the handle (usually a file
handle) to which the backup was written, and which
now must be closed or otherwise discarded.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp7182008"></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="idp7171648"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a>,
<a class="xref" href="envget_backup_callbacks.html" title="DbEnv::get_backup_callbacks()">DbEnv::get_backup_callbacks()</a>,
<a class="xref" href="envbackup.html" title="DbEnv::backup()">DbEnv::backup()</a>, and
<a class="xref" href="envdbbackup.html" title="DbEnv::dbbackup()">DbEnv::dbbackup()</a>.
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="envset_app_dispatch.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="env.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envset_backup_config.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::set_app_dispatch() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::set_backup_config()</td>
</tr>
</table>
</div>
</body>
</html>
|
