← 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/env_set_rpc_server.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/env_set_rpc_server.html
1
 
<!--"@(#)env_set_rpc_server.so  10.1 (Sleepycat) 8/25/99"-->
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::set_rpc_server</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::set_rpc_server</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::set_rpc_server(CLIENT *client, char *host,
27
 
    long cl_timeout, long sv_timeout, u_int32_t flags);
28
 
</pre></h3>
29
 
<h1>Description</h1>
30
 
<p>Establishes a connection for this <b>dbenv</b> to a RPC server.  If
31
 
the <b>client</b> argument is NULL, this call creates a connection to
32
 
the Berkeley DB server on the indicated hostname and sets up a channel for
33
 
communication.
34
 
If the <b>client</b> channel has been provided by the
35
 
application then Berkeley DB will use it as its connection and the <b>host</b> and
36
 
<b>cl_timeout</b> fields are ignored.
37
 
<a name="3"><!--meow--></a>
38
 
<p>The <b>cl_timeout</b> argument specifies the number of seconds the client
39
 
should wait for results to come back from the server.  Once the timeout
40
 
has expired on any communication with the server, DB_NOSERVER will
41
 
be returned.  If this value is zero, a default timeout is used.
42
 
<a name="4"><!--meow--></a>
43
 
<p>The <b>sv_timeout</b> argument specifies the number of seconds the server
44
 
should allow a client connection to remain idle before assuming that the
45
 
client is gone.  Once that timeout has been reached, the server releases
46
 
all resources associated with that client connection.  Subsequent attempts
47
 
by that client to communicate with the server result in
48
 
DB_NOSERVER_ID, indicating that an invalid identifier has been
49
 
given to the server.  This value can be considered a hint to the server.
50
 
The server may alter this value based on its own policies or allowed
51
 
values.  If this value is zero, a default timeout is used.
52
 
<p>The <b>flags</b> parameter is currently unused, and must be set to 0.
53
 
<p>When the DbEnv::set_rpc_server method has been called, subsequent calls
54
 
to Berkeley DB library interfaces may return or throw exceptions encapsulating
55
 
<a name="DB_NOSERVER">DB_NOSERVER</a>, <a name="DB_NOSERVER_ID">DB_NOSERVER_ID</a>, or
56
 
<a name="DB_NOSERVER_HOME">DB_NOSERVER_HOME</a>.
57
 
<p>The DbEnv::set_rpc_server method configures operations performed using the specified
58
 
<a href="../api_cxx/env_class.html">DbEnv</a> handle, not all operations performed on the underlying
59
 
database environment.
60
 
<p>The DbEnv::set_rpc_server interface may not be called after the <a href="../api_cxx/env_open.html">DbEnv::open</a>
61
 
interface is called.
62
 
<p>The DbEnv::set_rpc_server method either returns a non-zero error value or throws an exception that
63
 
encapsulates a non-zero error value on failure, and returns 0 on success.
64
 
<h1>Errors</h1>
65
 
<p>The DbEnv::set_rpc_server method may fail and throw an exception or return a non-zero error for the following conditions:
66
 
<p><dl compact>
67
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
68
 
</dl>
69
 
<p>The DbEnv::set_rpc_server 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.
70
 
If a catastrophic error has occurred, the DbEnv::set_rpc_server method may fail and
71
 
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
72
 
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
73
 
in which case all subsequent Berkeley DB calls will fail in the same way.
74
 
<h1>Class</h1>
75
 
<a href="../api_cxx/env_class.html">DbEnv</a>
76
 
<h1>See Also</h1>
77
 
<a href="../api_cxx/env_list.html">Database Environments and Related Methods</a>
78
 
</tt>
79
 
<table width="100%"><tr><td><br></td><td align=right>
80
 
<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>
81
 
</td></tr></table>
82
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
83
 
</body>
84
 
</html>