libdb/docs/api_reference/CXX/envset_lk_conflicts.html

207 lines
8.3 KiB
HTML
Raw Normal View History

2011-09-13 17:44:24 +00:00
<?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>DbEnv::set_lk_conflicts()</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++ API Reference" />
<link rel="up" href="lock.html" title="Chapter 7.  The DbLock Handle" />
<link rel="prev" href="envget_lk_tablesize.html" title="DbEnv::get_lk_tablesize()" />
<link rel="next" href="envset_lk_detect.html" title="DbEnv::set_lk_detect()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::set_lk_conflicts()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envget_lk_tablesize.html">Prev</a> </td>
<th width="60%" align="center">Chapter 7. 
The DbLock Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envset_lk_detect.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="envset_lk_conflicts"></a>DbEnv::set_lk_conflicts()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
int
DbEnv::set_lk_conflicts(u_int8_t *conflicts, int nmodes); </pre>
<p>
Set the locking conflicts matrix.
</p>
<p>
If <code class="methodname">DbEnv::set_lk_conflicts()</code> is never called, a standard conflicts
array is used; see <a href="../../programmer_reference/lock_stdmode.html" class="olink">Standard Lock Modes</a> for more information.
</p>
<p>
The <code class="methodname">DbEnv::set_lk_conflicts()</code> method configures a database
environment, not only operations performed using the specified
<a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a> handle.
</p>
<p>
The <code class="methodname">DbEnv::set_lk_conflicts()</code> method may not be called after the
<a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> method is
called. If the database environment already exists when
<a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> is called, the
information specified to <code class="methodname">DbEnv::set_lk_conflicts()</code> will be ignored.
</p>
<p>
The <code class="methodname">DbEnv::set_lk_conflicts()</code> <span>
<span>
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.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3631518"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3631507"></a>conflicts</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>conflicts</strong></span> parameter is the new
locking conflicts matrix. The <span class="bold"><strong>conflicts</strong></span>
parameter is an <span class="bold"><strong>nmodes</strong></span> by
<span class="bold"><strong>nmodes</strong></span> array. A non-0 value for the array
element indicates that requested_mode and held_mode conflict:
</p>
<pre class="programlisting"> conflicts[requested_mode][held_mode] </pre>
<p>
The <span class="emphasis"><em>not-granted</em></span> mode must be represented by 0.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3631097"></a>nmodes</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>nmodes</strong></span> parameter is the size of
the lock conflicts matrix.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3631317"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbEnv::set_lk_conflicts()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3631570"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If the method was called after <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a>
was called; or if an invalid flag value or parameter was specified.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3631691"></a>ENOMEM</h4>
</div>
</div>
</div>
<p>
The conflicts array could not be copied.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3631632"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>,
<a class="link" href="lock.html" title="Chapter 7.  The DbLock Handle">DbLock</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3631521"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="lock.html#locklist" title="Locking Subsystem and Related Methods">Locking Subsystem and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="envget_lk_tablesize.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="lock.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envset_lk_detect.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::get_lk_tablesize() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::set_lk_detect()</td>
</tr>
</table>
</div>
</body>
</html>