118 lines
5.6 KiB
HTML
118 lines
5.6 KiB
HTML
<!--$Id: repmgr_stat.html 63573 2008-05-23 21:43:21Z trent.nelson $-->
|
|
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
|
|
<!--See the file LICENSE for redistribution information.-->
|
|
<html>
|
|
<head>
|
|
<title>Berkeley DB: DbEnv::repmgr_stat</title>
|
|
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
|
|
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
|
|
</head>
|
|
<body bgcolor=white>
|
|
<table width="100%"><tr valign=top>
|
|
<td>
|
|
<b>DbEnv::repmgr_stat</b>
|
|
</td>
|
|
<td align=right>
|
|
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
|
|
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
|
|
</tr></table>
|
|
<hr size=1 noshade>
|
|
<tt>
|
|
<b><pre>
|
|
#include <db_cxx.h>
|
|
<p>
|
|
int
|
|
DbEnv::repmgr_stat(DB_REPMGR_STAT **statp, u_int32_t flags);
|
|
<p>
|
|
int
|
|
DbEnv::repmgr_stat_print(u_int32_t flags);
|
|
</pre></b>
|
|
<hr size=1 noshade>
|
|
<b>Description: DbEnv::repmgr_stat</b>
|
|
<p>The DbEnv::repmgr_stat method returns the replication manager statistics.</p>
|
|
<p>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.</p>
|
|
<p>Statistical structures are stored in allocated memory. If application-specific allocation
|
|
routines have been declared (see <a href="../api_cxx/env_set_alloc.html">DbEnv::set_alloc</a> for more
|
|
information), they are used to allocate the memory; otherwise, the
|
|
standard C library <b>malloc</b>(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.</p>
|
|
<p>The following DB_REPMGR_STAT fields will be filled in:</p>
|
|
<br>
|
|
<b>u_int32_t st_perm_failed;</b><ul compact><li>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.</ul>
|
|
<b>u_int32_t st_msgs_queued;</b><ul compact><li>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.</ul>
|
|
<b>u_int32_t st_msgs_dropped;</b><ul compact><li>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.)</ul>
|
|
<b>u_int32_t st_connection_drop;</b><ul compact><li>The number of times an existing TCP/IP connection failed.</ul>
|
|
<b>u_int32_t st_connect_fail;</b><ul compact><li>The number of times an attempt to open a new TCP/IP connection failed.</ul>
|
|
<br>
|
|
<p>The DbEnv::repmgr_stat method may not be called before the <a href="../api_cxx/env_open.html">DbEnv::open</a> method is called.</p>
|
|
<p>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.
|
|
</p>
|
|
<b>Parameters</b> <br>
|
|
<b>flags</b><ul compact><li>The <b>flags</b> parameter must be set to 0 or
|
|
the following value:
|
|
<br>
|
|
<b><a name="DB_STAT_CLEAR">DB_STAT_CLEAR</a></b><ul compact><li>Reset statistics after returning their values.</ul>
|
|
<br></ul>
|
|
<b>statp</b><ul compact><li>The <b>statp</b> parameter references memory into which
|
|
a pointer to the allocated statistics structure is copied.</ul>
|
|
<br>
|
|
<br><b>Errors</b>
|
|
<p>The DbEnv::repmgr_stat method
|
|
may fail and throw
|
|
<a href="../api_cxx/except_class.html">DbException</a>,
|
|
encapsulating one of the following non-zero errors, or return one of
|
|
the following non-zero errors:</p>
|
|
<br>
|
|
<b>EINVAL</b><ul compact><li>An
|
|
invalid flag value or parameter was specified.</ul>
|
|
<br>
|
|
<hr size=1 noshade>
|
|
<b>Description: DbEnv::repmgr_stat_print</b>
|
|
<p>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
|
|
<a href="../api_cxx/env_set_msgfile.html">DbEnv::set_msgfile</a> method for more information), or passed to an
|
|
application callback function (see the <a href="../api_cxx/env_set_msgcall.html">DbEnv::set_msgcall</a> method for
|
|
more information).</p>
|
|
<p>The DbEnv::repmgr_stat_print method may not be called before the <a href="../api_cxx/env_open.html">DbEnv::open</a> method is called.</p>
|
|
<p>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.
|
|
</p>
|
|
<b>Parameters</b> <br>
|
|
<b>flags</b><ul compact><li>The <b>flags</b> parameter must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one
|
|
or more of the following values:
|
|
<br>
|
|
<b><a name="DB_STAT_ALL">DB_STAT_ALL</a></b><ul compact><li>Display all available information.</ul>
|
|
<b><a name="DB_STAT_CLEAR">DB_STAT_CLEAR</a></b><ul compact><li>Reset statistics after displaying their values.</ul>
|
|
<br></ul>
|
|
<br>
|
|
<hr size=1 noshade>
|
|
<br><b>Class</b>
|
|
<a href="../api_cxx/env_class.html">DbEnv</a>
|
|
<br><b>See Also</b>
|
|
<a href="../api_cxx/rep_list.html">Replication and Related Methods</a>
|
|
</tt>
|
|
<table width="100%"><tr><td><br></td><td align=right>
|
|
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
|
|
</td></tr></table>
|
|
<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
|
|
</body>
|
|
</html>
|