← 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_java/lock_vec.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_java/lock_vec.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: DbEnv.lock_vec</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>DbEnv.lock_vec</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_java/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
 
import com.sleepycat.db.*;
24
 
<p>
25
 
public void lock_vec(int locker, int flags, DbLockRequest[] list,
26
 
    int offset, int count)
27
 
    throws DbException
28
 
</pre></h3>
29
 
<h1>Description</h1>
30
 
<p>The DbEnv.lock_vec method atomically obtains and releases one or more locks
31
 
from the lock table.  The DbEnv.lock_vec method is intended to support
32
 
acquisition or trading of multiple locks under one lock table semaphore,
33
 
as is needed for lock coupling or in multigranularity locking for lock
34
 
escalation.
35
 
<p>The <b>locker</b> argument specified to DbEnv.lock_vec is an unsigned
36
 
32-bit integer quantity.  It represents the entity requesting or releasing
37
 
the locks.
38
 
<p>The <b>flags</b> value must be set to 0 or
39
 
the following value:
40
 
<p><dl compact>
41
 
<p><dt><a name="Db.DB_LOCK_NOWAIT">Db.DB_LOCK_NOWAIT</a><dd>If a lock cannot be granted because the requested lock conflicts with
42
 
an existing lock,
43
 
throw a <a href="../api_java/lockng_class.html">DbLockNotGrantedException</a> immediately instead of waiting
44
 
for the lock to become available. In this case, the index of the request
45
 
that was not granted can be found by calling
46
 
DbLockNotGrantedException.get_index.
47
 
</dl>
48
 
<p>The <b>list</b> array provided to DbEnv.lock_vec is a set of
49
 
DbLockRequest objects. Only <b>count</b> elements of <b>list</b>
50
 
starting at <b>offset</b> are considered by DbEnv.lock_vec.
51
 
A DbLockRequest object has at least the following fields.
52
 
For each field there is a corresponding get_ and set_ method
53
 
<p><dl compact>
54
 
<p><dt>int <a name="op">op</a>;<dd>The operation to be performed, which must be set to one of the
55
 
following values:
56
 
<p><dl compact>
57
 
<p><dt><a name="Db.DB_LOCK_GET">Db.DB_LOCK_GET</a><dd>Get the lock defined by the values of the <b>mode</b> and <b>obj</b>
58
 
structure fields, for the specified <b>locker</b>.  Upon return from
59
 
DbEnv.lock_vec, if the <b>lock</b> field is non-null, a reference
60
 
to the acquired lock is stored there.  (This reference is invalidated
61
 
by any call to DbEnv.lock_vec or <a href="../api_java/lock_put.html">DbEnv.lock_put</a> that releases the
62
 
lock.)
63
 
<p><dt><a name="Db.DB_LOCK_GET_TIMEOUT">Db.DB_LOCK_GET_TIMEOUT</a><dd>Identical to Db.DB_LOCK_GET except that the value in the <b>timeout</b>
64
 
structure field overrides any previously specified timeout value for
65
 
this lock.  A value of 0 turns off any previously specified timeout.
66
 
<p><dt><a name="Db.DB_LOCK_PUT">Db.DB_LOCK_PUT</a><dd>The lock to which the <b>lock</b> structure field refers is released.
67
 
The <b>locker</b> argument, and <b>mode</b> and <b>obj</b> fields
68
 
are ignored.
69
 
<p><dt><a name="Db.DB_LOCK_PUT_ALL">Db.DB_LOCK_PUT_ALL</a><dd>All locks held by the specified <b>locker</b> are released.  The
70
 
<b>lock</b>, <b>mode</b>, and <b>obj</b> structure fields are
71
 
ignored.  Locks acquired in operations performed by the current call to
72
 
DbEnv.lock_vec which appear before the Db.DB_LOCK_PUT_ALL
73
 
operation are released; those acquired in operations appearing after
74
 
the Db.DB_LOCK_PUT_ALL operation are not released.
75
 
<p><dt><a name="Db.DB_LOCK_PUT_OBJ">Db.DB_LOCK_PUT_OBJ</a><dd>All locks held on the object <b>obj</b> are released.  The
76
 
<b>locker</b> argument and the <b>lock</b> and <b>mode</b> structure
77
 
fields are ignored.  Locks acquired in operations performed by the
78
 
current call to DbEnv.lock_vec that appear before the
79
 
Db.DB_LOCK_PUT_OBJ operation are released; those acquired in
80
 
operations appearing after the Db.DB_LOCK_PUT_OBJ operation are
81
 
not released.
82
 
<p><dt><a name="Db.DB_LOCK_TIMEOUT">Db.DB_LOCK_TIMEOUT</a><dd>Cause the specified <b>locker</b> to timeout immediately.  If the
83
 
database environment has not configured automatic deadlock detection,
84
 
the transaction will timeout the next time deadlock detection is
85
 
performed.  As transactions acquire locks on behalf of a single locker
86
 
ID, timing out the locker ID associated with a transaction will time
87
 
out the transaction itself.
88
 
</dl>
89
 
<p><dt>DbLock <a name="lock">lock</a>;<dd>A lock reference.
90
 
<p><dt>int <a name="mode">mode</a>;<dd>The lock mode, used as an index into the environment's lock conflict matrix.
91
 
When using the default lock conflict matrix, <b>mode</b> must be set to one
92
 
of the following values:
93
 
<p><dl compact>
94
 
<dt><a name="Db.DB_LOCK_READ">Db.DB_LOCK_READ</a><dd>read (shared)
95
 
<dt><a name="Db.DB_LOCK_WRITE">Db.DB_LOCK_WRITE</a><dd>write (exclusive)
96
 
<dt><a name="Db.DB_LOCK_IWRITE">Db.DB_LOCK_IWRITE</a><dd>intention to write (shared)
97
 
<dt><a name="Db.DB_LOCK_IREAD">Db.DB_LOCK_IREAD</a><dd>intention to read (shared)
98
 
<dt><a name="Db.DB_LOCK_IWR">Db.DB_LOCK_IWR</a><dd>intention to read and write (shared)
99
 
</dl>
100
 
<p>See <a href="../api_java/env_set_lk_conflicts.html">DbEnv.set_lk_conflicts</a> and <a href="../ref/lock/stdmode.html">Standard Lock Modes</a> for more information on the lock conflict matrix.
101
 
<p><dt>Dbt <a name="obj">obj</a>;<dd>An untyped byte string that specifies the object to be locked or
102
 
released.  Applications using the locking subsystem directly while also
103
 
doing locking via the Berkeley DB access methods must take care not to
104
 
inadvertently lock objects that happen to be equal to the unique file
105
 
IDs used to lock files.  See <a href="../ref/lock/am_conv.html">Access
106
 
method locking conventions</a> for more information.
107
 
<p><dt>int timeout;<dd>The lock timeout value.
108
 
</dl>
109
 
<p>If any of the requested locks cannot be acquired, or any of the locks to
110
 
be released cannot be released, the operations before the failing
111
 
operation are guaranteed to have completed successfully, and
112
 
DbEnv.lock_vec throws an exception
113
 
<p>
114
 
Otherwise, the DbEnv.lock_vec method throws an exception that encapsulates a non-zero error value on
115
 
failure.
116
 
<h1>Errors</h1>
117
 
<p>The DbEnv.lock_vec method may fail and throw an exception encapsulating a non-zero error for the following conditions:
118
 
<p><dl compact>
119
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
120
 
</dl>
121
 
<p><dl compact>
122
 
<p><dt>ENOMEM<dd>The maximum number of locks has been reached.
123
 
</dl>
124
 
<p>If the operation was selected to resolve a deadlock, the
125
 
DbEnv.lock_vec method will fail and
126
 
throw a <a href="../api_java/deadlock_class.html">DbDeadlockException</a> exception.
127
 
<p>The DbEnv.lock_vec method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
128
 
If a catastrophic error has occurred, the DbEnv.lock_vec method may fail and
129
 
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
130
 
in which case all subsequent Berkeley DB calls will fail in the same way.
131
 
<h1>Class</h1>
132
 
<a href="../api_java/env_class.html">DbEnv</a>, <a href="../api_java/lock_class.html">DbLock</a>
133
 
<h1>See Also</h1>
134
 
<a href="../api_java/lock_list.html">Locking Subsystem and Related Methods</a>
135
 
</tt>
136
 
<table width="100%"><tr><td><br></td><td align=right>
137
 
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
138
 
</td></tr></table>
139
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
140
 
</body>
141
 
</html>