put all references to async api inside DOXYGEN SKIP_INTERNAL

parent a32f231f
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
This guide assumes a basic familiarity with MySQL Cluster concepts. This guide assumes a basic familiarity with MySQL Cluster concepts.
Some of the fundamental ones are described in section @ref secConcepts. Some of the fundamental ones are described in section @ref secConcepts.
The <em>NDB API</em> is an MySQL Cluster application interface The <em>NDB API</em> is a MySQL Cluster application interface
that implements transactions. that implements transactions.
The NDB API consists of the following fundamental classes: The NDB API consists of the following fundamental classes:
- Ndb_cluster_connection class representing a connection to a cluster, - Ndb_cluster_connection class representing a connection to a cluster,
...@@ -52,9 +52,11 @@ ...@@ -52,9 +52,11 @@
The execute can be of two different types, The execute can be of two different types,
<em>Commit</em> or <em>NoCommit</em>. <em>Commit</em> or <em>NoCommit</em>.
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
(The execute can also be divided into three (The execute can also be divided into three
steps: prepare, send, and poll to get asynchronous steps: prepare, send, and poll to get asynchronous
transactions. More about this later.) transactions. More about this later.)
#endif
If the execute is of type NoCommit, If the execute is of type NoCommit,
then the application program executes part of a transaction, then the application program executes part of a transaction,
...@@ -1229,6 +1231,7 @@ public: ...@@ -1229,6 +1231,7 @@ public:
* @note should be called after the transaction has completed, irrespective * @note should be called after the transaction has completed, irrespective
* of success or failure * of success or failure
* *
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
* @note It is not allowed to call Ndb::closeTransaction after sending the * @note It is not allowed to call Ndb::closeTransaction after sending the
* transaction asynchronously with either * transaction asynchronously with either
* Ndb::sendPreparedTransactions or * Ndb::sendPreparedTransactions or
...@@ -1237,6 +1240,7 @@ public: ...@@ -1237,6 +1240,7 @@ public:
* outstanding transactions and wait until all of them * outstanding transactions and wait until all of them
* has completed before calling Ndb::closeTransaction). * has completed before calling Ndb::closeTransaction).
* If the transaction is not committed it will be aborted. * If the transaction is not committed it will be aborted.
#endif
*/ */
void closeTransaction(NdbTransaction*); void closeTransaction(NdbTransaction*);
......
...@@ -88,7 +88,9 @@ class NdbColumnImpl; ...@@ -88,7 +88,9 @@ class NdbColumnImpl;
* - lock mode vs allowed operation is not checked * - lock mode vs allowed operation is not checked
* - too many pending blob ops can blow up i/o buffers * - too many pending blob ops can blow up i/o buffers
* - table and its blob part tables are not created atomically * - table and its blob part tables are not created atomically
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
* - there is no support for an asynchronous interface * - there is no support for an asynchronous interface
#endif
*/ */
class NdbBlob { class NdbBlob {
public: public:
......
...@@ -362,6 +362,7 @@ public: ...@@ -362,6 +362,7 @@ public:
/** /**
* Close transaction * Close transaction
#ifndef DOXYGEN_SHOULD_SKIP_INTERNAL
* @note It is not allowed to call NdbTransaction::close after sending the * @note It is not allowed to call NdbTransaction::close after sending the
* transaction asynchronously before the callback method has * transaction asynchronously before the callback method has
* been called. * been called.
...@@ -369,6 +370,7 @@ public: ...@@ -369,6 +370,7 @@ public:
* outstanding transactions and wait until all of them * outstanding transactions and wait until all of them
* has completed before calling NdbTransaction::close). * has completed before calling NdbTransaction::close).
* If the transaction is not committed it will be aborted. * If the transaction is not committed it will be aborted.
#endif
*/ */
void close(); void close();
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment