svn commit - mysqldoc@docsrva: r10058 - trunk/ndbapi

[jon]

Author: jstephens
Date: 2008-02-28 17:54:24 +0100 (Thu, 28 Feb 2008)
New Revision: 10058

Log:

Added descriptions of missing Ndb_cluster_connection methods set_name()
and set_timeout().

Fixes Docs Bug #34709



Modified:
   trunk/ndbapi/class-member-template.xml
   trunk/ndbapi/class-ndb-cluster-connection.xml


Modified: trunk/ndbapi/class-member-template.xml
===================================================================
--- trunk/ndbapi/class-member-template.xml	2008-02-28 15:40:05 UTC (rev 10057)
+++ trunk/ndbapi/class-member-template.xml	2008-02-28 16:54:24 UTC (rev 10058)
Changed blocks: 1, Lines Added: 3, Lines Deleted: 3; 725 bytes

@@ -2,21 +2,21 @@
 <!DOCTYPE section SYSTEM "http://www.docbook.org/xml/4.3/docbookx.dtd">
 <section id="class-">
 
-  <title><literal/></title>
+  <title><literal></literal></title>
 
   <indexterm>
     <primary>()</primary>
   </indexterm>
 
   <indexterm>
-    <primary>() (method of &lt;literal/&gt;)</primary>
+    <primary>() (method of )</primary>
   </indexterm>
 
   <formalpara>
 
     <title>Description</title>
 
-    <para/>
+    <para></para>
 
   </formalpara>
 


Modified: trunk/ndbapi/class-ndb-cluster-connection.xml
===================================================================
--- trunk/ndbapi/class-ndb-cluster-connection.xml	2008-02-28 15:40:05 UTC (rev 10057)
+++ trunk/ndbapi/class-ndb-cluster-connection.xml	2008-02-28 16:54:24 UTC (rev 10058)
Changed blocks: 2, Lines Added: 160, Lines Deleted: 1; 4036 bytes

@@ -183,9 +183,17 @@
       <tbody>
         <row>
          
<entry><literal>Ndb_cluster_connection()</literal></entry>
-          <entry>Constructor; Creates a connection to a cluster of data
nodes.</entry>
+          <entry>Constructor; creates a connection to a cluster of data
nodes.</entry>
         </row>
         <row>
+          <entry><literal>set_name()</literal></entry>
+          <entry>Provides a name for the connection</entry>
+        </row>
+        <row>
+          <entry><literal>set_timeout()</literal></entry>
+          <entry>Sets a connection timeout</entry>
+        </row>
+        <row>
           <entry><literal>connect()</literal></entry>
           <entry>Connects to a cluster management server.</entry>
         </row>

@@ -343,6 +351,157 @@
 
     </section>
 
+    <section id="class-ndb-cluster-connection-set-name">
+
+      <title><literal></literal></title>
+
+      <indexterm>
+        <primary>Ndb_cluster_connection::set_name()</primary>
+      </indexterm>
+
+      <indexterm>
+        <primary>set_name() (method of Ndb_cluster_connection)</primary>
+      </indexterm>
+
+      <formalpara>
+
+        <title>Description</title>
+
+        <para>
+          Sets a name for the connection. If the name is specified, it
+          is reported in the cluster log.
+        </para>
+
+      </formalpara>
+
+      <formalpara>
+
+        <title>Signature</title>
+
+        <para>
+<programlisting>
+void set_name
+    (
+      const char* <replaceable>name</replaceable>
+    )
+</programlisting>
+        </para>
+
+      </formalpara>
+
+      <formalpara>
+
+        <title>Parameters</title>
+
+        <para>
+          The <replaceable>name</replaceable> to be used as an
+          identifier for the connection.
+        </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="class-ndb-cluster-connection-set-timeout">
+
+     
<title><literal>Ndb_cluster_connection::set_timeout()</literal></title>
+
+      <indexterm>
+        <primary>Ndb_cluster_connection::set_timeout()</primary>
+      </indexterm>
+
+      <indexterm>
+        <primary>set_timeout() (method of Ndb_cluster_connection)</primary>
+      </indexterm>
+
+      <formalpara>
+
+        <title>Description</title>
+
+        <para>
+          Used to set a timeout for the connection, to limit the amount
+          of time that we may block when connecting.
+        </para>
+
+      </formalpara>
+
+      <formalpara>
+
+        <title>Signature</title>
+
+        <para>
+<programlisting>
+int set_timeout
+    (
+      int <replaceable>timeout_ms</replaceable>
+    )
+</programlisting>
+        </para>
+
+      </formalpara>
+
+      <formalpara>
+
+        <title>Parameters</title>
+
+        <para>
+          The length of the timeout, in milliseconds
+          (<replaceable>timeout_ms</replaceable>). Currently, only
+          multiples of 1000 are accepted.
+        </para>
+
+      </formalpara>
+
+      <formalpara>
+
+        <title>Return Value</title>
+
+        <para>
+          0 on success; any other value indicates failure.
+        </para>
+
+      </formalpara>
+
+<!--
+      <formalpara>
+        
+        <title>Example</title>
+        
+        <para>
+          <programlisting>
+[<emphasis>To be supplied...</emphasis>]
+</programlisting>
+        </para>
+        
+      </formalpara>
+-->
+
+    </section>
+
     <section id="class-ndb-cluster-connection-connect">
 
      
<title><literal>Ndb_cluster_connection::connect()</literal></title>