Berkeley DB: DbEnv::rep_start
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++

### DbEnv::rep_start |

`

###

    #include <db_cxx.h>

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

### Description: DbEnv::rep_start

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 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.

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 DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

EINVAL
  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; or if an invalid flag value or parameter was specified.

### Class

DbEnv

### See Also

Replication and Related Methods`

Copyright (c) 1996-2006 Oracle Corporation - All rights reserved.