1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
<!--Id: rep_message.so,v 1.9 2002/07/02 15:22:24 bostic 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_cxx/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>
#include <db_cxx.h>
<p>
int
DbEnv::rep_process_message(Dbt *control, Dbt *rec, int *envid)
</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_cxx/dbenv_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_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_REP_NEWSITE.
The <b>rec</b> parameter contains the opaque data specified in the
<b>cdata</b> parameter to the <a href="../api_cxx/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 either returns DB_REP_DUPMASTER or throws an exception that encapsulates DB_REP_DUPMASTER.
The application should reconfigure itself as a client by calling the
<a href="../api_cxx/rep_start.html">DbEnv::rep_start</a> method, and then call for an election by calling
<a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a>.
<p>
If an election is needed, the DbEnv::rep_process_message method either returns DB_REP_HOLDELECTION or throws an exception that encapsulates DB_REP_HOLDELECTION.
The application should call for an election by
calling <a href="../api_cxx/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 either returns DB_REP_OUTDATED or throws an exception that encapsulates 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 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.
<h1>Errors</h1>
<p>The DbEnv::rep_process_message method may fail and throw an exception or return a non-zero error 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
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>See Also</h1>
<a href="../api_cxx/rep_start.html">DbEnv::rep_start</a>,
<a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a>,
<a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a>
and
<a href="../api_cxx/rep_transport.html">DbEnv::set_rep_transport</a>.
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/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>
|
