#include <db_cxx.h>
DbEnv::repmgr_site_list(u_int *countp, DB_REPMGR_SITE **listp);

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:

The DbEnv::repmgr_site_list() method may be called only after the DbEnv::repmgr_start() method has been called with a 0 return code.

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.



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


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



See Also

Replication and Related Methods