<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Thu Dec 02 16:59:42 UTC 2010 --> <TITLE> DbMpoolFile </TITLE> <META NAME="date" CONTENT="2010-12-02"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="DbMpoolFile"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../com/sleepycat/db/DbMemoryException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> <A HREF="../../../com/sleepycat/db/DbMpoolFStat.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/sleepycat/db/DbMpoolFile.html" target="_top"><B>FRAMES</B></A> <A HREF="DbMpoolFile.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> com.sleepycat.db</FONT> <BR> Class DbMpoolFile</H2> <PRE> java.lang.Object <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.DbMpoolFile</B> </PRE> <HR> <DL> <DT><PRE>public class <B>DbMpoolFile</B><DT>extends java.lang.Object</DL> </PRE> <P> The memory pool interfaces for the Berkeley DB database environment are methods of the <A HREF="../../../com/sleepycat/db/DbEnv.html" title="class in com.sleepycat.db"><CODE>DbEnv</CODE></A> handle. The <A HREF="../../../com/sleepycat/db/DbEnv.html" title="class in com.sleepycat.db"><CODE>DbEnv</CODE></A> memory pool methods and the DbMpoolFile class provide general-purpose, page-oriented buffer management of files. Although designed to work with the other <A HREF="../../../com/sleepycat/db/Db.html" title="class in com.sleepycat.db"><CODE>Db</CODE></A> classes, they are also useful for more general purposes. The memory pools are referred to in this document as simply <i>pools</i> .</p> <p> In the Berkeley DB Java API, the DbMpoolFile class provides a very limited set of operations. It is only intended to modify settings for a <A HREF="../../../com/sleepycat/db/Db.html" title="class in com.sleepycat.db"><CODE>Db</CODE></A> object using the <A HREF="../../../com/sleepycat/db/Db.html#get_mpf()"><CODE>Db.get_mpf</CODE></A> method.</p> <P> <P> <HR> <P> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#swigCMemOwn">swigCMemOwn</A></B></CODE> <BR> </TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected </CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#DbMpoolFile()">DbMpoolFile</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected </CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#DbMpoolFile(long, boolean)">DbMpoolFile</A></B>(long cPtr, boolean cMemoryOwn)</CODE> <BR> </TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#delete()">delete</A></B>()</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#get_flags()">get_flags</A></B>()</CODE> <BR> <B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#getFlags()"><CODE>getFlags()</CODE></A></I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> long</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#get_maxsize()">get_maxsize</A></B>()</CODE> <BR> <B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#getMaxsize()"><CODE>getMaxsize()</CODE></A></I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#get_priority()">get_priority</A></B>()</CODE> <BR> <B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#getPriority()"><CODE>getPriority()</CODE></A></I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>protected static long</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#getCPtr(com.sleepycat.db.DbMpoolFile)">getCPtr</A></B>(<A HREF="../../../com/sleepycat/db/DbMpoolFile.html" title="class in com.sleepycat.db">DbMpoolFile</A> obj)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#getFlags()">getFlags</A></B>()</CODE> <BR> The DbMpoolFile.getFlags method returns the flags.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> long</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#getMaxsize()">getMaxsize</A></B>()</CODE> <BR> The DbMpoolFile.getMaxsize method returns the size of the cache in bytes.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#getPriority()">getPriority</A></B>()</CODE> <BR> The DbMpoolFile.getPriority method returns the cache priority.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#set_flags(int, boolean)">set_flags</A></B>(int flags, boolean onoff)</CODE> <BR> <B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#setFlags(int, boolean)"><CODE>setFlags(int,boolean)</CODE></A></I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#set_maxsize(long)">set_maxsize</A></B>(long bytes)</CODE> <BR> <B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#setMaxsize(long)"><CODE>setMaxsize(long)</CODE></A></I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#set_priority(int)">set_priority</A></B>(int priority)</CODE> <BR> <B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#setPriority(int)"><CODE>setPriority(int)</CODE></A></I></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#setFlags(int, boolean)">setFlags</A></B>(int flags, boolean onoff)</CODE> <BR> Configure a file in the cache.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#setMaxsize(long)">setMaxsize</A></B>(long bytes)</CODE> <BR> Set the maximum size for the file to be <b>bytes</b> bytes.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMpoolFile.html#setPriority(int)">setPriority</A></B>(int priority)</CODE> <BR> Set the cache priority for pages from the specified file.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="swigCMemOwn"><!-- --></A><H3> swigCMemOwn</H3> <PRE> protected boolean <B>swigCMemOwn</B></PRE> <DL> <DL> </DL> </DL> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="DbMpoolFile(long, boolean)"><!-- --></A><H3> DbMpoolFile</H3> <PRE> protected <B>DbMpoolFile</B>(long cPtr, boolean cMemoryOwn)</PRE> <DL> </DL> <HR> <A NAME="DbMpoolFile()"><!-- --></A><H3> DbMpoolFile</H3> <PRE> protected <B>DbMpoolFile</B>()</PRE> <DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="delete()"><!-- --></A><H3> delete</H3> <PRE> protected void <B>delete</B>()</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="getCPtr(com.sleepycat.db.DbMpoolFile)"><!-- --></A><H3> getCPtr</H3> <PRE> protected static long <B>getCPtr</B>(<A HREF="../../../com/sleepycat/db/DbMpoolFile.html" title="class in com.sleepycat.db">DbMpoolFile</A> obj)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="get_priority()"><!-- --></A><H3> get_priority</H3> <PRE> public int <B>get_priority</B>() throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#getPriority()"><CODE>getPriority()</CODE></A></I> <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE></DL> </DD> </DL> <HR> <A NAME="getPriority()"><!-- --></A><H3> getPriority</H3> <PRE> public int <B>getPriority</B>() throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD>The DbMpoolFile.getPriority method returns the cache priority. </p> <p> The DbMpoolFile.getPriority method may be called at any time during the life of the application.</p> <P> <DD><DL> <DT><B>Returns:</B><DD>The DbMpoolFile.getPriority method returns the cache priority.</p> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - Signals that an exception of some sort has occurred.</DL> </DD> </DL> <HR> <A NAME="set_priority(int)"><!-- --></A><H3> set_priority</H3> <PRE> public void <B>set_priority</B>(int priority) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#setPriority(int)"><CODE>setPriority(int)</CODE></A></I> <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE></DL> </DD> </DL> <HR> <A NAME="setPriority(int)"><!-- --></A><H3> setPriority</H3> <PRE> public void <B>setPriority</B>(int priority) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD>Set the cache priority for pages from the specified file. The priority of a page biases the replacement algorithm to be more or less likely to discard a page when space is needed in the buffer pool. The bias is temporary, and pages will eventually be discarded if they are not referenced again. The DbMpoolFile.setPriority method is only advisory, and does not guarantee pages will be treated in a specific way.</p> <p> To set the priority for the pages belonging to a particular database, call the DbMpoolFile.setPriority method using the <A HREF="../../../com/sleepycat/db/DbMpoolFile.html" title="class in com.sleepycat.db"><CODE>DbMpoolFile</CODE></A> handle returned by calling the <A HREF="../../../com/sleepycat/db/Db.html#get_mpf()"><CODE>Db.get_mpf</CODE></A> method.</p> <p> The DbMpoolFile.setPriority method may be called at any time during the life of the application.</p> <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>priority</CODE> - must be set to one of the following values: <ul> <li> <A HREF="../../../com/sleepycat/db/Db.html#DB_PRIORITY_VERY_LOW"><CODE>Db.DB_PRIORITY_VERY_LOW</CODE></A><p> The lowest priority: pages are the most likely to be discarded. </li> </ul> <ul> <li> <A HREF="../../../com/sleepycat/db/Db.html#DB_PRIORITY_LOW"><CODE>Db.DB_PRIORITY_LOW</CODE></A><p> The next lowest priority. </li> </ul> <ul> <li> <A HREF="../../../com/sleepycat/db/Db.html#DB_PRIORITY_DEFAULT"><CODE>Db.DB_PRIORITY_DEFAULT</CODE></A><p> The default priority. </li> </ul> <ul> <li> <A HREF="../../../com/sleepycat/db/Db.html#DB_PRIORITY_HIGH"><CODE>Db.DB_PRIORITY_HIGH</CODE></A><p> The next highest priority. </li> </ul> <ul> <li> <A HREF="../../../com/sleepycat/db/Db.html#DB_PRIORITY_VERY_HIGH"><CODE>Db.DB_PRIORITY_VERY_HIGH</CODE></A><p> The highest priority: pages are the least likely to be discarded. </li> </ul> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - Signals that an exception of some sort has occurred.</DL> </DD> </DL> <HR> <A NAME="get_flags()"><!-- --></A><H3> get_flags</H3> <PRE> public int <B>get_flags</B>() throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#getFlags()"><CODE>getFlags()</CODE></A></I> <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE></DL> </DD> </DL> <HR> <A NAME="getFlags()"><!-- --></A><H3> getFlags</H3> <PRE> public int <B>getFlags</B>() throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD>The DbMpoolFile.getFlags method returns the flags.</p> <p> The DbMpoolFile.getFlags method may be called at any time during the life of the application.</p> <P> <DD><DL> <DT><B>Returns:</B><DD>The DbMpoolFile.getFlags method returns the flags.</p> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - Signals that an exception of some sort has occurred.</DL> </DD> </DL> <HR> <A NAME="set_flags(int, boolean)"><!-- --></A><H3> set_flags</H3> <PRE> public void <B>set_flags</B>(int flags, boolean onoff) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#setFlags(int, boolean)"><CODE>setFlags(int,boolean)</CODE></A></I> <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE></DL> </DD> </DL> <HR> <A NAME="setFlags(int, boolean)"><!-- --></A><H3> setFlags</H3> <PRE> public void <B>setFlags</B>(int flags, boolean onoff) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD>Configure a file in the cache.</p> <p> To set the flags for a particular database, call the DbMpoolFile.setFlags method using the <A HREF="../../../com/sleepycat/db/DbMpoolFile.html" title="class in com.sleepycat.db"><CODE>DbMpoolFile</CODE></A> handle stored in the <b>mpf</b> field of the <A HREF="../../../com/sleepycat/db/Db.html" title="class in com.sleepycat.db"><CODE>Db</CODE></A> handle. </p> <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>flags</CODE> - must be set by bitwise inclusively <b>OR </b>'ing together one or more of the following values: <ul> <li> <A HREF="../../../com/sleepycat/db/Db.html#DB_MPOOL_NOFILE"><CODE>Db.DB_MPOOL_NOFILE</CODE></A><p> If set, no backing temporary file will be opened for in-memory databases, even if they expand to fill the entire cache. Attempts to create new file pages after the cache has been filled will fail. <p> The <code>Db.DB_MPOOL_NOFILE</code> flag may be used to configure Berkeley DB at any time during the life of the application.</p> </li> </ul><DD><CODE>onoff</CODE> - If <b>onoff</b> is false, the specified flags are cleared; otherwise they are set. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - Signals that an exception of some sort has occurred.</DL> </DD> </DL> <HR> <A NAME="get_maxsize()"><!-- --></A><H3> get_maxsize</H3> <PRE> public long <B>get_maxsize</B>() throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#getMaxsize()"><CODE>getMaxsize()</CODE></A></I> <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE></DL> </DD> </DL> <HR> <A NAME="getMaxsize()"><!-- --></A><H3> getMaxsize</H3> <PRE> public long <B>getMaxsize</B>() throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD>The DbMpoolFile.getMaxsize method returns the size of the cache in bytes.</p> <p> The DbMpoolFile.getMaxsize method may be called at any time during the life of the application.</p> <P> <DD><DL> <DT><B>Returns:</B><DD>The DbMpoolFile.getMaxsize method returns the size of the cache in bytes.</p> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - Signals that an exception of some sort has occurred.</DL> </DD> </DL> <HR> <A NAME="set_maxsize(long)"><!-- --></A><H3> set_maxsize</H3> <PRE> public void <B>set_maxsize</B>(long bytes) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD><B>Deprecated.</B> <I>As of Berkeley DB 4.2, replaced by <A HREF="../../../com/sleepycat/db/DbMpoolFile.html#setMaxsize(long)"><CODE>setMaxsize(long)</CODE></A></I> <P> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE></DL> </DD> </DL> <HR> <A NAME="setMaxsize(long)"><!-- --></A><H3> setMaxsize</H3> <PRE> public void <B>setMaxsize</B>(long bytes) throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE> <DL> <DD>Set the maximum size for the file to be <b>bytes</b> bytes. Attempts to allocate new pages in the file after the limit has been reached will fail.</p> <p> To set the maximum file size for a particular database, call the DbMpoolFile.setMaxsize method using the <A HREF="../../../com/sleepycat/db/DbMpoolFile.html" title="class in com.sleepycat.db"><CODE>DbMpoolFile</CODE></A> handle stored in the <b>mpf</b> field of the <A HREF="../../../com/sleepycat/db/Db.html" title="class in com.sleepycat.db"><CODE>Db</CODE></A> handle. Attempts to insert new items into the database after the limit has been reached may fail.</p> <p> The DbMpoolFile.setMaxsize method may be called at any time during the life of the application.</p> <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>bytes</CODE> - The maximum size of the files in bytes. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - Signals that an exception of some sort has occurred.</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../com/sleepycat/db/DbMemoryException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> <A HREF="../../../com/sleepycat/db/DbMpoolFStat.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/sleepycat/db/DbMpoolFile.html" target="_top"><B>FRAMES</B></A> <A HREF="DbMpoolFile.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>