Update the documentation with latest updates for Node.js client #466

ihsandemir · 2018-10-31T12:54:40Z

Updated the documentation with new document structure and contents.

devOpsHazelcast · 2018-10-31T13:30:51Z

Linux test PASSed.

devOpsHazelcast · 2018-10-31T13:33:00Z

Windows test PASSed.

Serdaro

Approving now, but I will be sending a PR soon after I finish to copyedit the Node.js client's Readme to preserve various content standards among the non-Java client documentation.

…lient README update commit number 2e024a8e20c8e26f3f09542aed1915e14c60f3b6 .

devOpsHazelcast · 2018-11-06T11:25:54Z

Linux test PASSed.

devOpsHazelcast · 2018-11-06T11:44:15Z

Windows test PASSed.

Serdaro

Reviewed.

Serdaro · 2018-11-06T12:49:55Z

README.md

+  * [7.3. Handling Failures](#73-handling-failures)
+    * [7.3.1. Handling Client Connection Failure](#731-handling-client-connection-failure)
+    * [7.3.2. Handling Retry-able Operation Failure](#732-handling-retry-able-operation-failure)    
+    * [7.3.3. Backpressure](#732-backpressure)


(#733-backpressure)

Serdaro · 2018-11-06T12:50:14Z

README.md

+    * [7.3.1. Handling Client Connection Failure](#731-handling-client-connection-failure)
+    * [7.3.2. Handling Retry-able Operation Failure](#732-handling-retry-able-operation-failure)    
+    * [7.3.3. Backpressure](#732-backpressure)
+    * [7.3.4. Client Connection Strategy](#732-client-connection-strategy)


(#734-client-connection-strategy)

Serdaro · 2018-11-06T12:53:52Z

README.md

-    age = reader.readInt( "a" );
-  }
-}
+## 7.3.5 Configure Client Reconnect Strategy


### 7.3.4.1 Configuring Client Reconnect Strategy

Serdaro · 2018-11-06T12:54:51Z

README.md

+    * [7.3.2. Handling Retry-able Operation Failure](#732-handling-retry-able-operation-failure)    
+    * [7.3.3. Backpressure](#732-backpressure)
+    * [7.3.4. Client Connection Strategy](#732-client-connection-strategy)
+    * [7.3.4. Client Reconnect Strategy](#732-client-reconnection-strategy)


7.3.4.1 Configuring Client Reconnect Strategy

README.md

Serdaro · 2018-11-07T08:41:21Z

README.md

+Follow the below steps to build and install Hazelcast C++ client from its source:
+
+1. Clone the project from github: `git clone --recursive git@github.com:hazelcast/hazelcast-cpp-client.git` We use --recursive flag for our dependency on googletest framework.
+2. Create a build directory (e.g. build) from the root of the project. In the build directory, run the cmake command depending on your environment as depicted in the next sections.


Create a build directory, e.g., build, from the ...

Serdaro · 2018-11-07T08:41:58Z

README.md

+* Java 6 or newer
+* Maven
+* cmake
+* openssl


Serdaro · 2018-11-07T08:42:47Z

README.md

+* openssl
+* Python 2 and pip (Needed for RemoteController used for controlling server instances)
+
+You can also pull our test docker images from docker hub using the command: `docker pull ihsan/gcc_346_ssl` This images has all the tools for building the project. 


You can also pull our test docker images from the docker hub using the following command: docker pull ihsan/gcc_346_ssl. These images have all the tools for building the project.

Serdaro · 2018-11-07T08:43:25Z

README.md

+- Windows: `./testWindowsSingleCase.bat 64 SHARED Debug`
+
+### 8.2.1 Tested Platforms
+Our CI tests are run continuously on the following platforms and compilers:


Our CI tests run ...

Serdaro · 2018-11-07T08:43:53Z

README.md

+Sometimes you may want to reproduce the released library for your own compiler environment. You need to run the release script and it will produce a release folder named "cpp".
+
+Note: 
+- The default release scripts require that you have openssl (version 1.0.2) installed in your development environment.


... have OpenSSL ...

Serdaro

Two minor leftovers.

Serdaro · 2018-11-07T11:20:49Z

README.md

-    HazelcastClient client(config);
-    mixedtype::HazelcastClient &hazelcastClient = client.toMixedType();
-``` 
-The `mixedtype::HazelcastClient` interface is designed to provide you the data structures which allows you to work with any object types in a mixed manner. For example, the interface allows you to provide


I think the above comment has been skipped.

Serdaro · 2018-11-07T11:22:06Z

README.md

@@ -795,489 +1118,281 @@ You can set the protocol as one of the following values:
 ```
 sslv2, sslv3, tlsv1, sslv23, tlsv11, tlsv12
 ```
-The default value for the protocol if not set is tlsv12. The SSLConfig.setEnabled should be called explicitly to enable the SSL.
-The path of the certificate should be correctly provided. 
+The SSLConfig.setEnabled should be called explicitly to enable the SSL. The path of the certificate should be correctly provided. 


The previous review has been skipped:

The SSLConfig.setEnabled method should be called explicitly to enable the SSL.

devOpsHazelcast · 2018-11-07T11:45:43Z

Windows test PASSed.

devOpsHazelcast · 2018-11-07T11:58:27Z

Linux test PASSed.

Serdaro

👍

devOpsHazelcast · 2018-11-07T13:25:44Z

Linux test PASSed.

devOpsHazelcast · 2018-11-07T13:41:25Z

Windows test PASSed.

devOpsHazelcast · 2018-11-07T13:52:00Z

Linux test PASSed.

devOpsHazelcast · 2018-11-07T15:36:14Z

Windows test PASSed.

devOpsHazelcast · 2018-11-08T09:01:31Z

Windows test FAILed.

devOpsHazelcast · 2018-11-08T09:24:31Z

Linux test FAILed.

…table is recommended. Added the section headings for "to be added sections" for Performance and Logging.

devOpsHazelcast · 2018-11-08T12:42:02Z

Windows test PASSed.

devOpsHazelcast · 2018-11-08T13:06:35Z

Linux test FAILed.

devOpsHazelcast · 2018-11-09T13:58:49Z

Linux test PASSed.

devOpsHazelcast · 2018-11-09T14:10:08Z

Windows test PASSed.

devOpsHazelcast · 2018-11-12T14:54:35Z

Windows test PASSed.

devOpsHazelcast · 2018-11-12T15:12:59Z

Linux test PASSed.

devOpsHazelcast · 2018-11-12T15:19:20Z

Linux test PASSed.

devOpsHazelcast · 2018-11-12T15:32:16Z

Windows test PASSed.

SaitTalhaNisanci · 2018-11-14T10:26:14Z

README.md

+
+Note that `Employee` is implementing `Portable`. As portable types are not deserialized on server side for querying, you don't need to implement its Java equivalent on the server side.
+
+For type that are not of portable types, you need to implement its Java equivalent and its serializable factory on the server side for server to reconstitute the objects from binary formats. 


I think the beginning should be something like For nonportable types

Instead of saying For type that are not of portable types, we can say For the non-portable types.

For the non-portable types, you need ...

Serdaro · 2018-11-15T09:38:24Z

README.md

-  * [7.9 Mixed Object Types Supporting HazelcastClient](#79-mixed-object-types-supporting-hazelcastclient)
-    * [7.9.1 TypedData API](#791-typeddata-api) 
+  * [7.8. Performance](#78-performance)
+  * [7.8.1. Partition Aware](#781-partition-aware)


more indentation for 7.8.1 is needed.

Serdaro · 2018-11-15T09:38:47Z

README.md

@@ -624,7 +626,7 @@ When Hazelcast serializes an object into Data (byte array):

 1. It first checks whether the object pointer is NULL.

-2. If the above check fails, then the object is serialized using the serializer that matches the object type. The object type is determined using the free function `int32_t getHazelcastTypeId(const T *object);`. This method returns the constant built-int serializer type ID for the built-in types such as int32_t, bool, short and byte. If it does not match any of the built-in types, it may match the types offered by Hazelcast, i.e., IdentifiedDataSerializable, Portable or custom. The matching is done based on method parameter matching. 
+2. If the above check fails, then the object is serialized using the serializer that matches the object type. The object type is determined using the free function `int32_t getHazelcastTypeId(const T *object);`. This method returns the constant built-int serializer type ID for the built-in types such as `byte`, `char`, `int32_t`, `bool`, `int64_t`, etc. If it does not match any of the built-in types, it may match the types offered by Hazelcast, i.e., IdentifiedDataSerializable, Portable or custom. The matching is done based on method parameter matching. 


... such as byte, char, int32_t, bool and int64_t.

Serdaro · 2018-11-15T09:40:18Z

README.md

    std::string name;
    bool active;
    double salary;
 };
 ```

-Note that `Employee` is an `IdentifiedDataSerializable` object. If you just want to save the `Employee` objects as byte arrays on the map, you don't need to implement its equivalent on the server-side. However, if you want to query on the `employee` map, the server needs the `Employee` objects rather than byte array formats. Therefore, you need to implement its Java equivalent and its data serializable factory on the server side for server to reconstitute the objects from binary formats. After implementing the Java class and its factory, you need to add the factory to the data serializable factories or the portable factories by giving a factory `id`. The following is an example declarative configuration on the server.
+Note that `Employee` is implementing `Portable`. As portable types are not deserialized on server side for querying, you don't need to implement its Java equivalent on the server side.


... on the server side for querying ...

Serdaro · 2018-11-15T09:40:42Z

README.md

+
+Note that `Employee` is implementing `Portable`. As portable types are not deserialized on server side for querying, you don't need to implement its Java equivalent on the server side.
+
+For type that are not of portable types, you need to implement its Java equivalent and its serializable factory on the server side for server to reconstitute the objects from binary formats. 


For the non-portable types, you need ...

devOpsHazelcast · 2018-11-15T10:09:05Z

Windows test PASSed.

devOpsHazelcast · 2018-11-15T10:15:09Z

Linux test PASSed.

devOpsHazelcast · 2018-11-15T10:21:28Z

Linux test FAILed.

devOpsHazelcast · 2018-11-15T10:28:45Z

Linux test PASSed.

devOpsHazelcast · 2018-11-15T10:46:34Z

Windows test PASSed.

devOpsHazelcast · 2018-11-15T11:24:11Z

Windows test PASSed.

Updated the documentation with new document structure and contents.

2b379d9

ihsandemir added Type: Documentation Estimation: M labels Oct 31, 2018

ihsandemir added this to the 3.11 milestone Oct 31, 2018

ihsandemir self-assigned this Oct 31, 2018

ihsandemir requested review from sancar, Serdaro and furkansenharputlu October 31, 2018 12:54

Serdaro approved these changes Nov 1, 2018

View reviewed changes

Rebased with changes for Node.js client up and including to Node.js c…

855f8f8

…lient README update commit number 2e024a8e20c8e26f3f09542aed1915e14c60f3b6 .

sancar approved these changes Nov 7, 2018

View reviewed changes

Serdaro suggested changes Nov 7, 2018

View reviewed changes

Review comment fixes.

047a8ea

Serdaro reviewed Nov 7, 2018

View reviewed changes

More review comment fixes.

07db7d8

Serdaro approved these changes Nov 7, 2018

View reviewed changes

Minor correction with feedback from the team.

5f14273

Merge branch 'master' into docUpdate

b029c0c

Changed query example to use Portable and more explanation to why Por…

9dc6134

…table is recommended. Added the section headings for "to be added sections" for Performance and Logging.

Added missing headings in the index.

17b2877

ihsandemir added 2 commits November 12, 2018 17:16

Added transactions section.

444b998

Update to transactions section.

c842174

SaitTalhaNisanci reviewed Nov 14, 2018

View reviewed changes

ihsandemir and others added 2 commits November 15, 2018 12:31

Updated based on Node.js Logger and Statistics PRs.

7ad411e

Merge branch 'master' into docUpdate

0199aa9

Serdaro suggested changes Nov 15, 2018

View reviewed changes

Review comment fixes.

599717c

Serdaro approved these changes Nov 15, 2018

View reviewed changes

ihsandemir merged commit 07d36d8 into hazelcast:master Nov 15, 2018

ihsandemir deleted the docUpdate branch November 15, 2018 11:25


		Note that `Employee` is implementing `Portable`. As portable types are not deserialized on server side for querying, you don't need to implement its Java equivalent on the server side.

		For type that are not of portable types, you need to implement its Java equivalent and its serializable factory on the server side for server to reconstitute the objects from binary formats.

Update the documentation with latest updates for Node.js client #466

Update the documentation with latest updates for Node.js client #466

Conversation

ihsandemir commented Oct 31, 2018

devOpsHazelcast commented Oct 31, 2018

devOpsHazelcast commented Oct 31, 2018

Serdaro left a comment • edited Loading

Choose a reason for hiding this comment

devOpsHazelcast commented Nov 6, 2018

devOpsHazelcast commented Nov 6, 2018

Serdaro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Serdaro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devOpsHazelcast commented Nov 7, 2018

devOpsHazelcast commented Nov 7, 2018

Serdaro left a comment

Choose a reason for hiding this comment

devOpsHazelcast commented Nov 7, 2018

devOpsHazelcast commented Nov 7, 2018

devOpsHazelcast commented Nov 7, 2018

devOpsHazelcast commented Nov 7, 2018

devOpsHazelcast commented Nov 8, 2018

devOpsHazelcast commented Nov 8, 2018

devOpsHazelcast commented Nov 8, 2018

devOpsHazelcast commented Nov 8, 2018

devOpsHazelcast commented Nov 9, 2018

devOpsHazelcast commented Nov 9, 2018

devOpsHazelcast commented Nov 12, 2018

devOpsHazelcast commented Nov 12, 2018

devOpsHazelcast commented Nov 12, 2018

devOpsHazelcast commented Nov 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devOpsHazelcast commented Nov 15, 2018

devOpsHazelcast commented Nov 15, 2018

devOpsHazelcast commented Nov 15, 2018

devOpsHazelcast commented Nov 15, 2018

devOpsHazelcast commented Nov 15, 2018

devOpsHazelcast commented Nov 15, 2018

Serdaro left a comment •

edited

Loading