← 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_c/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_c/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: DB_ENV-&gt;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>DB_ENV-&gt;rep_process_message</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_c/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.h&gt;
24
 
<p>
25
 
int
26
 
DB_ENV-&gt;rep_process_message(DB_ENV *env,
27
 
    DBT *control, DBT *rec, int *envid)
28
 
</pre></h3>
29
 
<h1>Description</h1>
30
 
<p>The DB_ENV-&gt;rep_process_message method processes an incoming replication
31
 
message sent by a member of the replication group to the local database
32
 
environment.
33
 
<p>The <b>rec</b> and <b>control</b> parameters should reference a copy
34
 
of the parameters specified by Berkeley DB for the <b>rec</b> and
35
 
<b>control</b> parameters on the sending environment.
36
 
<p>The <b>envid</b> parameter should contain the local identifier that
37
 
corresponds to the environment that sent the message to be processed
38
 
(see <a href="../ref/rep/id.html">Replication environment IDs</a> for more
39
 
information).
40
 
<p>For implementation reasons, all incoming replication messages must be
41
 
processed using the same <a href="../api_c/env_class.html">DB_ENV</a> handle.  It is not required that
42
 
a single thread of control process all messages, only that all threads
43
 
of control processing messages use the same handle.
44
 
<p>
45
 
If a new master has been elected, the DB_ENV-&gt;rep_process_message method will return DB_REP_NEWMASTER.
46
 
The <b>envid</b> parameter contains the environment ID of the new
47
 
master.  If the recipient of this error return has been made master, it
48
 
is the application's responsibility to begin acting as the master
49
 
environment.
50
 
<p>
51
 
If the system received contact information from a new environment, the DB_ENV-&gt;rep_process_message method will return DB_REP_NEWSITE.
52
 
The <b>rec</b> parameter contains the opaque data specified in the
53
 
<b>cdata</b> parameter to the <a href="../api_c/rep_start.html">DB_ENV-&gt;rep_start</a>.  The application
54
 
should take whatever action is needed to establish a communication
55
 
channel with this new environment.
56
 
<p>
57
 
If the replication group has more than one master, the DB_ENV-&gt;rep_process_message method will return DB_REP_DUPMASTER.
58
 
The application should reconfigure itself as a client by calling the
59
 
<a href="../api_c/rep_start.html">DB_ENV-&gt;rep_start</a> method, and then call for an election by calling
60
 
<a href="../api_c/rep_elect.html">DB_ENV-&gt;rep_elect</a>.
61
 
<p>
62
 
If an election is needed, the DB_ENV-&gt;rep_process_message method will return DB_REP_HOLDELECTION.
63
 
The application should call for an election by
64
 
calling <a href="../api_c/rep_elect.html">DB_ENV-&gt;rep_elect</a>.
65
 
<p>
66
 
If the current environment's logs are too far out of date with respect
67
 
to the master to be automatically synchronized, the DB_ENV-&gt;rep_process_message method will return DB_REP_OUTDATED. The
68
 
application should copy over a hot backup of the environment, run
69
 
recovery, and restart the client.
70
 
<p>
71
 
Otherwise, the DB_ENV-&gt;rep_process_message method returns a non-zero error value on failure and 0 on success.
72
 
<h1>Errors</h1>
73
 
<p>The DB_ENV-&gt;rep_process_message method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
74
 
If a catastrophic error has occurred, the DB_ENV-&gt;rep_process_message method may fail and
75
 
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
76
 
in which case all subsequent Berkeley DB calls will fail in the same way.
77
 
<h1>Class</h1>
78
 
<a href="../api_c/env_class.html">DB_ENV</a>
79
 
<h1>See Also</h1>
80
 
<a href="../api_c/rep_list.html">Replication and Related Methods</a>
81
 
</tt>
82
 
<table width="100%"><tr><td><br></td><td align=right>
83
 
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
84
 
</td></tr></table>
85
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
86
 
</body>
87
 
</html>