← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_c/env_set_shm_key.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdb/docs/api_c/env_set_shm_key.html
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: DB_ENV-&gt;set_shm_key</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>DB_ENV-&gt;set_shm_key</h1>
16
 
</td>
17
 
<td align=right>
18
 
<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>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
#include &lt;db.h&gt;
24
 
<p>
25
 
int
26
 
DB_ENV-&gt;set_shm_key(DB_ENV *dbenv, long shm_key);
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>Specify a base segment ID for Berkeley DB environment shared memory regions
30
 
created in system memory on VxWorks or systems supporting X/Open-style
31
 
shared memory interfaces; for example, UNIX systems supporting
32
 
<b>shmget</b>(2) and related System V IPC interfaces.
33
 
<p>This base segment ID will be used when Berkeley DB shared memory regions are
34
 
first created.  It will be incremented a small integer value each time
35
 
a new shared memory region is created; that is, if the base ID is 35,
36
 
the first shared memory region created will have a segment ID of 35,
37
 
and the next one will have a segment ID between 36 and 40 or so.  A
38
 
Berkeley DB environment always creates a master shared memory region; an
39
 
additional shared memory region for each of the subsystems supported by
40
 
the environment (Locking, Logging, Memory Pool and Transaction); plus
41
 
an additional shared memory region for each additional memory pool cache
42
 
that is supported.  Already existing regions with the same segment IDs
43
 
will be removed.  See <a href="../ref/env/region.html">Shared Memory
44
 
Regions</a> for more information.
45
 
<p>The intent behind this interface is two-fold: without it, applications
46
 
have no way to ensure that two Berkeley DB applications don't attempt to use
47
 
the same segment IDs when creating different Berkeley DB environments.  In
48
 
addition, by using the same segment IDs each time the environment is
49
 
created, previously created segments will be removed, and the set of
50
 
segments on the system will not grow without bound.
51
 
<p>The DB_ENV-&gt;set_shm_key method configures operations performed using the specified
52
 
<a href="../api_c/env_class.html">DB_ENV</a> handle, not all operations performed on the underlying
53
 
database environment.
54
 
<p>The DB_ENV-&gt;set_shm_key interface may not be called after the <a href="../api_c/env_open.html">DB_ENV-&gt;open</a>
55
 
interface is called.
56
 
If the database environment already exists when
57
 
<a href="../api_c/env_open.html">DB_ENV-&gt;open</a> is called, the information specified to DB_ENV-&gt;set_shm_key
58
 
must be consistent with the existing environment or corruption can
59
 
occur.
60
 
<p>The DB_ENV-&gt;set_shm_key method returns a non-zero error value on failure and 0 on success.
61
 
<p>The database environment's base segment ID may also be set using the environment's
62
 
<b>DB_CONFIG</b> file.  The syntax of the entry in that file is a
63
 
single line with the string "set_shm_key", one or more whitespace characters,
64
 
and the ID.  Because the <b>DB_CONFIG</b> file is read when the database
65
 
environment is opened, it will silently overrule configuration done
66
 
before that time.
67
 
<h1>Errors</h1>
68
 
<p>The DB_ENV-&gt;set_shm_key method may fail and return a non-zero error for the following conditions:
69
 
<p><dl compact>
70
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
71
 
<p>Called after <a href="../api_c/env_open.html">DB_ENV-&gt;open</a> was called.
72
 
</dl>
73
 
<p>The DB_ENV-&gt;set_shm_key method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
74
 
If a catastrophic error has occurred, the DB_ENV-&gt;set_shm_key method may fail and
75
 
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
76
 
in which case all subsequent Berkeley DB calls will fail in the same way.
77
 
<h1>Class</h1>
78
 
<a href="../api_c/env_class.html">DB_ENV</a>
79
 
<h1>See Also</h1>
80
 
<a href="../api_c/env_list.html">Database Environments and Related Methods</a>
81
 
</tt>
82
 
<table width="100%"><tr><td><br></td><td align=right>
83
 
<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>
84
 
</td></tr></table>
85
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
86
 
</body>
87
 
</html>