svn commit - mysqldoc@docsrva: r12540 - in trunk: dynamic-docs/changelog ndbapi

[jon]

Author: jstephens
Date: 2008-11-19 15:33:20 +0100 (Wed, 19 Nov 2008)
New Revision: 12540

Log:

Documented fix for Cluster Bug #40498

Documentated new MGM API function ndb_mgm_set_ignore_sigpipe()



Modified:
   trunk/dynamic-docs/changelog/mysqld-1.xml
   trunk/ndbapi/mgm-api.xml
   trunk/ndbapi/mgm-function-template.xml


Modified: trunk/dynamic-docs/changelog/mysqld-1.xml
===================================================================
--- trunk/dynamic-docs/changelog/mysqld-1.xml	2008-11-19 13:27:37 UTC (rev 12539)
+++ trunk/dynamic-docs/changelog/mysqld-1.xml	2008-11-19 14:33:20 UTC (rev 12540)
Changed blocks: 1, Lines Added: 51, Lines Deleted: 0; 1738 bytes

@@ -9,6 +9,57 @@
   <logentry entrytype="bug">
 
     <tags>
+      <highlight type="clusterapi"/>
+      <manual type="mgmapi"/>
+      <manual type="errors"/>
+    </tags>
+
+    <bugs>
+      <fixes bugid="40498"/>
+    </bugs>
+
+    <versions>
+      <version ver="5.1.29-ndb-6.3.19"/>
+    </versions>
+
+    <message>
+
+      <para>
+        MGM API applications exited without raising any errors if the
+        connection to the management server was lost. The fix for this
+        issue includes two changes:
+        <orderedlist>
+
+          <listitem>
+            <para>
+              The MGM API now provides its own
+              <literal>SIGPIPE</literal> handler to catch the
+              <quote>broken pipe</quote> error that occurs when writing
+              to a closed or reset socket. This means that MGM API now
+              behaves the same as NDB API in this regard.
+            </para>
+          </listitem>
+
+          <listitem>
+            <para>
+              A new function
+              <literal>ndb_mgm_set_ignore_sigpipe()</literal> has been
+              added to the MGM API. This function makes it possible to
+              bypass the <literal>SIGPIPE</literal> handler provded by
+              the MGM API.
+            </para>
+          </listitem>
+
+        </orderedlist>
+      </para>
+
+    </message>
+
+  </logentry>
+
+  <logentry entrytype="bug">
+
+    <tags>
       <highlight type="cluster"/>
       <manual type="NoOfReplicas"/>
     </tags>


Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml	2008-11-19 13:27:37 UTC (rev 12539)
+++ trunk/ndbapi/mgm-api.xml	2008-11-19 14:33:20 UTC (rev 12540)
Changed blocks: 1, Lines Added: 113, Lines Deleted: 0; 3458 bytes

@@ -1390,6 +1390,119 @@
 
       </section>
 
+      <section id="ndb-mgm-set-ignore-sigpipe">
+
+       
<title><literal>ndb_mgm_set_ignore_sigpipe()</literal></title>
+
+        <indexterm>
+          <primary>ndb_mgm_set_ignore_sigpipe() function (MGM API)</primary>
+        </indexterm>
+
+        <formalpara>
+
+          <title>Description</title>
+
+          <para>
+            Beginning with MySQL Cluster NDB 6.3.19, the MGM API by
+            default installs a signal handler that ignores all
+            <literal>SIGPIPE</literal> signals that might occur when
+            writing to asocket that has been closed or reset. An
+            application that provides its own handler for
+            <literal>SIGPIPE</literal> should call this function after
+            creating the management server handle and before using the
+            handle to connect to the management server. (In other words,
+            call this function after using
+            <literal>ndb_mgm_create_handle()</literal> but before
+            calling <literal>ndb_mgm_connect()</literal>, which causes
+            the MGM API&apos;s <literal>SIGPIPE</literal> handler to be
+            installed unless overridden.)
+
+            <note>
+              <para>
+                Previous to MySQL Cluster NDB 6.3.19, MGM API
+                applications simply exited without returning an error
+                whenever the connection to the management server was
+                lost. (Bug #40498)
+              </para>
+            </note>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Signature</title>
+
+          <para>
+<programlisting>
+int ndb_mgm_set_ignore_sigpipe
+    (
+      NdbMgmHandle <replaceable>handle</replaceable>, 
+      int <replaceable>ignore</replaceable> = 1
+    )
+</programlisting>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Parameters</title>
+
+          <para>
+            This function takes two parameters:
+
+            <itemizedlist>
+
+              <listitem>
+                <para>
+                  A management server handle
+                </para>
+              </listitem>
+
+              <listitem>
+                <para>
+                  An integer value which determines whether to
+                  <replaceable>ignore</replaceable>
+                  <literal>SIGPIPE</literal> errors. Set this to 1 (the
+                  default) to cause the MGM API to ignore
+                  <literal>SIGPIPE</literal>; set to zero if you wish
+                  for <literal>SIGPIPE</literal> to propagate to your
+                  MGM API application.
+                </para>
+              </listitem>
+
+            </itemizedlist>
+          </para>
+
+        </formalpara>
+
+        <formalpara>
+
+          <title>Return Value</title>
+
+          <para>
+            <emphasis>None</emphasis>.
+          </para>
+
+        </formalpara>
+
+<!--
+        <formalpara>
+
+          <title>Example</title>
+
+          <para>
+<programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+          </para>
+
+        </formalpara>
+-->
+
+      </section>
+
       <section id="ndb-mgm-destroy-handle">
 
        
<title><literal>ndb_mgm_destroy_handle()</literal></title>


Modified: trunk/ndbapi/mgm-function-template.xml
===================================================================
--- trunk/ndbapi/mgm-function-template.xml	2008-11-19 13:27:37 UTC (rev 12539)
+++ trunk/ndbapi/mgm-function-template.xml	2008-11-19 14:33:20 UTC (rev 12540)
Changed blocks: 1, Lines Added: 3, Lines Deleted: 1; 381 bytes

@@ -12,7 +12,9 @@
 
     <title>Description</title>
 
-    <para/>
+    <para>
+      
+    </para>
 
   </formalpara>