File: set_func_map.html

package info (click to toggle)
evolution-data-server 1.0.4-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 39,504 kB
  • ctags: 26,423
  • sloc: ansic: 175,347; tcl: 30,499; sh: 20,699; perl: 11,320; xml: 9,039; java: 7,653; cpp: 6,029; makefile: 4,866; awk: 1,338; yacc: 1,103; sed: 772; cs: 505; lex: 134; asm: 14
file content (76 lines) | stat: -rw-r--r-- 4,019 bytes parent folder | download | duplicates (3)
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: set_func_map.html,v 1.1.1.1 2003/11/20 22:14:27 toshok Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: db_env_set_func_map</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 width="100%"><tr valign=top>
<td>
<h1>db_env_set_func_map</h1>
</td>
<td align=right>
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include &lt;db.h&gt;
<p>
int
db_env_set_func_map(int (*func_map)(char *path,
    size_t len, int is_region, int is_rdonly, void **addr));
</pre></h3>
<h1>Description</h1>
<p>The Berkeley DB library requires the ability to map a file into memory and to
create shared memory regions (which may or may not be backed by files).
The <b>func_map</b> argument must conform to the following interface:
<p><blockquote><pre>int map(char *path, size_t len,
int is_region, int is_rdonly, void **addr);</pre></blockquote>
<p>The <b>path</b> argument is the name of a file.
<p>The <b>is_region</b> argument will be zero if the intention is to map
a file into shared memory.  In this case, the <b>map</b> function must
map the first <b>len</b> bytes of the file into memory and return a
pointer to the mapped location into the memory location to which the
argument <b>addr</b> refers.  The <b>is_rdonly</b> argument will be
non-zero if the file is considered read-only by the caller.
<p>The <b>is_region</b> argument will be non-zero if the memory is
intended to be used as a shared memory region for synchronization
between Berkeley DB threads/processes.  In this case, the returned memory may
be of any kind (for example, anonymous memory), but must be able to
support semaphores.  In this case, the <b>path</b> argument may be
ignored (although future <b>map</b> calls using the same <b>path</b>
must return the same memory), and the <b>is_rdonly</b> argument will
always be zero.
<p>The <b>func_map</b> interface must return the value of <b>errno</b> on
failure and 0 on success.
<p>The db_env_set_func_map method configures all operations performed by a process and
all of its threads of control, not operations confined to a single
database environment.
<p>Although the db_env_set_func_map interface may be called at any time during the
life of the application, it should normally be called before making
calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> methods.
<p>The db_env_set_func_map method returns a non-zero error value on failure and 0 on success.
<h1>Errors</h1>
<p>The db_env_set_func_map method may fail and 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 db_env_set_func_map method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the db_env_set_func_map method may fail and
return <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.
<h1>See Also</h1>
<a href="../ref/program/runtime.html">Run-time configuration</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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>