Berkeley DB: DbEnv::repmgr_stat
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::repmgr_stat |

`

###

    #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;
  The number of times a message critical for maintaining database integrity (for example, a transaction commit), originating at this site, did not receive sufficient acknowledgement from clients, according to the configured acknowledgement policy and acknowledgement timeout.
u_int32_t st_msgs_queued;
  The number of outgoing messages which could not be transmitted immediately, due to a full network buffer, and had to be queued for later delivery.
u_int32_t st_msgs_dropped;
  The number of outgoing messages that were completely dropped, because the outgoing message queue was full. (Berkeley DB replication is tolerant of dropped messages, and will automatically request retransmission of any missing messages as needed.)
u_int32_t st_connection_drop;
  The number of times an existing TCP/IP connection failed.
u_int32_t st_connect_fail;
  The number of times an attempt to open a new TCP/IP connection failed.

The DbEnv::repmgr_stat method may not be called before the DbEnv::open method has been 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
  The flags parameter must be set to 0 or the following value:
  DB_STAT_CLEAR
    Reset statistics after returning their values.
statp
  The statp parameter references memory into which a pointer to the allocated statistics structure is copied.

### 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
  An invalid flag value or parameter was specified.

### 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 has been 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
  The flags parameter must be set to 0 or by bitwise inclusively OR'ing together one or more of the following values:
  DB_STAT_ALL
    Display all available information.
  DB_STAT_CLEAR
    Reset statistics after displaying their values.

### Class

DbEnv

### See Also

Replication and Related Methods`

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