#include <db_cxx.h>

int
DbEnv::set_rpc_server(CLIENT *client, char *host,
    long cl_timeout, long sv_timeout, u_int32_t flags);

Description: DbEnv::set_rpc_server

Establishes a connection for this dbenv to a RPC server.

When the DbEnv::set_rpc_server method has been called, subsequent calls to Berkeley DB library interfaces may return or throw exceptions encapsulating DB_NOSERVER, DB_NOSERVER_ID, or DB_NOSERVER_HOME.

The DbEnv::set_rpc_server method configures operations performed using the specified DbEnv handle, not all operations performed on the underlying database environment.

The DbEnv::set_rpc_server method may not be called after the DbEnv::open method is called.

The DbEnv::set_rpc_server 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.

Parameters

cl_timeout

The cl_timeout parameter specifies the number of seconds the client should wait for results to come back from the server. Once the timeout has expired on any communication with the server, DB_NOSERVER will be returned. If this value is zero, a default timeout is used.

client

If the client channel has been provided by the application then Berkeley DB will use it as its connection and the host and cl_timeout fields are ignored.

host

The host parameter is the host to which the Berkeley DB server will connect and create a channel for communication.

flags

The flags parameter is currently unused, and must be set to 0.

sv_timeout

The sv_timeout parameter specifies the number of seconds the server should allow a client connection to remain idle before assuming that the client is gone. Once that timeout has been reached, the server releases all resources associated with that client connection. Subsequent attempts by that client to communicate with the server result in DB_NOSERVER_ID, indicating that an invalid identifier has been given to the server. This value can be considered a hint to the server. The server may alter this value based on its own policies or allowed values. If this value is zero, a default timeout is used.

Errors

The DbEnv::set_rpc_server method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

EINVAL

An invalid flag value or parameter was specified.

Class

See Also