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
|
<!--$Id: memp_fset.so,v 10.18 2000/03/01 21:41:30 bostic Exp $-->
<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<html>
<head>
<title>Berkeley DB: DbMpoolFile::set</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table><tr valign=top>
<td>
<h1>DbMpoolFile::set</h1>
</td>
<td width="1%">
<a href="../api_cxx/cxx_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db_cxx.h>
<p>
int
DbMpoolFile::set(void *pgaddr, u_int32_t flags);
</pre></h3>
<h1>Description</h1>
<p>The DbMpoolFile::set method sets the flags associated with the page referenced
by <b>pgaddr</b> without unpinning it from the pool. The <b>pgaddr</b>
argument must be an address previously returned by <a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>.
<p>The <b>flags</b> value must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one or more
of the following values.
<p><dl compact>
<p><dt><a name="DB_MPOOL_CLEAN">DB_MPOOL_CLEAN</a><dd>Clear any previously set modification information (i.e., don't bother
writing the page back to the source file).
<p><dt><a name="DB_MPOOL_DIRTY">DB_MPOOL_DIRTY</a><dd>The page has been modified and must be written to the source file
before being evicted from the pool.
<p><dt><a name="DB_MPOOL_DISCARD">DB_MPOOL_DISCARD</a><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::set 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.
<h1>Errors</h1>
<p>The DbMpoolFile::set method may fail and throw an exception or return a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
</dl>
<p>The DbMpoolFile::set method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods.
If a catastrophic error has occurred, the DbMpoolFile::set method may fail and either
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating
<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail
in the same way.
<h3>Classes</h3>
<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a>
<h1>See Also</h1>
<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>,
<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>,
<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>,
<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>,
<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>,
<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>,
<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>,
<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>,
<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>,
<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>
and
<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>.
</tt>
<table><tr><td><br></td><td width="1%">
<a href="../api_cxx/cxx_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>
|
