Edit File - File Manager

Edit File: repmgr_site_list.html

<html>
<head>
<title>Berkeley DB: DbEnv::repmgr_site_list</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>
DbEnv::repmgr_site_list
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db_cxx.h&gt;

int
DbEnv::repmgr_site_list(u_int *countp, DB_REPMGR_SITE **listp);
</pre>
<hr size=1 noshade>
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 <a href="../../db4-devel-4.7.25/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 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;<ul compact><li>Environment ID assigned by the replication manager.
This is the same value that is passed to the application's
event notification function for the <a href="../../db4-devel-4.7.25/api_cxx/env_event_notify.html#DB_EVENT_REP_NEWMASTER">DB_EVENT_REP_NEWMASTER</a> event.</ul>
char host[];<ul compact><li>Nul-terminated host name.</ul>
u_int port;<ul compact><li>TCP/IP port number.</ul>
u_int32_t status;<ul compact><li>One of the following list of constants: <a name="DB_REPMGR_CONNECTED">DB_REPMGR_CONNECTED</a>,
<a name="DB_REPMGR_DISCONNECTED">DB_REPMGR_DISCONNECTED</a>.</ul>
 
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<ul compact><li>A count of the returned structures will be stored into the memory
referenced by countp.</ul>
 listp<ul compact><li>A reference to an array of structures will be stored into the memory
referenced by listp.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_cxx/env_class.html">DbEnv</a>
 See Also
<a href="../../db4-devel-4.7.25/api_cxx/rep_list.html">Replication and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager