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
|
<! "@(#)close.so 10.8 (Sleepycat) 9/29/98">
<!Copyright 1997, 1998 by Sleepycat Software, Inc. All rights reserved.>
<html>
<body bgcolor=white>
<head>
<title>Berkeley DB: DbMpool::close</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btr
ee,hash,hashing,transaction,transactions,locking,logging,access method,access me
thods,java,C,C++">
</head>
<h1>DbMpool::close</h1>
<hr size=1 noshade>
<tt>
<h3>
<pre>
#include <db_cxx.h>
<p>
int
DbMpool::close();
</pre>
</h3>
<h1>Description</h1>
<p>
The DbMpool::close method closes the memory pool.
<p>
Calling DbMpool::close does not imply a call to <a href="../../api_cxx/DbMpoolFile/sync.html">DbMpoolFile::sync</a>,
but does imply a call to <a href="../../api_cxx/DbMpoolFile/close.html">DbMpoolFile::close</a> for any remaining open
files in the pool returned to this process by calls to <a href="../../api_cxx/DbMpoolFile/open.html">DbMpoolFile::open</a>.
<p>
In addition, if the <b>dir</b> argument to <a href="../../api_cxx/DbMpool/open.html">DbMpool::open</a> was NULL and
<b>dbenv</b> was not initialized using <a href="../../api_cxx/DbEnv/appinit.html">DbEnv::appinit</a>,
or the DB_MPOOL_PRIVATE flag was set,
all files created for this shared region will be removed, as if
the <a href="../../api_cxx/DbMpool/unlink.html">DbMpool::unlink</a> method were called.
<p>
In multi-threaded applications, only a single thread may call the
DbMpool::close method.
<p>
The DbMpool::close
method either returns <b>errno</b> or throws an exception that
encapsulates an <b>errno</b> on failure, and 0 on success.
<p>
<h1>Errors</h1>
If a fatal error occurs in Berkeley DB, the DbMpool::close method may fail and either
return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY,
at which point all subsequent database calls will also fail in the same
way. Methods marked as returning <b>errno</b> will, by default, throw
an exception that encapsulates the error information. The default error
behavior can be changed, see <a href="../../api_cxx/DbException/class.html">DbException</a>.
<p>
The DbMpool::close
method may fail and throw an exception
for any of the errors specified for the following Berkeley DB and C library
functions:
abort(3),
close(3),
fcntl(3),
fflush(3),
fprintf(3),
free(3),
getpid(3),
<a href="../../api_cxx/DbMpoolFile/close.html">DbMpoolFile::close</a>,
memset(3),
munmap(3),
shmctl(3),
shmdt(3),
strlen(3),
unlink(3),
vfprintf(3),
and
vsnprintf(3).
<p>
<h1>Class</h1>
<a href="../../api_cxx/DbMpool/class.html">DbMpool</a>
<p>
<h1>See Also</h1>
DbMpool::close,
<a href="../../api_cxx/DbMpool/open.html">DbMpool::open</a>,
<a href="../../api_cxx/DbMpool/db_register.html">DbMpool::db_register</a>,
<a href="../../api_cxx/DbMpool/stat.html">DbMpool::stat</a>,
<a href="../../api_cxx/DbMpool/sync.html">DbMpool::sync</a>,
<a href="../../api_cxx/DbMpool/trickle.html">DbMpool::trickle</a>
and
<a href="../../api_cxx/DbMpool/unlink.html">DbMpool::unlink</a>.
</tt>
</body>
</html>
|
