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
|
<! "@(#)put.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: DbMpoolFile::put</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>DbMpoolFile::put</h1>
<hr size=1 noshade>
<tt>
<h3>
<pre>
#include <db_cxx.h>
<p>
int
DbMpoolFile::put(void *pgaddr, u_int32_t flags);
</pre>
</h3>
<h1>Description</h1>
<p>
The DbMpoolFile::put method indicates that the page referenced by
<b>pgaddr</b> can be evicted from the pool. The <b>pgaddr</b>
argument must be an address previously returned by <a href="../../api_cxx/DbMpoolFile/get.html">DbMpoolFile::get</a>.
<p>
The <b>flags</b> argument is specified by logically <b>OR</b>'ing together one or more
of the following values:
<dl compact>
<a name="DB_MPOOL_CLEAN">
<p><dt>DB_MPOOL_CLEAN<dd>Clear any previously set modification information (i.e., don't bother
writing the page back to the source file).
<a name="DB_MPOOL_DIRTY">
<p><dt>DB_MPOOL_DIRTY<dd>The page has been modified and must be written to the source file
before being evicted from the pool.
<a name="DB_MPOOL_DISCARD">
<p><dt>DB_MPOOL_DISCARD<dd>The page is unlikely to be useful in the near future,
and should be discarded before other pages in the pool.
</dl>
<p>
The DB_MPOOL_CLEAN and DB_MPOOL_DIRTY flags are
mutually exclusive.
<p>
The DbMpoolFile::put
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 DbMpoolFile::put 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 DbMpoolFile::put
method may fail and throw an exception
for any of the errors specified for the following Berkeley DB and C library
functions:
DBmemp->pgin(3),
DBmemp->pgout(3),
abort(3),
close(3),
dbenv->db_paniccall(3),
fcntl(3),
fflush(3),
fprintf(3),
free(3),
fstat(3),
fsync(3),
getenv(3),
getpid(3),
getuid(3),
isdigit(3),
<a href="../../api_cxx/DbLog/compare.html">DbLog::compare</a>,
<a href="../../api_cxx/DbLog/flush.html">DbLog::flush</a>,
lseek(3),
malloc(3),
memcmp(3),
memcpy(3),
memset(3),
mmap(3),
open(3),
pread(3),
pstat_getdynamic(3),
pwrite(3),
read(3),
sigfillset(3),
sigprocmask(3),
stat(3),
strerror(3),
strlen(3),
sysconf(3),
time(3),
unlink(3),
vfprintf(3),
vsnprintf(3),
and
write(3).
<p>
In addition, the DbMpoolFile::put
method may fail and throw an exception
or return <b>errno</b>
for the following conditions:
<dl compact>
<p><dt>EACCES<dd>The DB_MPOOL_DIRTY flag was set and the source file was not opened for
writing.
</dl>
<dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>
The <b>pgaddr</b> parameter does not reference a page returned by
<a href="../../api_cxx/DbMpoolFile/get.html">DbMpoolFile::get</a>.
<p>
More than one of DB_MPOOL_CLEAN and DB_MPOOL_DIRTY flags was set.
</dl>
<p>
<h1>Class</h1>
<a href="../../api_cxx/DbMpoolFile/class.html">DbMpoolFile</a>
<p>
<h1>See Also</h1>
<a href="../../api_cxx/DbMpoolFile/close.html">DbMpoolFile::close</a>,
<a href="../../api_cxx/DbMpoolFile/get.html">DbMpoolFile::get</a>,
<a href="../../api_cxx/DbMpoolFile/open.html">DbMpoolFile::open</a>,
DbMpoolFile::put,
<a href="../../api_cxx/DbMpoolFile/set.html">DbMpoolFile::set</a>
and
<a href="../../api_cxx/DbMpoolFile/sync.html">DbMpoolFile::sync</a>.
</tt>
</body>
</html>
|
