Author: jstephens
Date: 2006-06-29 08:39:38 +0200 (Thu, 29 Jun 2006)
New Revision: 2544
Log:
MDM API: ndb_mgm_node_state, ndb_mgm_cluster_state,
and ndb_mgm_reply structs.
Modified:
trunk/ndbapi/mgm-api.xml
Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml 2006-06-29 04:46:56 UTC (rev 2543)
+++ trunk/ndbapi/mgm-api.xml 2006-06-29 06:39:38 UTC (rev 2544)
@@ -5509,6 +5509,125 @@
</formalpara>
+ <formalpara>
+
+ <title>Definition</title>
+
+ <para>
+ This structure contains the following members:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>int
+ <replaceable>node_id</replaceable></literal>: The
+ cluster node's node ID.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enum ndb_mgm_node_type
+ <replaceable>node_type</replaceable></literal>: The node
+ type.
+ </para>
+
+ <para>
+ See <xref linkend="ndb-mgm-node-type"/>, for permitted
+ values.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>enum ndb_mgm_node_status
+ <replaceable>node_status</replaceable></literal>: The
+ node's status.
+ </para>
+
+ <para>
+ See <xref linkend="ndb-mgm-node-status"/>, for permitted
+ values.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>int
+ <replaceable>start_phase</replaceable></literal>: The
+ start phase.
+ </para>
+
+ <para>
+ This is valid only if the
+ <replaceable>node_type</replaceable> is
+ <literal>NDB_MGM_NODE_TYPE_NDB</literal> and the
+ <replaceable>node_status</replaceable> is
+ <literal>NDB_MGM_NODE_STATUS_STARTING</literal>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>int
+ <replaceable>dynamic_id</replaceable></literal>: The ID
+ for heartbeats and master takeover.
+ </para>
+
+ <para>
+ Valid only for data (<command>ndbd</command>) nodes.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>int
+ <replaceable>node_group</replaceable></literal>: The
+ node group to which the node belongs.
+ </para>
+
+ <para>
+ Valid only for data (<command>ndbd</command>) nodes.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>int
+ <replaceable>version</replaceable></literal>: Internal
+ version number.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>int
+ <replaceable>connect_count</replaceable></literal>: The
+ number of times this node has connected to or
+ disconnected from the management server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>char
+ <replaceable>connect_address[]</replaceable></literal>:
+ The IP address of the node when it connected to the
+ management server.
+ </para>
+
+ <para>
+ This value will be empty if the management server has
+ been restarted since the node last connected.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
</section>
<section id="struct-ndb-mgm-cluster-state">
@@ -5520,11 +5639,56 @@
<title>Description</title>
<para>
- Provides information on the status of the Cluster as a whole.
+ Provides information on the status of all Cluster nodes. This
+ structure is returned by
+ <literal>ndb_mgm_get_status()</literal>.
</para>
</formalpara>
+ <formalpara>
+
+ <title>Definition</title>
+
+ <para>
+ This structure has the following two members;
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>int
+ <replaceable>no_of_nodes</replaceable></literal>: The
+ number of elements in the
+ <replaceable>node_states</replaceable> array.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>struct ndb_mgm_node_state
+ <replaceable>node_states[]</replaceable></literal>: An
+ array containing the states of the nodes.
+ </para>
+
+ <para>
+ Each element of this array is an
+ <literal>ndb_mgm_node_state</literal> structure. For
+ more information, see
+ <xref
+ linkend="struct-ndb-mgm-node-state"/>.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <para>
+ See <xref linkend="ndb-mgm-get-status"/>.
+ </para>
+
</section>
<section id="struct-ndb-mgm-reply">
@@ -5536,11 +5700,53 @@
<title>Description</title>
<para>
- Contains response information from the management server.
+ Contains response information, consisting of a response code
+ and a corresponding message, from the management server.
</para>
</formalpara>
+ <formalpara>
+
+ <title>Definition</title>
+
+ <para>
+ This structure contains two members, as shown here:
+
+ <itemizedlist>
+
+ <listitem>
+ <para>
+ <literal>int
+ <replaceable>return_code</replaceable></literal>: For a
+ successful operation, this value is
+ <literal>0</literal>; otherwise, it contains an error
+ code.
+ </para>
+
+ <para>
+ For error codes, see <xref linkend="ndb-mgm-error"/>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <literal>char
+ <replaceable>message[256]</replaceable></literal>:
+ COntains the text of the response or error message.
+ </para>
+ </listitem>
+
+ </itemizedlist>
+ </para>
+
+ </formalpara>
+
+ <para>
+ See <xref linkend="ndb-mgm-get-latest-error"/>, and
+ <xref linkend="ndb-mgm-get-latest-error-msg"/>.
+ </para>
+
</section>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r2544 - trunk/ndbapi | jon | 29 Jun |
