diff options
Diffstat (limited to 'docs/api_reference/CXX/mempfget.html')
| -rw-r--r-- | docs/api_reference/CXX/mempfget.html | 229 |
1 files changed, 116 insertions, 113 deletions
diff --git a/docs/api_reference/CXX/mempfget.html b/docs/api_reference/CXX/mempfget.html index 32d55856..dc38c14e 100644 --- a/docs/api_reference/CXX/mempfget.html +++ b/docs/api_reference/CXX/mempfget.html @@ -14,7 +14,7 @@ <body> <div xmlns="" class="navheader"> <div class="libver"> - <p>Library Version 11.2.5.3</p> + <p>Library Version 12.1.6.1</p> </div> <table width="100%" summary="Navigation header"> <tr> @@ -50,8 +50,9 @@ DbMpoolFile::get(db_pgno_t *pgnoaddr, All pages returned by <code class="methodname">DbMpoolFile::get()</code> will be retained (that is, <span class="emphasis"><em>latched</em></span>) in the cache until a subsequent call to <a class="xref" href="mempput.html" title="DbMpoolFile::put()">DbMpoolFile::put()</a>. - There is no deadlock detection among latches so care must be taken in the application if the DB_MPOOL_DIRTY - or DB_MPOOL_EDIT flags are used as these get exlusive latches on the pages. + There is no deadlock detection among latches so care must be taken + in the application if the DB_MPOOL_DIRTY or DB_MPOOL_EDIT flags are + used as these get exclusive latches on the pages. </p> <p> The returned page is <span class="bold"><strong>size_t</strong></span> type @@ -81,7 +82,7 @@ DbMpoolFile::get(db_pgno_t *pgnoaddr, <div class="titlepage"> <div> <div> - <h3 class="title"><a id="idp3518256"></a>Parameters</h3> + <h3 class="title"><a id="idp3526552"></a>Parameters</h3> </div> </div> </div> @@ -89,80 +90,82 @@ DbMpoolFile::get(db_pgno_t *pgnoaddr, <div class="titlepage"> <div> <div> - <h4 class="title"><a id="idp3517608"></a>flags</h4> + <h4 class="title"><a id="idp3525904"></a>flags</h4> </div> </div> </div> <p> - The <span class="bold"><strong>flags</strong></span> parameter must be set to 0 - or by bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing - together one or more of the following values: - </p> + The <span class="bold"><strong>flags</strong></span> parameter must be set to 0 + or by bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing + together one or more of the following values: + </p> <div class="itemizedlist"> <ul type="disc"> <li> <p><a id="mpoolfget_DB_MPOOL_CREATE"></a> - <code class="literal">DB_MPOOL_CREATE</code> - </p> + <code class="literal">DB_MPOOL_CREATE</code> + </p> <p> - If the specified page does not exist, create it. In this case, the - <a class="link" href="mempregister.html" title="DbEnv::memp_register()">pgin</a> method, if - specified, is called. - </p> + If the specified page does not exist, create it. In this case, the + <a class="link" href="mempregister.html" title="DbEnv::memp_register()">pgin</a> method, if + specified, is called. + </p> </li> <li> <p><a id="fget_DB_MPOOL_DIRTY"></a> - <code class="literal">DB_MPOOL_DIRTY</code> - </p> + <code class="literal">DB_MPOOL_DIRTY</code> + </p> <p> - The page will be modified and must be written to the source file - before being evicted from the cache. For files open with the - <a class="link" href="dbopen.html#dbopen_DB_MULTIVERSION">DB_MULTIVERSION</a> - flag set, a new copy of the page will be made if this is the first - time the specified transaction is modifying it. - A page fetched with the <code class="literal">DB_MPOOL_DIRTY</code> flag will be - <span class="bold"><strong>exclusively latched</strong></span> until - a subsequent call to <a class="xref" href="mempput.html" title="DbMpoolFile::put()">DbMpoolFile::put()</a>. - </p> + The page will be modified and must be written to the source file + before being evicted from the cache. For files open with the + <a class="link" href="dbopen.html#dbopen_DB_MULTIVERSION">DB_MULTIVERSION</a> + flag set, a new copy of the page will be made if this is the first + time the specified transaction is modifying it. + A page fetched with the <code class="literal">DB_MPOOL_DIRTY</code> + flag will be + <span class="bold"><strong>exclusively latched</strong></span> + until a subsequent call to + <a class="xref" href="mempput.html" title="DbMpoolFile::put()">DbMpoolFile::put()</a>. + </p> </li> <li> <p><a id="fget_DB_MPOOL_EDIT"></a> - <code class="literal">DB_MPOOL_EDIT</code> - </p> + <code class="literal">DB_MPOOL_EDIT</code> + </p> <p> - The page will be modified and must be written to the source file - before being evicted from the cache. No copy of the page will be made, - regardless of the - <a class="link" href="dbopen.html#dbopen_DB_MULTIVERSION">DB_MULTIVERSION</a> - setting. This flag is only intended for use in situations where a - transaction handle is not available, such as during aborts or - recovery. - A page fetched with the <code class="literal">DB_MPOOL_EDIT</code> flag will be - <span class="bold"><strong>exclusively latched</strong></span> until - a subsequent call to <a class="xref" href="mempput.html" title="DbMpoolFile::put()">DbMpoolFile::put()</a>. - </p> + The page will be modified and must be written to the source file + before being evicted from the cache. No copy of the page will be made, + regardless of the + <a class="link" href="dbopen.html#dbopen_DB_MULTIVERSION">DB_MULTIVERSION</a> + setting. This flag is only intended for use in situations where a + transaction handle is not available, such as during aborts or + recovery. + A page fetched with the <code class="literal">DB_MPOOL_EDIT</code> flag will be + <span class="bold"><strong>exclusively latched</strong></span> until + a subsequent call to <a class="xref" href="mempput.html" title="DbMpoolFile::put()">DbMpoolFile::put()</a>. + </p> </li> <li> <p><a id="fget_DB_MPOOL_LAST"></a> - <code class="literal">DB_MPOOL_LAST</code> - </p> + <code class="literal">DB_MPOOL_LAST</code> + </p> <p> - Return the last page of the source file, and copy its page number into - the memory location to which <span class="bold"><strong>pgnoaddr</strong></span> - refers. - </p> + Return the last page of the source file, and copy its page number into + the memory location to which <span class="bold"><strong>pgnoaddr</strong></span> + refers. + </p> </li> <li> <p><a id="mpoolfget_DB_MPOOL_NEW"></a> - <code class="literal">DB_MPOOL_NEW</code> - </p> + <code class="literal">DB_MPOOL_NEW</code> + </p> <p> - Create a new page in the file, and copy its page number into the - memory location to which <span class="bold"><strong>pgnoaddr</strong></span> - refers. In this case, the <code class="literal">pgin_fcn</code> callback, if specified on - <a class="xref" href="mempregister.html" title="DbEnv::memp_register()">DbEnv::memp_register()</a>, is - <span class="bold"><strong>not</strong></span> called. - </p> + Create a new page in the file, and copy its page number into the + memory location to which <span class="bold"><strong>pgnoaddr</strong></span> + refers. In this case, the <code class="literal">pgin_fcn</code> callback, if specified on + <a class="xref" href="mempregister.html" title="DbEnv::memp_register()">DbEnv::memp_register()</a>, is + <span class="bold"><strong>not</strong></span> called. + </p> </li> </ul> </div> @@ -175,71 +178,71 @@ DbMpoolFile::get(db_pgno_t *pgnoaddr, <div class="titlepage"> <div> <div> - <h4 class="title"><a id="idp3523736"></a>pagep</h4> + <h4 class="title"><a id="idp3532136"></a>pagep</h4> </div> </div> </div> <p> - The <span class="bold"><strong>pagep</strong></span> parameter references memory - into which a pointer to the returned page is copied. - </p> + The <span class="bold"><strong>pagep</strong></span> parameter references memory + into which a pointer to the returned page is copied. + </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> - <h4 class="title"><a id="idp3533784"></a>pgnoaddr</h4> + <h4 class="title"><a id="idp3541944"></a>pgnoaddr</h4> </div> </div> </div> <p> - If the <span class="bold"><strong>flags</strong></span> parameter is set to - <code class="literal">DB_MPOOL_LAST</code> or <code class="literal">DB_MPOOL_NEW</code>, the - page number of the created page is copied into the memory location to - which the <span class="bold"><strong>pgnoaddr</strong></span> parameter refers. - Otherwise, the <span class="bold"><strong>pgnoaddr</strong></span> parameter is the - page to create or retrieve. - </p> + If the <span class="bold"><strong>flags</strong></span> parameter is set to + <code class="literal">DB_MPOOL_LAST</code> or <code class="literal">DB_MPOOL_NEW</code>, the + page number of the created page is copied into the memory location to + which the <span class="bold"><strong>pgnoaddr</strong></span> parameter refers. + Otherwise, the <span class="bold"><strong>pgnoaddr</strong></span> parameter is the + page to create or retrieve. + </p> <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"> <h3 class="title">Note</h3> <p> - Page numbers begin at 0; that is, the first page in the file is page number 0, - not page number 1. - </p> + Page numbers begin at 0; that is, the first page in the file is page number 0, + not page number 1. + </p> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> - <h4 class="title"><a id="idp3535544"></a>txnid</h4> + <h4 class="title"><a id="idp3543920"></a>txnid</h4> </div> </div> </div> <p> - If the operation is part of an application-specified transaction, the - <span class="bold"><strong>txnid</strong></span> parameter is a transaction - handle returned from <a class="xref" href="txnbegin.html" title="DbEnv::txn_begin()">DbEnv::txn_begin()</a>; - otherwise NULL. A transaction is required if the file is open for multiversion - concurrency control by passing - <a class="link" href="dbopen.html#dbopen_DB_MULTIVERSION">DB_MULTIVERSION</a> - to - <a class="xref" href="mempfopen.html" title="DbMpoolFile::open()">DbMpoolFile::open()</a> - and the DB_MPOOL_DIRTY, DB_MPOOL_CREATE or DB_MPOOL_NEW flags were - specified. Otherwise it is ignored. - </p> + If the operation is part of an application-specified transaction, the + <span class="bold"><strong>txnid</strong></span> parameter is a transaction + handle returned from <a class="xref" href="txnbegin.html" title="DbEnv::txn_begin()">DbEnv::txn_begin()</a>; + otherwise NULL. A transaction is required if the file is open for multiversion + concurrency control by passing + <a class="link" href="dbopen.html#dbopen_DB_MULTIVERSION">DB_MULTIVERSION</a> + to + <a class="xref" href="mempfopen.html" title="DbMpoolFile::open()">DbMpoolFile::open()</a> + and the DB_MPOOL_DIRTY, DB_MPOOL_CREATE or DB_MPOOL_NEW flags were + specified. Otherwise it is ignored. + </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> - <h3 class="title"><a id="idp3536624"></a>Errors</h3> + <h3 class="title"><a id="idp3545000"></a>Errors</h3> </div> </div> </div> <p> - The <code class="methodname">DbMpoolFile::get()</code> <span> + The <code class="methodname">DbMpoolFile::get()</code> <span> <span> method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> @@ -247,100 +250,100 @@ DbMpoolFile::get(db_pgno_t *pgnoaddr, of the following non-zero errors: </span> </span> - </p> + </p> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> - <h4 class="title"><a id="idp3531192"></a>EACCES</h4> + <h4 class="title"><a id="idp3539568"></a>EACCES</h4> </div> </div> </div> <p> - The <code class="literal">DB_MPOOL_DIRTY</code> or - <code class="literal">DB_MPOOL_EDIT</code> flag was set and the source file was - not opened for writing. - </p> + The <code class="literal">DB_MPOOL_DIRTY</code> or + <code class="literal">DB_MPOOL_EDIT</code> flag was set and the source file was + not opened for writing. + </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> - <h4 class="title"><a id="idp3526464"></a>EAGAIN</h4> + <h4 class="title"><a id="idp3553360"></a>EAGAIN</h4> </div> </div> </div> <p> - The page reference count has overflowed. (This should never happen - unless there is a bug in the application.) - </p> + The page reference count has overflowed. (This should never happen + unless there is a bug in the application.) + </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> - <h4 class="title"><a id="idp3548568"></a>EINVAL</h4> + <h4 class="title"><a id="idp3542520"></a>EINVAL</h4> </div> </div> </div> <p> - If the <code class="literal">DB_MPOOL_NEW</code> flag was set, and the source - file was not opened for writing; more than one of - <code class="literal">DB_MPOOL_CREATE</code>, <code class="literal">DB_MPOOL_LAST</code>, - and <code class="literal">DB_MPOOL_NEW</code> was set; or if an invalid flag - value or parameter was specified. - </p> + If the <code class="literal">DB_MPOOL_NEW</code> flag was set, and the source + file was not opened for writing; more than one of + <code class="literal">DB_MPOOL_CREATE</code>, <code class="literal">DB_MPOOL_LAST</code>, + and <code class="literal">DB_MPOOL_NEW</code> was set; 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="idp3518472"></a>DB_LOCK_DEADLOCK</h4> + <h4 class="title"><a id="idp3528528"></a>DB_LOCK_DEADLOCK</h4> </div> </div> </div> <p> - For transactions configured with - <a class="link" href="txnbegin.html#txnbegin_DB_TXN_SNAPSHOT">DB_TXN_SNAPSHOT</a>, - the page has been modified since the transaction began. - </p> + For transactions configured with + <a class="link" href="txnbegin.html#txnbegin_DB_TXN_SNAPSHOT">DB_TXN_SNAPSHOT</a>, + the page has been modified since the transaction began. + </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> - <h4 class="title"><a id="idp3532808"></a>ENOMEM</h4> + <h4 class="title"><a id="idp3541400"></a>ENOMEM</h4> </div> </div> </div> <p> - The cache is full, and no more pages will fit in the cache. - </p> + The cache is full, and no more pages will fit in the cache. + </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> - <h3 class="title"><a id="idp3520032"></a>Class</h3> + <h3 class="title"><a id="idp3527432"></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="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a> - </p> + <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>, <a class="link" href="memp.html" title="Chapter 9. The DbMpoolFile Handle">DbMpoolFile</a> + </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> - <h3 class="title"><a id="idp3539176"></a>See Also</h3> + <h3 class="title"><a id="idp3547584"></a>See Also</h3> </div> </div> </div> <p> - <a class="xref" href="memp.html#memplist" title="Memory Pools and Related Methods">Memory Pools and Related Methods</a> - </p> + <a class="xref" href="memp.html#memplist" title="Memory Pools and Related Methods">Memory Pools and Related Methods</a> + </p> </div> </div> <div class="navfooter"> |