DbEnv::repmgr_stat API Ref

#include <db_cxx.h>

int DbEnv::repmgr_stat(DB_REPMGR_STAT **statp, u_int32_t flags);

int DbEnv::repmgr_stat_print(u_int32_t flags);


Description: DbEnv::repmgr_stat

The DbEnv::repmgr_stat method returns the replication manager statistics.

The DbEnv::repmgr_stat method creates a statistical structure of type DB_REPMGR_STAT 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_STAT fields will be filled in:


u_int32_t st_perm_failed; u_int32_t st_msgs_queued; u_int32_t st_msgs_dropped; u_int32_t st_connection_drop; u_int32_t st_connect_fail;

The DbEnv::repmgr_stat method may not be called before the DbEnv::open method is called.

The DbEnv::repmgr_stat 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
flags statp

Errors

The DbEnv::repmgr_stat method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:


EINVAL

Description: DbEnv::repmgr_stat_print

The DbEnv::repmgr_stat_print method displays the replication manager statistical information, as described for the DbEnv::repmgr_stat method. The information is printed to a specified output channel (see the DbEnv::set_msgfile method for more information), or passed to an application callback function (see the DbEnv::set_msgcall method for more information).

The DbEnv::repmgr_stat_print method may not be called before the DbEnv::open method is called.

The DbEnv::repmgr_stat_print 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
flags


Class DbEnv
See Also Replication and Related Methods

APIRef

Copyright (c) 1996,2008 Oracle. All rights reserved.