You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by is...@apache.org on 2018/11/27 16:19:47 UTC
ignite git commit: IGNITE-8718: Fixed doxygen comments in C++
Repository: ignite
Updated Branches:
refs/heads/master 190600281 -> 903173302
IGNITE-8718: Fixed doxygen comments in C++
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo
Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/90317330
Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/90317330
Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/90317330
Branch: refs/heads/master
Commit: 9031733028ed79a35924319301279d3a2de8afbb
Parents: 1906002
Author: Igor Sapego <is...@apache.org>
Authored: Tue Nov 27 19:17:16 2018 +0300
Committer: Igor Sapego <is...@apache.org>
Committed: Tue Nov 27 19:17:16 2018 +0300
----------------------------------------------------------------------
.../include/ignite/binary/binary_object.h | 1 +
.../include/ignite/binary/binary_raw_reader.h | 20 ++++++++++
.../include/ignite/binary/binary_raw_writer.h | 38 +++++++++++++++++-
.../include/ignite/binary/binary_reader.h | 26 ++++++++++--
.../include/ignite/binary/binary_writer.h | 42 ++++++++++++++++++--
5 files changed, 120 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/ignite/blob/90317330/modules/platforms/cpp/binary/include/ignite/binary/binary_object.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/binary/include/ignite/binary/binary_object.h b/modules/platforms/cpp/binary/include/ignite/binary/binary_object.h
index 4edbe84..bbad488 100644
--- a/modules/platforms/cpp/binary/include/ignite/binary/binary_object.h
+++ b/modules/platforms/cpp/binary/include/ignite/binary/binary_object.h
@@ -68,6 +68,7 @@ namespace ignite
* @param mem Binary object memory.
* @param start Object starting position in memory.
* @param idRslvr ID resolver.
+ * @param metaMgr Metadata manager.
*/
BinaryObject(impl::interop::InteropMemory& mem, int32_t start,
impl::binary::BinaryIdResolver* idRslvr, impl::binary::BinaryTypeManager* metaMgr) :
http://git-wip-us.apache.org/repos/asf/ignite/blob/90317330/modules/platforms/cpp/binary/include/ignite/binary/binary_raw_reader.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/binary/include/ignite/binary/binary_raw_reader.h b/modules/platforms/cpp/binary/include/ignite/binary/binary_raw_reader.h
index 73d2525..dd7a696 100644
--- a/modules/platforms/cpp/binary/include/ignite/binary/binary_raw_reader.h
+++ b/modules/platforms/cpp/binary/include/ignite/binary/binary_raw_reader.h
@@ -342,6 +342,11 @@ namespace ignite
/**
* Start string array read.
*
+ * Every time you get a BinaryStringArrayReader from BinaryRawReader
+ * you start reading session. Only one single reading session can be
+ * open at a time. So it is not allowed to start new reading session
+ * until all elements of the collection have been read.
+ *
* @return String array reader.
*/
BinaryStringArrayReader ReadStringArray();
@@ -349,6 +354,11 @@ namespace ignite
/**
* Start array read.
*
+ * Every time you get a BinaryArrayReader from BinaryRawReader you
+ * start reading session. Only one single reading session can be
+ * open at a time. So it is not allowed to start new reading session
+ * until all elements of the collection have been read.
+ *
* @return Array reader.
*/
template<typename T>
@@ -364,6 +374,11 @@ namespace ignite
/**
* Start collection read.
*
+ * Every time you get a BinaryCollectionReader from BinaryRawReader
+ * you start reading session. Only one single reading session can be
+ * open at a time. So it is not allowed to start new reading session
+ * until all elements of the collection have been read.
+ *
* @return Collection reader.
*/
template<typename T>
@@ -392,6 +407,11 @@ namespace ignite
/**
* Start map read.
*
+ * Every time you get a BinaryMapReader from BinaryRawReader you
+ * start reading session. Only one single reading session can be
+ * open at a time. So it is not allowed to start new reading session
+ * until all elements of the collection have been read.
+ *
* @return Map reader.
*/
template<typename K, typename V>
http://git-wip-us.apache.org/repos/asf/ignite/blob/90317330/modules/platforms/cpp/binary/include/ignite/binary/binary_raw_writer.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/binary/include/ignite/binary/binary_raw_writer.h b/modules/platforms/cpp/binary/include/ignite/binary/binary_raw_writer.h
index 9dc73df..857d7f2 100644
--- a/modules/platforms/cpp/binary/include/ignite/binary/binary_raw_writer.h
+++ b/modules/platforms/cpp/binary/include/ignite/binary/binary_raw_writer.h
@@ -242,7 +242,7 @@ namespace ignite
* @param val Array.
* @param len Array length.
*/
- void WriteTimeArray(const Time* val, const int32_t len);
+ void WriteTimeArray(const Time* val, int32_t len);
/**
* Write string.
@@ -272,6 +272,12 @@ namespace ignite
/**
* Start string array write.
*
+ * Every time you get a BinaryStringArrayWriter from BinaryRawWriter
+ * you start writing session. Only one single writing session can be
+ * open at a time. So it is not allowed to start new writing session
+ * without calling BinaryStringArrayWriter::Close() method prior on
+ * obtained BinaryStringArrayWriter class instance.
+ *
* @return String array writer.
*/
BinaryStringArrayWriter WriteStringArray();
@@ -284,6 +290,12 @@ namespace ignite
/**
* Start array write.
*
+ * Every time you get a BinaryArrayWriter from BinaryRawWriter you
+ * start writing session. Only one single writing session can be
+ * open at a time. So it is not allowed to start new writing session
+ * without calling BinaryArrayWriter::Close() method prior on
+ * obtained BinaryArrayWriter class instance.
+ *
* @return Array writer.
*/
template<typename T>
@@ -297,6 +309,12 @@ namespace ignite
/**
* Start collection write.
*
+ * Every time you get a BinaryCollectionWriter from BinaryRawWriter
+ * you start writing session. Only one single writing session can be
+ * open at a time. So it is not allowed to start new writing session
+ * without calling BinaryCollectionWriter::Close() method prior on
+ * obtained BinaryCollectionWriter class instance.
+ *
* @return Collection writer.
*/
template<typename T>
@@ -308,6 +326,12 @@ namespace ignite
/**
* Start collection write.
*
+ * Every time you get a BinaryCollectionWriter from BinaryRawWriter
+ * you start writing session. Only one single writing session can be
+ * open at a time. So it is not allowed to start new writing session
+ * without calling BinaryCollectionWriter::Close() method prior on
+ * obtained BinaryCollectionWriter class instance.
+ *
* @param typ Collection type.
* @return Collection writer.
*/
@@ -347,6 +371,12 @@ namespace ignite
/**
* Start map write.
*
+ * Every time you get a BinaryMapWriter from BinaryRawWriter you
+ * start writing session. Only one single writing session can be
+ * open at a time. So it is not allowed to start new writing session
+ * without calling BinaryMapWriter::Close() method prior on obtained
+ * BinaryMapWriter class instance.
+ *
* @return Map writer.
*/
template<typename K, typename V>
@@ -358,6 +388,12 @@ namespace ignite
/**
* Start map write.
*
+ * Every time you get a BinaryMapWriter from BinaryRawWriter you
+ * start writing session. Only one single writing session can be
+ * open at a time. So it is not allowed to start new writing session
+ * without calling BinaryMapWriter::Close() method prior on obtained
+ * BinaryMapWriter class instance.
+ *
* @param typ Map type.
* @return Map writer.
*/
http://git-wip-us.apache.org/repos/asf/ignite/blob/90317330/modules/platforms/cpp/binary/include/ignite/binary/binary_reader.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/binary/include/ignite/binary/binary_reader.h b/modules/platforms/cpp/binary/include/ignite/binary/binary_reader.h
index 7103fec..acd9d61 100644
--- a/modules/platforms/cpp/binary/include/ignite/binary/binary_reader.h
+++ b/modules/platforms/cpp/binary/include/ignite/binary/binary_reader.h
@@ -272,7 +272,7 @@ namespace ignite
* to resulting array and returned value will contain required array length.
* -1 will be returned in case array in stream was null.
*/
- int32_t ReadDateArray(const char* fieldName, Date* res, const int32_t len);
+ int32_t ReadDateArray(const char* fieldName, Date* res, int32_t len);
/**
* Read Timestamp. Maps to "Timestamp" type in Java.
@@ -293,7 +293,7 @@ namespace ignite
* to resulting array and returned value will contain required array length.
* -1 will be returned in case array in stream was null.
*/
- int32_t ReadTimestampArray(const char* fieldName, Timestamp* res, const int32_t len);
+ int32_t ReadTimestampArray(const char* fieldName, Timestamp* res, int32_t len);
/**
* Read Time. Maps to "Time" type in Java.
@@ -314,7 +314,7 @@ namespace ignite
* to resulting array and returned value will contain required array length.
* -1 will be returned in case array in stream was null.
*/
- int32_t ReadTimeArray(const char* fieldName, Time* res, const int32_t len);
+ int32_t ReadTimeArray(const char* fieldName, Time* res, int32_t len);
/**
* Read string.
@@ -355,6 +355,11 @@ namespace ignite
/**
* Start string array read.
*
+ * Every time you get a BinaryStringArrayReader from BinaryReader
+ * you start reading session. Only one single reading session can be
+ * open at a time. So it is not allowed to start new reading session
+ * until all elements of the collection have been read.
+ *
* @param fieldName Field name.
* @return String array reader.
*/
@@ -363,6 +368,11 @@ namespace ignite
/**
* Start array read.
*
+ * Every time you get a BinaryArrayReader from BinaryReader you
+ * start reading session. Only one single reading session can be
+ * open at a time. So it is not allowed to start new reading session
+ * until all elements of the collection have been read.
+ *
* @param fieldName Field name.
* @return Array reader.
*/
@@ -379,6 +389,11 @@ namespace ignite
/**
* Start collection read.
*
+ * Every time you get a BinaryCollectionReader from BinaryReader you
+ * start reading session. Only one single reading session can be
+ * open at a time. So it is not allowed to start new reading session
+ * until all elements of the collection have been read.
+ *
* @param fieldName Field name.
* @return Collection reader.
*/
@@ -409,6 +424,11 @@ namespace ignite
/**
* Start map read.
*
+ * Every time you get a BinaryMapReader from BinaryReader you start
+ * reading session. Only one single reading session can be open at
+ * a time. So it is not allowed to start new reading session until
+ * all elements of the collection have been read.
+ *
* @param fieldName Field name.
* @return Map reader.
*/
http://git-wip-us.apache.org/repos/asf/ignite/blob/90317330/modules/platforms/cpp/binary/include/ignite/binary/binary_writer.h
----------------------------------------------------------------------
diff --git a/modules/platforms/cpp/binary/include/ignite/binary/binary_writer.h b/modules/platforms/cpp/binary/include/ignite/binary/binary_writer.h
index e609591..3dc1241 100644
--- a/modules/platforms/cpp/binary/include/ignite/binary/binary_writer.h
+++ b/modules/platforms/cpp/binary/include/ignite/binary/binary_writer.h
@@ -228,7 +228,7 @@ namespace ignite
* @param val Array.
* @param len Array length.
*/
- void WriteDateArray(const char* fieldName, const Date* val, const int32_t len);
+ void WriteDateArray(const char* fieldName, const Date* val, int32_t len);
/**
* Write Timestamp. Maps to "Timestamp" type in Java.
@@ -245,7 +245,7 @@ namespace ignite
* @param val Array.
* @param len Array length.
*/
- void WriteTimestampArray(const char* fieldName, const Timestamp* val, const int32_t len);
+ void WriteTimestampArray(const char* fieldName, const Timestamp* val, int32_t len);
/**
* Write Time. Maps to "Time" type in Java.
@@ -262,7 +262,7 @@ namespace ignite
* @param val Array.
* @param len Array length.
*/
- void WriteTimeArray(const char* fieldName, const Time* val, const int32_t len);
+ void WriteTimeArray(const char* fieldName, const Time* val, int32_t len);
/**
* Write string.
@@ -295,6 +295,12 @@ namespace ignite
/**
* Start string array write.
*
+ * Every time you get a BinaryStringArrayWriter from BinaryWriter
+ * you start writing session. Only one single writing session can be
+ * open at a time. So it is not allowed to start new writing session
+ * without calling BinaryStringArrayWriter::Close() method prior on
+ * obtained BinaryStringArrayWriter class instance.
+ *
* @param fieldName Field name.
* @return String array writer.
*/
@@ -310,6 +316,12 @@ namespace ignite
/**
* Start array write.
*
+ * Every time you get a BinaryArrayWriter from BinaryWriter you
+ * start writing session. Only one single writing session can be
+ * open at a time. So it is not allowed to start new writing session
+ * without calling BinaryArrayWriter::Close() method prior on
+ * obtained BinaryArrayWriter class instance.
+ *
* @param fieldName Field name.
* @return Array writer.
*/
@@ -324,6 +336,12 @@ namespace ignite
/**
* Start collection write.
*
+ * Every time you get a BinaryCollectionWriter from BinaryWriter you
+ * start writing session. Only one single writing session can be
+ * open at a time. So it is not allowed to start new writing session
+ * without calling BinaryCollectionWriter::Close() method prior on
+ * obtained BinaryCollectionWriter class instance.
+ *
* @param fieldName Field name.
* @return Collection writer.
*/
@@ -336,6 +354,12 @@ namespace ignite
/**
* Start collection write.
*
+ * Every time you get a BinaryCollectionWriter from BinaryWriter you
+ * start writing session. Only one single writing session can be
+ * open at a time. So it is not allowed to start new writing session
+ * without calling BinaryCollectionWriter::Close() method prior on
+ * obtained BinaryCollectionWriter class instance.
+ *
* @param fieldName Field name.
* @param typ Collection type.
* @return Collection writer.
@@ -378,6 +402,12 @@ namespace ignite
/**
* Start map write.
*
+ * Every time you get a BinaryMapWriter from BinaryWriter you start
+ * writing session. Only one single writing session can be open at
+ * a time. So it is not allowed to start new writing session without
+ * calling BinaryMapWriter::Close() method prior on obtained
+ * BinaryMapWriter class instance.
+ *
* @param fieldName Field name.
* @return Map writer.
*/
@@ -390,6 +420,12 @@ namespace ignite
/**
* Start map write.
*
+ * Every time you get a BinaryMapWriter from BinaryWriter you start
+ * writing session. Only one single writing session can be open at
+ * a time. So it is not allowed to start new writing session without
+ * calling BinaryMapWriter::Close() method prior on obtained
+ * BinaryMapWriter class instance.
+ *
* @param fieldName Field name.
* @param typ Map type.
* @return Map writer.