env_set_lk_conflicts.html [plain text]
<!--$Id: env_set_lk_conflicts.so,v 10.43 2004/09/28 15:04:20 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv::set_lk_conflicts</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<b>DbEnv::set_lk_conflicts</b>
</td>
<td align=right>
<a href="../api_cxx/api_core.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>
<b><pre>
#include <db_cxx.h>
<p>
int
DbEnv::set_lk_conflicts(u_int8_t *conflicts, int nmodes);
<p>
int
DbEnv::get_lk_conflicts(const u_int8_t **lk_conflictsp, int *lk_modesp);
</pre></b>
<hr size=1 noshade>
<b>Description: DbEnv::set_lk_conflicts</b>
<p>Set the locking conflicts matrix.</p>
<p>If DbEnv::set_lk_conflicts is never called, a standard conflicts
array is used; see <a href="../ref/lock/stdmode.html">Standard Lock
Modes</a> for more information.</p>
<p>The DbEnv::set_lk_conflicts method configures a database environment, not only operations
performed using the specified <a href="../api_cxx/env_class.html">DbEnv</a> handle.</p>
<p>The DbEnv::set_lk_conflicts method may not be called after the <a href="../api_cxx/env_open.html">DbEnv::open</a> method is
called.
If the database environment already exists when
<a href="../api_cxx/env_open.html">DbEnv::open</a> is called, the information specified to DbEnv::set_lk_conflicts
will be ignored.
</p>
<p>The DbEnv::set_lk_conflicts 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.
</p>
<b>Parameters</b> <br>
<b>conflicts</b><ul compact><li>The <b>conflicts</b> parameter is the new locking conflicts matrix.
The <b>conflicts</b> parameter is an <b>nmodes</b> by <b>nmodes</b>
array. A non-0 value for the array element indicates that
requested_mode and held_mode conflict:
<blockquote><pre>conflicts[requested_mode][held_mode]</pre></blockquote>
<p>The <i>not-granted</i> mode must be represented by 0.</p></ul>
<b>nmodes</b><ul compact><li>The <b>nmodes</b> parameter is the size of the lock conflicts matrix.</ul>
<br>
<br><b>Errors</b>
<p>The DbEnv::set_lk_conflicts method
may fail and throw
<a href="../api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:</p>
<br>
<b>EINVAL</b><ul compact><li>If the method was called after <a href="../api_cxx/env_open.html">DbEnv::open</a> was called; or if an
invalid flag value or parameter was specified.</ul>
<br>
<p>If the conflicts array could not be copied, the DbEnv::set_lk_conflicts method will fail and
either return ENOMEM or
throw a DbMemoryException.</p>
<hr size=1 noshade>
<b>Description: dbenv_get_lk_conflicts</b>
<p>The DbEnv::get_lk_conflicts method returns the current conflicts array.</p>
<p>The DbEnv::get_lk_conflicts method may be called at any time during the life of the
application.</p>
<p>The DbEnv::get_lk_conflicts 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.
</p>
<b>Parameters</b> <br>
<b>lk_conflictsp</b><ul compact><li>The <b>lk_conflictsp</b> parameter references memory into which
a pointer to the current conflicts array is copied.</ul>
<b>lk_modesp</b><ul compact><li>The <b>lk_modesp</b> parameter references memory into which
the size of the current conflicts array is copied.</ul>
<br>
<hr size=1 noshade>
<br><b>Class</b>
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a>
<br><b>See Also</b>
<a href="../api_cxx/lock_list.html">Locking Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/api_core.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>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
</body>
</html>