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
|
<?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>open_env</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++ Standard Template Library API Reference" />
<link rel="up" href="dbstl_global_functions.html" title="Chapter 1. Dbstl Global Public Functions" />
<link rel="prev" href="stldbstl_global_functionsopen_db.html" title="open_db" />
<link rel="next" href="stldbstl_global_functionsalloc_mutex.html" title="alloc_mutex" />
</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">open_env</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="stldbstl_global_functionsopen_db.html">Prev</a> </td>
<th width="60%" align="center">Chapter 1.
Dbstl Global Public Functions </th>
<td width="20%" align="right"> <a accesskey="n" href="stldbstl_global_functionsalloc_mutex.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="stldbstl_global_functionsopen_env"></a>open_env</h2>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="stldbstl_global_functionsopen_env_details"></a>Function Details</h3>
</div>
</div>
</div>
<pre class="programlisting">
DbEnv* open_env(const char *env_home, u_int32_t set_flags,
u_int32_t oflags=DB_CREATE|DB_INIT_MPOOL,
u_int32_t cachesize=4 *1024 *1024, int mode=0644,
u_int32_t cflags=0)
</pre>
<p>Helper function to open an environment and register it into dbstl for the calling thread. </p>
<p>Users still need to register it in any other thread if it is shared by multiple threads, via <a class="link" href="stldbstl_global_functionsregister_db_env.html" title="register_db_env">register_db_env()</a>
function above. Users don't need to delete or free the memory of the returned object, dbstl will take care of that.</p>
<p>When you don't use <a class="link" href="stldbstl_global_functionsopen_env.html" title="open_env">dbstl::open_env()</a>
but explicitly call DB C++ API to open an environment, you must new the DbEnv object, rather than create it on stack, and you must delete the DbEnv object by yourself. </p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp49957960"></a>Parameters</h4>
</div>
</div>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h5 class="title"><a id="idp49958152"></a>oflags</h5>
</div>
</div>
</div>
<p>Environment open flags, passed to DbEnv::open. </p>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h5 class="title"><a id="idp49960032"></a>set_flags</h5>
</div>
</div>
</div>
<p>Flags to set to the created environment before opening it. </p>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h5 class="title"><a id="idp49960416"></a>mode</h5>
</div>
</div>
</div>
<p>Environment region files mode, passed to DbEnv::open. </p>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h5 class="title"><a id="idp49960800"></a>cflags</h5>
</div>
</div>
</div>
<p>DbEnv constructor creation flags, passed to DbEnv::DbEnv. </p>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h5 class="title"><a id="idp49961184"></a>cachesize</h5>
</div>
</div>
</div>
<p>Environment cache size, by default 4M bytes. </p>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h5 class="title"><a id="idp49961504"></a>env_home</h5>
</div>
</div>
</div>
<p>Environment home directory, it must exist. Passed to DbEnv::open. </p>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp49955976"></a>Return Value</h4>
</div>
</div>
</div>
<p>The opened database environment handle. </p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp49961896"></a>See Also</h4>
</div>
</div>
</div>
<p>
</p>
<p><a class="link" href="stldbstl_global_functionsregister_db_env.html" title="register_db_env">register_db_env(DbEnv *)</a>
; </p>
<p>
</p>
<p><a class="link" href="stldbstl_global_functionsopen_db.html" title="open_db">open_db</a>
; </p>
<p>
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp49935920"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="dbstl_global_functions.html" title="Chapter 1. Dbstl Global Public Functions">dbstl_global_functions</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="stldbstl_global_functionsopen_db.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="dbstl_global_functions.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="stldbstl_global_functionsalloc_mutex.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">open_db </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> alloc_mutex</td>
</tr>
</table>
</div>
</body>
</html>
|
