<!--$Id: rep_message.html,v 1.1.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_process_message</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_process_message</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 static class RepProcessMessage { public int envid; } public int rep_process_message( Dbt control, Dbt rec, DbEnv.RepProcessMessage envid) throws DbException; </pre></h3> <h1>Description</h1> <p>The DbEnv.rep_process_message method processes an incoming replication message sent by a member of the replication group to the local database environment. <p>The <b>rec</b> and <b>control</b> parameters should reference a copy of the parameters specified by Berkeley DB for the <b>rec</b> and <b>control</b> parameters on the sending environment. <p>The <b>envid</b> parameter should contain the local identifier that corresponds to the environment that sent the message to be processed (see <a href="../ref/rep/id.html">Replication environment IDs</a> for more information). <p>For implementation reasons, all incoming replication messages must be processed using the same <a href="../api_java/env_class.html">DbEnv</a> handle. It is not required that a single thread of control process all messages, only that all threads of control processing messages use the same handle. <p> If a new master has been elected, the DbEnv.rep_process_message method will return Db.DB_REP_NEWMASTER. The <b>envid</b> parameter contains the environment ID of the new master. If the recipient of this error return has been made master, it is the application's responsibility to begin acting as the master environment. <p> If the system received contact information from a new environment, the DbEnv.rep_process_message method will return Db.DB_REP_NEWSITE. The <b>rec</b> parameter contains the opaque data specified in the <b>cdata</b> parameter to the <a href="../api_java/rep_start.html">DbEnv.rep_start</a>. The application should take whatever action is needed to establish a communication channel with this new environment. <p> If the replication group has more than one master, the DbEnv.rep_process_message method throws an exception that encapsulates Db.DB_REP_DUPMASTER. The application should reconfigure itself as a client by calling the <a href="../api_java/rep_start.html">DbEnv.rep_start</a> method, and then call for an election by calling <a href="../api_java/rep_elect.html">DbEnv.rep_elect</a>. <p> If an election is needed, the DbEnv.rep_process_message method throws an exception that encapsulates Db.DB_REP_HOLDELECTION. The application should call for an election by calling <a href="../api_java/rep_elect.html">DbEnv.rep_elect</a>. <p> If the current environment's logs are too far out of date with respect to the master to be automatically synchronized, the DbEnv.rep_process_message method throws an exception that encapsulates Db.DB_REP_OUTDATED. The application should copy over a hot backup of the environment, run recovery, and restart the client. <p> Otherwise, the DbEnv.rep_process_message method throws an exception that encapsulates a non-zero error value on failure. <h1>Errors</h1> <p>The DbEnv.rep_process_message 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_process_message 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>