DbEnv::set_server

APIRef

#include <db_cxx.h>

int DbEnv::set_server(char *host, long cl_timeout, long sv_timeout, u_int32_t flags);

Description

Connects to the DB server on the indicated hostname and sets up a channel for communication.

The cl_timeout argument 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.

The sv_timeout argument specifies the number of seconds the server should allow a client connection to remain idle before assuming that 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.

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

When the DbEnv::set_server method has been called, any subsequent calls to Berkeley DB library interfaces may return either DB_NOSERVER or DB_NOSERVER_ID.

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

Errors

EINVAL
An invalid flag value or parameter was specified.

dbenv_set_server

Class

DbEnv

See Also

DbEnv::close, DbEnv::open, DbEnv::remove, DbEnv::err, DbEnv::strerror, DbEnv::version, DbEnv::set_cachesize, DbEnv::set_errcall, DbEnv::set_errfile, DbEnv::set_error_stream, DbEnv::set_errpfx, DbEnv::set_flags, DbEnv::set_mutexlocks, DbEnv::set_paniccall, and DbEnv::set_verbose.

APIRef

Copyright Sleepycat Software