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.-->
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++">
12
<a name="2"><!--meow--></a>
13
<table width="100%"><tr valign=top>
15
<h1>DbEnv.set_rpc_server</h1>
18
<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>
23
import com.sleepycat.db.*;
25
public void set_rpc_server(DbClient client,
26
String host, long cl_timeout, long sv_timeout, int flags)
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
34
The <b>client</b> argument is reserved for future use.
35
If it is not NULL, an exception is thrown.
36
<a name="3"><!--meow--></a>
37
<p>The <b>cl_timeout</b> argument specifies the number of seconds the client
38
should wait for results to come back from the server. Once the timeout
39
has expired on any communication with the server, Db.DB_NOSERVER will
40
be returned. If this value is zero, a default timeout is used.
41
<a name="4"><!--meow--></a>
42
<p>The <b>sv_timeout</b> argument specifies the number of seconds the server
43
should allow a client connection to remain idle before assuming that the
44
client is gone. Once that timeout has been reached, the server releases
45
all resources associated with that client connection. Subsequent attempts
46
by that client to communicate with the server result in
47
Db.DB_NOSERVER_ID, indicating that an invalid identifier has been
48
given to the server. This value can be considered a hint to the server.
49
The server may alter this value based on its own policies or allowed
50
values. If this value is zero, a default timeout is used.
51
<p>The <b>flags</b> parameter is currently unused, and must be set to 0.
52
<p>When the DbEnv.set_rpc_server method has been called, subsequent calls
53
to Berkeley DB library interfaces may return or throw exceptions encapsulating
54
<a name="Db.DB_NOSERVER">Db.DB_NOSERVER</a>, <a name="Db.DB_NOSERVER_ID">Db.DB_NOSERVER_ID</a>, or
55
<a name="Db.DB_NOSERVER_HOME">Db.DB_NOSERVER_HOME</a>.
56
<p>The DbEnv.set_rpc_server method configures operations performed using the specified
57
<a href="../api_java/env_class.html">DbEnv</a> handle, not all operations performed on the underlying
59
<p>The DbEnv.set_rpc_server interface may not be called after the <a href="../api_java/env_open.html">DbEnv.open</a>
61
<p>The DbEnv.set_rpc_server method throws an exception that encapsulates a non-zero error value on
64
<p>The DbEnv.set_rpc_server method may fail and throw an exception encapsulating a non-zero error for the following conditions:
66
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
68
<p>The DbEnv.set_rpc_server method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
69
If a catastrophic error has occurred, the DbEnv.set_rpc_server method may fail and
70
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
71
in which case all subsequent Berkeley DB calls will fail in the same way.
73
<a href="../api_java/env_class.html">DbEnv</a>
75
<a href="../api_java/env_list.html">Database Environments and Related Methods</a>
77
<table width="100%"><tr><td><br></td><td align=right>
78
<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>
80
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>