DbEnv::rep_start()
Prev | Chapter 11. Replication Methods | Next

## DbEnv::rep_start()

    #include <db_cxx.h>

    int
    DbEnv::rep_start(Dbt *cdata, u_int32_t flags);

The `DbEnv::rep_start()` method configures the database environment as a client or master in a group of replicated database environments.

The `DbEnv::rep_start()` method is not called by most replication applications. It should only be called by Base API applications implementing their own network transport layer, explicitly holding replication group elections and handling replication messages outside of the Replication Manager framework.

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. If master leases are in use, this method cannot be used to appoint a master, and should only be used to configure a database environment as a master as the result of an election.

The enclosing database environment must already have been opened by calling the DbEnv::open() method and must already have been configured to send replication messages by calling the DbEnv::rep_set_transport() method.

The `DbEnv::rep_start()` 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

#### cdata

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

#### flags

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

- `DB_REP_CLIENT`

  Configure the environment as a replication client.

- `DB_REP_MASTER`

  Configure the environment as a replication master.

### Errors

The `DbEnv::rep_start()` method may fail and throw a DbException exception, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

#### DB_REP_UNAVAIL

If the flags parameter was passed as DB_REP_MASTER but the database environment cannot currently become the replication master because it is temporarily initializing and is incomplete.

If the database environment was not already configured to communicate with a replication group by a call to DbEnv::rep_set_transport(); the database environment was not already opened; this method is called from a Replication Manager application; outstanding master leases are granted; this method is used to appoint a new master when master leases are in use; or if an invalid flag value or parameter was specified.

### Class

DbEnv

### See Also

Replication and Related Methods

Prev | Up | Next
DbEnv::rep_set_transport() | Home | DbEnv::rep_stat()