<!--$Id: rep_start.html,v 1.1 2003/02/15 04:55:54 zarzycki Exp $--> <!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DbEnv.rep_start</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> </head> <body bgcolor=white> <a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h1>DbEnv.rep_start</h1> </td> <td align=right> <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> </td></tr></table> <hr size=1 noshade> <tt> <h3><pre> import com.sleepycat.db.*; <p> public void rep_start(Dbt cdata, int flags) throws DbException; </pre></h3> <h1>Description</h1> <p>The DbEnv.rep_start method configures the database environment as a client or master in a group of replicated database environments. Replication master environments are the only database environments where replicated databases may be modified. Replication client environments are read-only as long as they are clients. Replication client environments may be upgraded to be replication master environments in the case that the current master fails or there is no master present. <p>The enclosing database environment must already have been opened by calling the <a href="../api_java/env_open.html">DbEnv.open</a> method and must already have been configured to send replication messages by calling the <a href="../api_java/rep_transport.html">DbEnv.set_rep_transport</a> method. <p>The <b>cdata</b> parameter is an opaque data item that is sent over the communication infrastructure when the client or master comes online (see <a href="../ref/rep/newsite.html">Connecting to a new site</a> for more information). If no such information is useful, <b>cdata</b> should be null. <p>The <b>flags</b> value must be set to one of the following values: <p><dl compact> <p><dt><a name="Db.DB_REP_CLIENT">Db.DB_REP_CLIENT</a><dd>Configure the environment as a replication client. <p><dt><a name="Db.DB_REP_LOGSONLY">Db.DB_REP_LOGSONLY</a><dd>Configure the environment as a log files-only client. <p><dt><a name="Db.DB_REP_MASTER">Db.DB_REP_MASTER</a><dd>Configure the environment as a replication master. </dl> <p>The DbEnv.rep_start method throws an exception that encapsulates a non-zero error value on failure. <h1>Errors</h1> <p>The DbEnv.rep_start method may fail and throw an exception encapsulating a non-zero error for the following conditions: <p><dl compact> <p><dt>EINVAL<dd>An invalid flag value or parameter was specified. <p>The environment was not already configured to communicate with a replication group by a call to <a href="../api_java/rep_transport.html">DbEnv.set_rep_transport</a>. <p>The environment was not already opened. </dl> <p>The DbEnv.rep_start method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the DbEnv.rep_start method may fail and throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>, in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_java/env_class.html">DbEnv</a> <h1>See Also</h1> <a href="../api_java/rep_list.html">Replication and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <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> </td></tr></table> <p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> </body> </html>