#include <db.h>

int
DB_ENV->rep_start(DB_ENV *env, DBT *cdata, u_int32_t flags);

Description

The DB_ENV->rep_start function configures the database environment as a client or master in a group of replicated database environments. Replication master environments are the only database environments where replicated databases may be modified. Replication client environments are read-only as long as they are clients. Replication client environments may be upgraded to be replication master environments in the case that the current master fails or there is no master present.

The enclosing database environment must already have been opened by calling the DB_ENV->open function and must already have been configured to send replication messages by calling the DB_ENV->set_rep_transport function.

The cdata parameter is an opaque data item that is sent over the communication infrastructure when the client or master comes online (see Connecting to a new site for more information). If no such information is useful, cdata should be NULL.

The flags value must be set to one of the following values:

DB_REP_CLIENT

Configure the environment as a replication client.

DB_REP_LOGSONLY

Configure the environment as a log files-only client.

DB_REP_MASTER

Configure the environment as a replication master.

The DB_ENV->rep_start function returns a non-zero error value on failure and 0 on success.

Errors

The DB_ENV->rep_start function may fail and return a non-zero error for the following conditions:

EINVAL

An invalid flag value or parameter was specified.

The environment was not already configured to communicate with a replication group by a call to DB_ENV->set_rep_transport.

The environment was not already opened.

The DB_ENV->rep_start function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the DB_ENV->rep_start function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

See Also