From: Date: November 19 2008 3:33pm
Subject: svn commit - mysqldoc@docsrva: r12540 - in trunk: dynamic-docs/changelog ndbapi
List-Archive: http://lists.mysql.com/commits/59235
Message-Id: <200811191433.mAJEXKv8003446@docsrva.mysql.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
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 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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:
+
+
+
+
+ The MGM API now provides its own
+ SIGPIPE handler to catch the
+ broken pipe
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.
+
+
+
+
+
+ A new function
+ ndb_mgm_set_ignore_sigpipe() has been
+ added to the MGM API. This function makes it possible to
+ bypass the SIGPIPE handler provded by
+ the MGM API.
+
+
+
+
+
+
+
+
+
+
+
+
+
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 @@
+
+
+ <literal>ndb_mgm_set_ignore_sigpipe()</literal>
+
+
+ ndb_mgm_set_ignore_sigpipe() function (MGM API)
+
+
+
+
+ Description
+
+
+ Beginning with MySQL Cluster NDB 6.3.19, the MGM API by
+ default installs a signal handler that ignores all
+ SIGPIPE signals that might occur when
+ writing to asocket that has been closed or reset. An
+ application that provides its own handler for
+ SIGPIPE 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
+ ndb_mgm_create_handle() but before
+ calling ndb_mgm_connect(), which causes
+ the MGM API's SIGPIPE handler to be
+ installed unless overridden.)
+
+
+
+ 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)
+
+
+
+
+
+
+
+
+ Signature
+
+
+
+int ndb_mgm_set_ignore_sigpipe
+ (
+ NdbMgmHandle handle,
+ int ignore = 1
+ )
+
+
+
+
+
+
+
+ Parameters
+
+
+ This function takes two parameters:
+
+
+
+
+
+ A management server handle
+
+
+
+
+
+ An integer value which determines whether to
+ ignore
+ SIGPIPE errors. Set this to 1 (the
+ default) to cause the MGM API to ignore
+ SIGPIPE; set to zero if you wish
+ for SIGPIPE to propagate to your
+ MGM API application.
+
+
+
+
+
+
+
+
+
+
+ Return Value
+
+
+ None.
+
+
+
+
+
+
+
+
<literal>ndb_mgm_destroy_handle()</literal>
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 @@
Description
-
+
+
+