#include <db_cxx.h>

int
DbEnv::repmgr_site_list(u_int *countp, DB_REPMGR_SITE **listp);

Description: DbEnv::repmgr_site_list

The DbEnv::repmgr_site_list method returns the status of the sites currently known by the replication manager.

The DbEnv::repmgr_site_list method creates a statistical structure of type DB_REPMGR_SITE and copies a pointer to it into a user-specified memory location.

Statistical structures are stored in allocated memory. If application-specific allocation routines have been declared (see DbEnv::set_alloc for more information), they are used to allocate the memory; otherwise, the standard C library malloc(3) is used. The caller is responsible for deallocating the memory. To deallocate the memory, free the memory reference; references inside the returned memory need not be individually freed.

The following DB_REPMGR_SITE fields will be filled in:

int eid;

Environment ID assigned by the replication manager. This is the same value that is passed to the application's event notification function for the DB_EVENT_REP_NEWMASTER event.

char host[];

Nul-terminated host name.

u_int port;

TCP/IP port number.

u_int32_t status;

One of the following list of constants: DB_REPMGR_CONNECTED, DB_REPMGR_DISCONNECTED.

The DbEnv::repmgr_site_list method may be called at any time during the life of the application.

The DbEnv::repmgr_site_list 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

countp

A count of the returned structures will be stored into the memory referenced by countp.

listp

A reference to an array of structures will be stored into the memory referenced by listp.

Class

See Also