<?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title>DbEnv::repmgr_add_remote_site()</title> <link rel="stylesheet" href="apiReference.css" type="text/css" /> <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" /> <link rel="up" href="rep.html" title="Chapter 11. Replication Methods" /> <link rel="prev" href="repsync.html" title="DbEnv::rep_sync()" /> <link rel="next" href="repmgrget_ack_policy.html" title="DbEnv::repmgr_get_ack_policy()" /> </head> <body> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">DbEnv::repmgr_add_remote_site()</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="repsync.html">Prev</a> </td> <th width="60%" align="center">Chapter 11. Replication Methods </th> <td width="20%" align="right"> <a accesskey="n" href="repmgrget_ack_policy.html">Next</a></td> </tr> </table> <hr /> </div> <div class="sect1" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"><a id="repmgrremote_site"></a>DbEnv::repmgr_add_remote_site()</h2> </div> </div> </div> <pre class="programlisting">#include <db_cxx.h> int DbEnv::repmgr_add_remote_site(const char *host, u_int port, int *eidp, u_int32_t flags);</pre> <p> The <code class="methodname">DbEnv::repmgr_add_remote_site()</code> method adds a new replication site to the Replication Manager's list of known sites. It is not necessary for all sites in a replication group to know about all other sites in the group. </p> <p> The <code class="methodname">DbEnv::repmgr_add_remote_site()</code> method may be called at any time during the life of the application. </p> <p> The <code class="methodname">DbEnv::repmgr_add_remote_site()</code> <span> <span> 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. </span> </span> </p> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="id1707263"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1707268"></a>eidp</h4> </div> </div> </div> <p> If <span class="bold"><strong>eidp</strong></span> is non-NULL, and the database environment has already been opened by calling <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a>, then the environment ID assigned to the remote site is returned in the memory location referenced by <span class="bold"><strong>eidp</strong></span>. </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1707450"></a>flags</h4> </div> </div> </div> <p> The <span class="bold"><strong>flags</strong></span> parameter must be set to 0 or by bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing together one or more of the following values: </p> <div class="itemizedlist"> <ul type="disc"> <li> <p> <code class="literal">DB_REPMGR_PEER</code> </p> <p> Specifying the <code class="literal">DB_REPMGR_PEER</code> flag configures client-to-client synchronization with the specified remote site. </p> <p> Currently, the Replication Manager framework only supports a single client peer, and the last specified peer is used. </p> </li> </ul> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1707471"></a>host</h4> </div> </div> </div> <p> The site's host identification string, generally a TCP/IP host name. </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1707616"></a>port</h4> </div> </div> </div> <p> The port number on which the remote site is receiving. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="id1707625"></a>Errors</h3> </div> </div> </div> <p> The <code class="methodname">DbEnv::repmgr_add_remote_site()</code> <span> <span> method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> exception, encapsulating one of the following non-zero errors, or return one of the following non-zero errors: </span> </span> </p> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1707459"></a>EINVAL</h4> </div> </div> </div> <p> If this method is called from a base replication API application; or if an invalid flag value or parameter was specified. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="id1707460"></a>Class</h3> </div> </div> </div> <p> <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="id1707366"></a>See Also</h3> </div> </div> </div> <p> <a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a> </p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="repsync.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href="rep.html">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="repmgrget_ack_policy.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">DbEnv::rep_sync() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> DbEnv::repmgr_get_ack_policy()</td> </tr> </table> </div> </body> </html>