diff options
Diffstat (limited to 'docs/api_reference/C/envevent_notify.html')
| -rw-r--r-- | docs/api_reference/C/envevent_notify.html | 174 |
1 files changed, 147 insertions, 27 deletions
diff --git a/docs/api_reference/C/envevent_notify.html b/docs/api_reference/C/envevent_notify.html index 37eea81b..86dcf3ef 100644 --- a/docs/api_reference/C/envevent_notify.html +++ b/docs/api_reference/C/envevent_notify.html @@ -14,7 +14,7 @@ <body> <div xmlns="" class="navheader"> <div class="libver"> - <p>Library Version 11.2.5.3</p> + <p>Library Version 12.1.6.1</p> </div> <table width="100%" summary="Navigation header"> <tr> @@ -81,7 +81,7 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, <div class="titlepage"> <div> <div> - <h3 class="title"><a id="idp59867312"></a>Parameters</h3> + <h3 class="title"><a id="idp1484248"></a>Parameters</h3> </div> </div> </div> @@ -89,7 +89,7 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, <div class="titlepage"> <div> <div> - <h4 class="title"><a id="idp59847048"></a>db_event_fcn</h4> + <h4 class="title"><a id="idp1468880"></a>db_event_fcn</h4> </div> </div> </div> @@ -121,6 +121,74 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, <div class="itemizedlist"> <ul type="circle"> <li> + <p><a id="event_notify_DB_EVENT_FAILCHK_PANIC"></a> + <code class="literal">DB_EVENT_FAILCHK_PANIC</code> + </p> + <p> + The thread is about to return a + <a href="../../programmer_reference/program_errorret.html#program_errorret.DB_RUNRECOVERY" class="olink"> + DB_RUNRECOVERY + </a> + error because a prior panic event has occurred and the + thread has been marked by <a class="xref" href="envfailchk.html" title="DB_ENV->failchk()">DB_ENV->failchk()</a> as being held by a + crashed process. + </p> + <p> + The <span class="bold"><strong>event_info</strong></span> parameter + is a pointer to a <code class="literal">DB_FAILCHK_PANIC_INFO</code> + structure, which contains these fields: + </p> + <pre class="programlisting">int error; +char symptom[DB_FAILURE_SYMPTOM_SIZE];</pre> + <p> + When this event is seen, the database environment has + failed. All threads of control in the database environment + should exit, and recovery should be run. + </p> + <p> + This event is generated only when failchk broadcasting is + configured. You configured broadcasting by + specifying + <code class="literal">--enable-failchk_broadcast</code> + when you compile your Berkeley DB library. + </p> + </li> + <li> + <p><a id="event_notify_DB_EVENT_MUTEX_DIED"></a> + <code class="literal">DB_EVENT_MUTEX_DIED</code> + </p> + <p> + The thread is about to return a + <a href="../../programmer_reference/program_errorret.html#program_errorret.DB_RUNRECOVERY" class="olink"> + DB_RUNRECOVERY + </a> + error because a mutex it requires has been + marked by <a class="xref" href="envfailchk.html" title="DB_ENV->failchk()">DB_ENV->failchk()</a> as being held by a + crashed process. + </p> + <p> + The <span class="bold"><strong>event_info</strong></span> parameter + is a pointer to a <code class="literal">DB_MUTEX_DIED_INFO</code> + structure, which contains these fields: + </p> + <pre class="programlisting"> pid_t mtxdied_pid; +db_threadid_t mtxdied_tid; +db_mutex_t mtxdied_mtx; +char mtxdied_desc[DB_MUTEX_DESCRIBE_STRLEN]; </pre> + <p> + When this event is seen, the database environment has + failed. All threads of control in the database environment + should exit, and recovery should be run. + </p> + <p> + This event is generated only when failchk broadcasting is + configured. You configured broadcasting by + specifying + <code class="literal">--enable-failchk_broadcast</code> + when you compile your Berkeley DB library. + </p> + </li> + <li> <p><a id="event_notify_DB_EVENT_PANIC"></a> <code class="literal">DB_EVENT_PANIC</code> </p> @@ -179,6 +247,33 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, </p> </li> <li> + <p><a id="event_notify_DB_EVENT_REP_AUTOTAKEOVER_FAILED"></a> + <code class="literal">DB_EVENT_REP_AUTOTAKEOVER_FAILED</code> + </p> + <p> + The current subordinate process attempted to + take over as the replication process, but + the attempt failed. + </p> + <p> + The replication process is the main Replication Manager process + which is responsible for sending and processing most Replication + Manager messages. Normally this is the first process started in a + replication group, but when that process shuts down cleanly, a + subordinate process will take over if one is available. + </p> + <p> + This event means that this Replication Manager subordinate process + attempted to take over as the replication process, but it failed. + Replication Manager is not running locally but may be restarted by + invoking <a class="xref" href="repmgrstart.html" title="DB_ENV->repmgr_start()">DB_ENV->repmgr_start()</a>. + </p> + <p> + The <code class="literal">DB_EVENT_REP_AUTOTAKEOVER_FAILED</code> event is provided + only to applications configured for the Replication Manager. + </p> + </li> + <li> <p><a id="event_notify_DB_EVENT_REP_CLIENT"></a> <code class="literal">DB_EVENT_REP_CLIENT</code> </p> @@ -199,7 +294,7 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, <code class="literal">DB_EVENT_REP_CONNECT_BROKEN</code> </p> <p> - A previously established replication message connection between the + A previously established Replication Manager message connection between the local site and a remote site has been broken. This event supplies the EID of the remote site, and an integer error code that identifies the reason the connection was broken. @@ -217,27 +312,39 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, Replication Manager retries broken connections periodically until they are restored. </p> + <p> + The <code class="literal">DB_EVENT_REP_CONNECT_BROKEN</code> event is provided + only to applications configured for the Replication Manager. + </p> </li> <li> <p><a id="event_notify_DB_EVENT_REP_CONNECT_ESTD"></a> <code class="literal">DB_EVENT_REP_CONNECT_ESTD</code> </p> <p> - A replication message connection has been established between the + A Replication Manager message connection has been established between the local site and a remote site. This event supplied the EID of the remote site. </p> + <p> + The <code class="literal">DB_EVENT_REP_CONNECT_ESTD</code> event is provided + only to applications configured for the Replication Manager. + </p> </li> <li> <p><a id="event_notify_DB_EVENT_REP_CONNECT_TRY_FAILED"></a> <code class="literal">DB_EVENT_REP_CONNECT_TRY_FAILED</code> </p> <p> - An attempt to establish a connection between the local site and a + A Replication Manager attempt to establish a connection between the local site and a remote site has failed. This event supplies the EID of the remote site, and an integer error code that identifies the reason the connection attempt failed. </p> + <p> + The <code class="literal">DB_EVENT_REP_CONNECT_TRY_FAILED</code> event is provided + only to applications configured for the Replication Manager. + </p> </li> <li> <p><a id="event_notify_DB_EVENT_REP_DUPMASTER"></a> @@ -254,7 +361,7 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, </p> <p> The <code class="literal">DB_EVENT_REP_DUPMASTER</code> event is provided - only to applications configured for the replication manager. + only to applications configured for the Replication Manager. </p> </li> <li> @@ -262,8 +369,8 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, <code class="literal">DB_EVENT_REP_ELECTED</code> </p> <p> - The local replication site has just won an election. An application - using the Base replication API should arrange for a call to the + The local replication site has just won an election. A + Base API application should call the <a class="xref" href="repstart.html" title="DB_ENV->rep_start()">DB_ENV->rep_start()</a> method after receiving this event, to reconfigure the local environment as a replication master. @@ -288,26 +395,26 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, </p> <p> The <code class="literal">DB_EVENT_REP_ELECTION_FAILED</code> event is - provided only to applications configured for the replication - manager. + provided only to applications configured for the Replication + Manager. </p> </li> <li> - <p><a id="event_notify_DB_EVENT_REP_ELECTION_STARTED"></a> - <code class="literal">DB_EVENT_REP_ELECTION_STARTED</code> + <p><a id="event_notify_DB_EVENT_REP_INIT_DONE"></a> + <code class="literal">DB_EVENT_REP_INIT_DONE</code> </p> <p> - Replication Manager has started an election - to choose a master site. + The local client site has completed an + internal initialization procedure. </p> </li> <li> - <p><a id="event_notify_DB_EVENT_REP_INIT_DONE"></a> - <code class="literal">DB_EVENT_REP_INIT_DONE</code> + <p><a id="event_notify_DB_EVENT_REP_INQUEUE_FULL"></a> + <code class="literal">DB_EVENT_REP_INQUEUE_FULL</code> </p> <p> - Replication Manager has completed an - internal initialization procedure. + Incoming messages will be dropped because the Replication Mananger + incoming queue has reached its maximum threshold. </p> </li> <li> @@ -330,6 +437,11 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, The local site has been removed from the replication group. </p> + <p> + The <code class="literal">DB_EVENT_REP_LOCAL_SITE_REMOVED</code> event is + provided only to applications configured for the Replication + Manager. + </p> </li> <li> <p><a id="event_notify_DB_EVENT_REP_MASTER"></a> @@ -369,7 +481,7 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, </p> <p> The <code class="literal">DB_EVENT_REP_MASTER_FAILURE</code> event is provided - only to applications configured for the replication manager. + only to applications configured for the Replication Manager. </p> </li> <li> @@ -388,7 +500,7 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, <code class="literal">DB_EVENT_REP_PERM_FAILED</code> </p> <p> - The replication manager did not receive enough acknowledgements (based + The Replication Manager did not receive enough acknowledgements (based on the acknowledgement policy configured with <a class="xref" href="repmgrset_ack_policy.html" title="DB_ENV->repmgr_set_ack_policy()">DB_ENV->repmgr_set_ack_policy()</a> ) to ensure a transaction's durability within the replication group. @@ -397,7 +509,7 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, </p> <p> The <code class="literal">DB_EVENT_REP_PERM_FAILED</code> event is provided - only to applications configured for the replication manager. + only to applications configured for the Replication Manager. </p> </li> <li> @@ -405,28 +517,36 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, <code class="literal">DB_EVENT_REP_SITE_ADDED</code> </p> <p> - A new site has joined the group. + A new site has joined the replication group. The <span class="bold"><strong>event_info</strong></span> parameter points to an integer containing the environment ID of the new site. </p> + <p> + The <code class="literal">DB_EVENT_REP_SITE_ADDED</code> event is provided + only to applications configured for the Replication Manager. + </p> </li> <li> <p><a id="event_notify_DB_EVENT_REP_SITE_REMOVED"></a> <code class="literal">DB_EVENT_REP_SITE_REMOVED</code> </p> <p> - An existing remote site has been removed from the group. The + An existing remote site has been removed from the replication group. The <span class="bold"><strong>event_info</strong></span> parameter points to an integer containing the environment ID of the site that was removed. </p> + <p> + The <code class="literal">DB_EVENT_REP_SITE_REOMVED</code> event is provided + only to applications configured for the Replication Manager. + </p> </li> <li> <p><a id="event_notify_DB_EVENT_REP_STARTUPDONE"></a> <code class="literal">DB_EVENT_REP_STARTUPDONE</code> </p> <p> - The client has completed startup synchronization and is now processing + The replication client has completed startup synchronization and is now processing live log records received from the master. </p> </li> @@ -461,7 +581,7 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, <div class="titlepage"> <div> <div> - <h3 class="title"><a id="idp59901560"></a>Class</h3> + <h3 class="title"><a id="idp1552976"></a>Class</h3> </div> </div> </div> @@ -473,7 +593,7 @@ DB_ENV->set_event_notify(DB_ENV *dbenv, <div class="titlepage"> <div> <div> - <h3 class="title"><a id="idp59935176"></a>See Also</h3> + <h3 class="title"><a id="idp1538680"></a>See Also</h3> </div> </div> </div> |