← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_cxx/rep_message.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdb/docs/api_cxx/rep_message.html
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: DbEnv::rep_process_message</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>DbEnv::rep_process_message</h1>
16
 
</td>
17
 
<td align=right>
18
 
<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>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
#include &lt;db_cxx.h&gt;
24
 
<p>
25
 
int
26
 
DbEnv::rep_process_message(Dbt *control, Dbt *rec, int *envid)
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>The DbEnv::rep_process_message method processes an incoming replication
30
 
message sent by a member of the replication group to the local database
31
 
environment.
32
 
<p>The <b>rec</b> and <b>control</b> parameters should reference a copy
33
 
of the parameters specified by Berkeley DB for the <b>rec</b> and
34
 
<b>control</b> parameters on the sending environment.
35
 
<p>The <b>envid</b> parameter should contain the local identifier that
36
 
corresponds to the environment that sent the message to be processed
37
 
(see <a href="../ref/rep/id.html">Replication environment IDs</a> for more
38
 
information).
39
 
<p>For implementation reasons, all incoming replication messages must be
40
 
processed using the same <a href="../api_cxx/env_class.html">DbEnv</a> handle.  It is not required that
41
 
a single thread of control process all messages, only that all threads
42
 
of control processing messages use the same handle.
43
 
<p>
44
 
If a new master has been elected, the DbEnv::rep_process_message method will return DB_REP_NEWMASTER.
45
 
The <b>envid</b> parameter contains the environment ID of the new
46
 
master.  If the recipient of this error return has been made master, it
47
 
is the application's responsibility to begin acting as the master
48
 
environment.
49
 
<p>
50
 
If the system received contact information from a new environment, the DbEnv::rep_process_message method will return DB_REP_NEWSITE.
51
 
The <b>rec</b> parameter contains the opaque data specified in the
52
 
<b>cdata</b> parameter to the <a href="../api_cxx/rep_start.html">DbEnv::rep_start</a>.  The application
53
 
should take whatever action is needed to establish a communication
54
 
channel with this new environment.
55
 
<p>
56
 
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.
57
 
The application should reconfigure itself as a client by calling the
58
 
<a href="../api_cxx/rep_start.html">DbEnv::rep_start</a> method, and then call for an election by calling
59
 
<a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a>.
60
 
<p>
61
 
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.
62
 
The application should call for an election by
63
 
calling <a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a>.
64
 
<p>
65
 
If the current environment's logs are too far out of date with respect
66
 
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
67
 
application should copy over a hot backup of the environment, run
68
 
recovery, and restart the client.
69
 
<p>
70
 
Otherwise, the DbEnv::rep_process_message method either returns a non-zero error value or throws an exception that
71
 
encapsulates a non-zero error value on failure, and returns 0 on success.
72
 
<h1>Errors</h1>
73
 
<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.
74
 
If a catastrophic error has occurred, the DbEnv::rep_process_message method may fail and
75
 
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
76
 
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
77
 
in which case all subsequent Berkeley DB calls will fail in the same way.
78
 
<h1>Class</h1>
79
 
<a href="../api_cxx/env_class.html">DbEnv</a>
80
 
<h1>See Also</h1>
81
 
<a href="../api_cxx/rep_list.html">Replication and Related Methods</a>
82
 
</tt>
83
 
<table width="100%"><tr><td><br></td><td align=right>
84
 
<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>
85
 
</td></tr></table>
86
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
87
 
</body>
88
 
</html>