http://git-wip-us.apache.org/repos/asf/ignite/blob/c56d16fb/modules/platforms/nodejs/api_spec/IgniteClient.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IgniteClient.html b/modules/platforms/nodejs/api_spec/IgniteClient.html new file mode 100644 index 0000000..367ab25 --- /dev/null +++ b/modules/platforms/nodejs/api_spec/IgniteClient.html @@ -0,0 +1,2368 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: IgniteClient</title> + + <script src="scripts/prettify/prettify.js"> </script> + <script src="scripts/prettify/lang-css.js"> </script> + <!--[if lt IE 9]> + <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Class: IgniteClient</h1> + + + + + + +<section> + +<header> + + <h2><span class="attribs"><span class="type-signature"></span></span>IgniteClient<span class="signature">(onStateChanged<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> + + <div class="class-description"><p>Class representing Ignite client.</p></div> + + +</header> + +<article> + <div class="container-overview"> + + + + + <h2>Constructor</h2> + + + + <h4 class="name" id="IgniteClient"><span class="type-signature"></span>new IgniteClient<span class="signature">(onStateChanged<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + <p>Public constructor.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Attributes</th> + + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>onStateChanged</code></td> + + + <td class="type"> + + +<span class="param-type"><a href="IgniteClient.html#.onStateChanged">IgniteClient.onStateChanged</a></span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + null + + </td> + + + <td class="description last"><p>callback called everytime when the client has moved to a new state <a href="IgniteClient.html#.STATE">IgniteClient.STATE</a>.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line60">line 60</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + + + + + + + + + + + + + <h3 class="subsection-title">Members</h3> + + + +<h4 class="name" id=".STATE"><span class="type-signature">(static, readonly) </span>STATE<span class="type-signature"></span></h4> + + + + +<div class="description"> + <p>State of Ignite client.</p> +</div> + + + + + + + + <h5 class="subsection-title">Properties:</h5> + + + +<table class="props"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>DISCONNECTED</code></td> + + + <td class="type"> + + </td> + + + + + + <td class="description last"><p>The client is not connected to any Ignite node, + operations with the Ignite server are not allowed. + This is initial state after a client instance creation. + If connect() method is called, the client moves to CONNECTING state.</p></td> + </tr> + + + + <tr> + + <td class="name"><code>CONNECTING</code></td> + + + <td class="type"> + + </td> + + + + + + <td class="description last"><p>The client tries to connect to an Ignite node, + operations with the Ignite server are not allowed. + If disconnect() method is called, the client moves to DISCONNECTED state. + If not possible to connect to any Ignite node, the client moves to DISCONNECTED state. + If connection to an Ignite node is successful, the client moves to CONNECTED state.</p></td> + </tr> + + + + <tr> + + <td class="name"><code>CONNECTED</code></td> + + + <td class="type"> + + </td> + + + + + + <td class="description last"><p>The client is connected to an Ignite node, + all operations with the Ignite server are allowed. + If connection with the Ignite node is lost, the client moves to CONNECTING state. + If disconnect() method is called, the client moves to DISCONNECTED state.</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line30">line 30</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + + + + + + + <h4 class="name" id="cacheNames"><span class="type-signature">(async) </span>cacheNames<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<string>>}</span></h4> + + + + + + +<div class="description"> + <p>Gets existing cache names.</p> +</div> + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line249">line 249</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + +<h5>Throws:</h5> +<ul> + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if the client is not in CONNECTED <a href="IgniteClient.html#.STATE">IgniteClient.STATE</a>.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IllegalStateError.html">IllegalStateError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if other error.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + </ul> + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>array with the existing cache names. + The array is empty if no caches exist.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">Promise.<Array.<string>></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="connect"><span class="type-signature">(async) </span>connect<span class="signature">(config)</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + <p>Connects the client.</p> +<p>Should be called from DISCONNECTED state only. +Moves the client to CONNECTING state.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>config</code></td> + + + <td class="type"> + + +<span class="param-type"><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></span> + + + + </td> + + + + + + <td class="description last"><p>the client configuration.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line100">line 100</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + +<h5>Throws:</h5> +<ul> + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if the client is not in DISCONNECTED <a href="IgniteClient.html#.STATE">IgniteClient.STATE</a>.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IllegalStateError.html">IllegalStateError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if other error.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + </ul> + + + + + + + + + + + + + + <h4 class="name" id="createCache"><span class="type-signature">(async) </span>createCache<span class="signature">(name, cacheConfig<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="CacheClient.html">CacheClient</a>>}</span></h4> + + + + + + +<div class="description"> + <p>Creates new cache with the provided name and optional configuration.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Attributes</th> + + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>name</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + <td class="attributes"> + + + + + + </td> + + + + <td class="default"> + + </td> + + + <td class="description last"><p>cache name.</p></td> + </tr> + + + + <tr> + + <td class="name"><code>cacheConfig</code></td> + + + <td class="type"> + + +<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + null + + </td> + + + <td class="description last"><p>cache configuration.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line132">line 132</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + +<h5>Throws:</h5> +<ul> + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if the client is not in CONNECTED <a href="IgniteClient.html#.STATE">IgniteClient.STATE</a>.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IllegalStateError.html">IllegalStateError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if cache with the provided name already exists.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="OperationError.html">OperationError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if other error.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + </ul> + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>new cache client instance for the created cache.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">Promise.<<a href="CacheClient.html">CacheClient</a>></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="destroyCache"><span class="type-signature">(async) </span>destroyCache<span class="signature">(name)</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + <p>Destroys cache with the provided name.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>name</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"><p>cache name.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line200">line 200</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + +<h5>Throws:</h5> +<ul> + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if the client is not in CONNECTED <a href="IgniteClient.html#.STATE">IgniteClient.STATE</a>.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IllegalStateError.html">IllegalStateError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if cache with the provided name does not exist.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="OperationError.html">OperationError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if other error.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + </ul> + + + + + + + + + + + + + + <h4 class="name" id="disconnect"><span class="type-signature"></span>disconnect<span class="signature">()</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + <p>Disconnects the client.</p> +<p>Moves the client to DISCONNECTED state from any other state. +Does nothing if the client already disconnected.</p> +</div> + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line112">line 112</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + + + + + + <h4 class="name" id="getCache"><span class="type-signature"></span>getCache<span class="signature">(name)</span><span class="type-signature"> → {<a href="CacheClient.html">CacheClient</a>}</span></h4> + + + + + + +<div class="description"> + <p>Gets cache client instance of cache with the provided name. +The method does not check if the cache with the provided name exists.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>name</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"><p>cache name.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line184">line 184</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + +<h5>Throws:</h5> + + + +<dl> + <dt> + <div class="param-desc"> + <p>if error.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>new cache client instance.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="CacheClient.html">CacheClient</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getCacheConfiguration"><span class="type-signature">(async) </span>getCacheConfiguration<span class="signature">(name)</span><span class="type-signature"> → {Promise.<<a href="CacheConfiguration.html">CacheConfiguration</a>>}</span></h4> + + + + + + +<div class="description"> + <p>Returns configuration of cache with the provided name.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>name</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"><p>cache name.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line222">line 222</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + +<h5>Throws:</h5> +<ul> + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if the client is not in CONNECTED <a href="IgniteClient.html#.STATE">IgniteClient.STATE</a>.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IllegalStateError.html">IllegalStateError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if cache with the provided name does not exist.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="OperationError.html">OperationError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if other error.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + </ul> + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>cache configuration</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">Promise.<<a href="CacheConfiguration.html">CacheConfiguration</a>></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getOrCreateCache"><span class="type-signature">(async) </span>getOrCreateCache<span class="signature">(name, cacheConfig<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="CacheClient.html">CacheClient</a>>}</span></h4> + + + + + + +<div class="description"> + <p>Gets existing cache with the provided name +or creates new one with the provided name and optional configuration.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Attributes</th> + + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>name</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + <td class="attributes"> + + + + + + </td> + + + + <td class="default"> + + </td> + + + <td class="description last"><p>cache name.</p></td> + </tr> + + + + <tr> + + <td class="name"><code>cacheConfig</code></td> + + + <td class="type"> + + +<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + null + + </td> + + + <td class="description last"><p>cache configuration (ignored if cache + with the provided name already exists).</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line161">line 161</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + +<h5>Throws:</h5> +<ul> + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if the client is not in CONNECTED <a href="IgniteClient.html#.STATE">IgniteClient.STATE</a>.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IllegalStateError.html">IllegalStateError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + + <li> + +<dl> + <dt> + <div class="param-desc"> + <p>if other error.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + +</li> + </ul> + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>new cache client instance for the existing or created cache.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">Promise.<<a href="CacheClient.html">CacheClient</a>></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setDebug"><span class="type-signature"></span>setDebug<span class="signature">(value)</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + <p>Enables/disables the library debug output (including errors logging). +Disabled by default.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>value</code></td> + + + <td class="type"> + + +<span class="param-type">boolean</span> + + + + </td> + + + + + + <td class="description last"><p>true to enable, false to disable</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line266">line 266</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + + + + <h3 class="subsection-title">Type Definitions</h3> + + + + + + + + <h4 class="name" id=".onStateChanged"><span class="type-signature"></span>onStateChanged<span class="signature">(state, reason)</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + <p>onStateChanged callback.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>state</code></td> + + + <td class="type"> + + +<span class="param-type"><a href="IgniteClient.html#.STATE">IgniteClient.STATE</a></span> + + + + </td> + + + + + + <td class="description last"><p>the new state of the client.</p></td> + </tr> + + + + <tr> + + <td class="name"><code>reason</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"><p>the reason why the state has been changed.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClient.js.html">IgniteClient.js</a>, <a href="IgniteClient.js.html#line80">line 80</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + + + +</article> + +</section> + + + + +</div> + +<nav> + <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</ a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 22 2018 12:08:49 GMT+0300 (Russia TZ 2 Standard Time) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/ignite/blob/c56d16fb/modules/platforms/nodejs/api_spec/IgniteClient.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IgniteClient.js.html b/modules/platforms/nodejs/api_spec/IgniteClient.js.html new file mode 100644 index 0000000..3083c27 --- /dev/null +++ b/modules/platforms/nodejs/api_spec/IgniteClient.js.html @@ -0,0 +1,343 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Source: IgniteClient.js</title> + + <script src="scripts/prettify/prettify.js"> </script> + <script src="scripts/prettify/lang-css.js"> </script> + <!--[if lt IE 9]> + <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Source: IgniteClient.js</h1> + + + + + + + <section> + <article> + <pre class="prettyprint source linenums"><code>/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +'use strict'; + +const CacheClient = require('./CacheClient'); +const IgniteClientConfiguration = require('./IgniteClientConfiguration'); +const CacheConfiguration = require('./CacheConfiguration'); +const BinaryUtils = require('./internal/BinaryUtils'); +const BinaryWriter = require('./internal/BinaryWriter'); +const BinaryReader = require('./internal/BinaryReader'); +const BinaryTypeStorage = require('./internal/BinaryTypeStorage'); +const ArgumentChecker = require('./internal/ArgumentChecker'); +const Logger = require('./internal/Logger'); + +/** + * State of Ignite client. + * + * @typedef IgniteClient.STATE + * @enum + * @readonly + * @property DISCONNECTED The client is not connected to any Ignite node, + * operations with the Ignite server are not allowed. + * This is initial state after a client instance creation. + * If connect() method is called, the client moves to CONNECTING state. + * @property CONNECTING The client tries to connect to an Ignite node, + * operations with the Ignite server are not allowed. + * If disconnect() method is called, the client moves to DISCONNECTED state. + * If not possible to connect to any Ignite node, the client moves to DISCONNECTED state. + * If connection to an Ignite node is successful, the client moves to CONNECTED state. + * @property CONNECTED The client is connected to an Ignite node, + * all operations with the Ignite server are allowed. + * If connection with the Ignite node is lost, the client moves to CONNECTING state. + * If disconnect() method is called, the client moves to DISCONNECTED state. + */ +const STATE = Object.freeze({ + DISCONNECTED : 0, + CONNECTING : 1, + CONNECTED : 2 +}); + +/** + * Class representing Ignite client. + * + */ +class IgniteClient { + + /** + * Public constructor. + * + * @param {IgniteClient.onStateChanged} [onStateChanged] - + * callback called everytime when the client has moved to a new state {@link IgniteClient.STATE}. + * + * @return {IgniteClient} - new IgniteClient instance. + */ + constructor(onStateChanged = null) { + const ClientFailoverSocket = require('./internal/ClientFailoverSocket'); + this._socket = new ClientFailoverSocket(onStateChanged); + BinaryTypeStorage.createEntity(this._socket); + } + + static get STATE() { + return STATE; + } + + /** + * onStateChanged callback. + * @callback IgniteClient.onStateChanged + * @param {IgniteClient.STATE} state - the new state of the client. + * @param {string} reason - the reason why the state has been changed. + */ + + /** + * Connects the client. + * + * Should be called from DISCONNECTED state only. + * Moves the client to CONNECTING state. + * + * @async + * + * @param {IgniteClientConfiguration} config - the client configuration. + * + * @throws {IllegalStateError} if the client is not in DISCONNECTED {@link IgniteClient.STATE}. + * @throws {IgniteClientError} if other error. + */ + async connect(config) { + ArgumentChecker.notEmpty(config, 'config'); + ArgumentChecker.hasType(config, 'config', false, IgniteClientConfiguration); + await this._socket.connect(config); + } + + /** + * Disconnects the client. + * + * Moves the client to DISCONNECTED state from any other state. + * Does nothing if the client already disconnected. + */ + disconnect() { + if (this._socket) { + this._socket.disconnect(); + } + } + + /** + * Creates new cache with the provided name and optional configuration. + * + * @async + * + * @param {string} name - cache name. + * @param {CacheConfiguration} [cacheConfig] - cache configuration. + * + * @return {Promise<CacheClient>} - new cache client instance for the created cache. + * + * @throws {IllegalStateError} if the client is not in CONNECTED {@link IgniteClient.STATE}. + * @throws {OperationError} if cache with the provided name already exists. + * @throws {IgniteClientError} if other error. + */ + async createCache(name, cacheConfig = null) { + ArgumentChecker.notEmpty(name, 'name'); + ArgumentChecker.hasType(cacheConfig, 'cacheConfig', false, CacheConfiguration); + + await this._socket.send( + cacheConfig ? + BinaryUtils.OPERATION.CACHE_CREATE_WITH_CONFIGURATION : + BinaryUtils.OPERATION.CACHE_CREATE_WITH_NAME, + async (payload) => { + await this._writeCacheNameOrConfig(payload, name, cacheConfig); + }); + return this._getCache(name, cacheConfig); + } + + /** + * Gets existing cache with the provided name + * or creates new one with the provided name and optional configuration. + * + * @async + * + * @param {string} name - cache name. + * @param {CacheConfiguration} [cacheConfig] - cache configuration (ignored if cache + * with the provided name already exists). + * + * @return {Promise<CacheClient>} - new cache client instance for the existing or created cache. + * + * @throws {IllegalStateError} if the client is not in CONNECTED {@link IgniteClient.STATE}. + * @throws {IgniteClientError} if other error. + */ + async getOrCreateCache(name, cacheConfig = null) { + ArgumentChecker.notEmpty(name, 'name'); + ArgumentChecker.hasType(cacheConfig, 'cacheConfig', false, CacheConfiguration); + await this._socket.send( + cacheConfig ? + BinaryUtils.OPERATION.CACHE_GET_OR_CREATE_WITH_CONFIGURATION : + BinaryUtils.OPERATION.CACHE_GET_OR_CREATE_WITH_NAME, + async (payload) => { + await this._writeCacheNameOrConfig(payload, name, cacheConfig); + }); + return this._getCache(name, cacheConfig); + } + + /** + * Gets cache client instance of cache with the provided name. + * The method does not check if the cache with the provided name exists. + * + * @param {string} name - cache name. + * + * @return {CacheClient} - new cache client instance. + * + * @throws {IgniteClientError} if error. + */ + getCache(name) { + ArgumentChecker.notEmpty(name, 'name'); + return this._getCache(name); + } + + /** + * Destroys cache with the provided name. + * + * @async + * + * @param {string} name - cache name. + * + * @throws {IllegalStateError} if the client is not in CONNECTED {@link IgniteClient.STATE}. + * @throws {OperationError} if cache with the provided name does not exist. + * @throws {IgniteClientError} if other error. + */ + async destroyCache(name) { + ArgumentChecker.notEmpty(name, 'name'); + await this._socket.send( + BinaryUtils.OPERATION.CACHE_DESTROY, + async (payload) => { + payload.writeInteger(CacheClient._calculateId(name)); + }); + } + + /** + * Returns configuration of cache with the provided name. + * + * @async + * + * @param {string} name - cache name. + * + * @return {Promise<CacheConfiguration>} - cache configuration + * + * @throws {IllegalStateError} if the client is not in CONNECTED {@link IgniteClient.STATE}. + * @throws {OperationError} if cache with the provided name does not exist. + * @throws {IgniteClientError} if other error. + */ + async getCacheConfiguration(name) { + ArgumentChecker.notEmpty(name, 'name'); + let config; + await this._socket.send( + BinaryUtils.OPERATION.CACHE_GET_CONFIGURATION, + async (payload) => { + payload.writeInteger(CacheClient._calculateId(name)); + payload.writeByte(0); + }, + async (payload) => { + config = new CacheConfiguration(); + await config._read(payload); + }); + return config; + } + + /** + * Gets existing cache names. + * + * @async + * + * @return {Promise<Array<string>>} - array with the existing cache names. + * The array is empty if no caches exist. + * + * @throws {IllegalStateError} if the client is not in CONNECTED {@link IgniteClient.STATE}. + * @throws {IgniteClientError} if other error. + */ + async cacheNames() { + let names; + await this._socket.send( + BinaryUtils.OPERATION.CACHE_GET_NAMES, + null, + async (payload) => { + names = await BinaryReader.readStringArray(payload); + }); + return names; + } + + /** + * Enables/disables the library debug output (including errors logging). + * Disabled by default. + * + * @param {boolean} value - true to enable, false to disable + */ + setDebug(value) { + Logger.debug = value; + } + + /** Private methods */ + + /** + * @ignore + */ + _getCache(name, cacheConfig = null) { + return new CacheClient(name, cacheConfig, this._socket); + } + + /** + * @ignore + */ + async _writeCacheNameOrConfig(buffer, name, cacheConfig) { + if (cacheConfig) { + await cacheConfig._write(buffer, name); + } + else { + await BinaryWriter.writeString(buffer, name); + } + } +} + +module.exports = IgniteClient; +</code></pre> + </article> + </section> + + + + +</div> + +<nav> + <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</ a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 22 2018 12:08:48 GMT+0300 (Russia TZ 2 Standard Time) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/ignite/blob/c56d16fb/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.html b/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.html new file mode 100644 index 0000000..5ef0860 --- /dev/null +++ b/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.html @@ -0,0 +1,846 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: IgniteClientConfiguration</title> + + <script src="scripts/prettify/prettify.js"> </script> + <script src="scripts/prettify/lang-css.js"> </script> + <!--[if lt IE 9]> + <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Class: IgniteClientConfiguration</h1> + + + + + + +<section> + +<header> + + <h2><span class="attribs"><span class="type-signature"></span></span>IgniteClientConfiguration<span class="signature">(…endpoints)</span><span class="type-signature"></span></h2> + + <div class="class-description"><p>Class representing Ignite client configuration.</p> +<p>The configuration includes:</p> +<ul> +<li>(mandatory) Ignite node endpoint(s)</li> +<li>(optional) user credentials for authentication</li> +<li>(optional) TLS enabling</li> +<li>(optional) connection options</li> +</ul></div> + + +</header> + +<article> + <div class="container-overview"> + + + + + <h2>Constructor</h2> + + + + <h4 class="name" id="IgniteClientConfiguration"><span class="type-signature"></span>new IgniteClientConfiguration<span class="signature">(…endpoints)</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + <p>Creates an instance of Ignite client configuration +with the provided mandatory settings and default optional settings.</p> +<p>By default, the client does not use authentication and secure connection.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Attributes</th> + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>endpoints</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + <td class="attributes"> + + + + + + <repeatable><br> + + </td> + + + + + <td class="description last"><p>Ignite node endpoint(s). + The client randomly connects/reconnects to one of the specified node.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClientConfiguration.js.html">IgniteClientConfiguration.js</a>, <a href="IgniteClientConfiguration.js.html#line34">line 34</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + + + + + + + <h4 class="name" id="setConnectionOptions"><span class="type-signature"></span>setConnectionOptions<span class="signature">(useTLS, connectionOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a>}</span></h4> + + + + + + +<div class="description"> + <p>Sets connection options.</p> +<p>By default the client establishes a non-secure connection with default connection options defined by nodejs.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Attributes</th> + + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>useTLS</code></td> + + + <td class="type"> + + +<span class="param-type">boolean</span> + + + + </td> + + + <td class="attributes"> + + + + + + </td> + + + + <td class="default"> + + </td> + + + <td class="description last"><p>if true, secure connection will be established; + if false, non-secure connection will be established.</p></td> + </tr> + + + + <tr> + + <td class="name"><code>connectionOptions</code></td> + + + <td class="type"> + + +<span class="param-type">object</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + null + + </td> + + + <td class="description last"><p>connection options.</p> +<ul> +<li>For non-secure connection options defined here <a href="https://nodejs.org/api/net.html#net_net_createconnection_options_connectlistener";>https://nodejs.org/api/net.html#net_net_createconnection_options_connectlistener</a></li> +<li>For secure connection options defined here <a href="https://nodejs.org/api/tls.html#tls_tls_connect_options_callback";>https://nodejs.org/api/tls.html#tls_tls_connect_options_callback</a></li> +</ul></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClientConfiguration.js.html">IgniteClientConfiguration.js</a>, <a href="IgniteClientConfiguration.js.html#line105">line 105</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the IgniteClientConfiguration.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setPassword"><span class="type-signature"></span>setPassword<span class="signature">(password)</span><span class="type-signature"> → {<a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a>}</span></h4> + + + + + + +<div class="description"> + <p>Sets password which will be used for authentication during the client's connection.</p> +<p>Password is ignored, if username is not set. +If password is not set, it is considered empty.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>password</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"><p>password. If null, password is empty.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClientConfiguration.js.html">IgniteClientConfiguration.js</a>, <a href="IgniteClientConfiguration.js.html#line87">line 87</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + +<h5>Throws:</h5> + + + +<dl> + <dt> + <div class="param-desc"> + <p>if error.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the IgniteClientConfiguration.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setUserName"><span class="type-signature"></span>setUserName<span class="signature">(userName)</span><span class="type-signature"> → {<a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a>}</span></h4> + + + + + + +<div class="description"> + <p>Sets username which will be used for authentication during the client's connection.</p> +<p>If username is not set, the client does not use authentication during connection.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>userName</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"><p>username. If null, authentication is disabled.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="IgniteClientConfiguration.js.html">IgniteClientConfiguration.js</a>, <a href="IgniteClientConfiguration.js.html#line70">line 70</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + +<h5>Throws:</h5> + + + +<dl> + <dt> + <div class="param-desc"> + <p>if error.</p> + </div> + </dt> + <dd></dd> + <dt> + <dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span> + + + </dd> + </dl> + </dt> + <dd></dd> +</dl> + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the IgniteClientConfiguration.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + +</article> + +</section> + + + + +</div> + +<nav> + <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</ a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 22 2018 12:08:49 GMT+0300 (Russia TZ 2 Standard Time) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ignite/blob/c56d16fb/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.js.html b/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.js.html new file mode 100644 index 0000000..f587c46 --- /dev/null +++ b/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.js.html @@ -0,0 +1,163 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Source: IgniteClientConfiguration.js</title> + + <script src="scripts/prettify/prettify.js"> </script> + <script src="scripts/prettify/lang-css.js"> </script> + <!--[if lt IE 9]> + <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Source: IgniteClientConfiguration.js</h1> + + + + + + + <section> + <article> + <pre class="prettyprint source linenums"><code>/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +'use strict'; + +const FS = require('fs'); +const Util = require('util'); +const Errors = require('./Errors'); +const ArgumentChecker = require('./internal/ArgumentChecker'); + +/** + * Class representing Ignite client configuration. + * + * The configuration includes: + * - (mandatory) Ignite node endpoint(s) + * - (optional) user credentials for authentication + * - (optional) TLS enabling + * - (optional) connection options + */ +class IgniteClientConfiguration { + + /** + * Creates an instance of Ignite client configuration + * with the provided mandatory settings and default optional settings. + * + * By default, the client does not use authentication and secure connection. + * + * @param {...string} endpoints - Ignite node endpoint(s). + * The client randomly connects/reconnects to one of the specified node. + * + * @return {IgniteClientConfiguration} - new client configuration instance. + * + * @throws {IgniteClientError} if error. + */ + constructor(...endpoints) { + ArgumentChecker.notEmpty(endpoints, 'endpoints'); + this._endpoints = endpoints; + this._userName = null; + this._password = null; + this._useTLS = false; + this._options = null; + } + + + /** + * Sets username which will be used for authentication during the client's connection. + * + * If username is not set, the client does not use authentication during connection. + * + * @param {string} userName - username. If null, authentication is disabled. + * + * @return {IgniteClientConfiguration} - the same instance of the IgniteClientConfiguration. + * + * @throws {IgniteClientError} if error. + */ + setUserName(userName) { + this._userName = userName; + return this; + } + + /** + * Sets password which will be used for authentication during the client's connection. + * + * Password is ignored, if username is not set. + * If password is not set, it is considered empty. + * + * @param {string} password - password. If null, password is empty. + * + * @return {IgniteClientConfiguration} - the same instance of the IgniteClientConfiguration. + * + * @throws {IgniteClientError} if error. + */ + setPassword(password) { + this._password = password; + return this; + } + + /** + * Sets connection options. + * + * By default the client establishes a non-secure connection with default connection options defined by nodejs. + * + * @param {boolean} useTLS - if true, secure connection will be established; + * if false, non-secure connection will be established. + * @param {object} [connectionOptions=null] - connection options. + * - For non-secure connection options defined here {@link https://nodejs.org/api/net.html#net_net_createconnection_options_connectlistener} + * - For secure connection options defined here {@link https://nodejs.org/api/tls.html#tls_tls_connect_options_callback} + * + * @return {IgniteClientConfiguration} - the same instance of the IgniteClientConfiguration. + */ + setConnectionOptions(useTLS, connectionOptions = null) { + this._useTLS = useTLS; + this._options = connectionOptions; + return this; + } +} + +module.exports = IgniteClientConfiguration; +</code></pre> + </article> + </section> + + + + +</div> + +<nav> + <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</ a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 22 2018 12:08:48 GMT+0300 (Russia TZ 2 Standard Time) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/ignite/blob/c56d16fb/modules/platforms/nodejs/api_spec/IgniteClientError.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IgniteClientError.html b/modules/platforms/nodejs/api_spec/IgniteClientError.html new file mode 100644 index 0000000..b17225d --- /dev/null +++ b/modules/platforms/nodejs/api_spec/IgniteClientError.html @@ -0,0 +1,168 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: IgniteClientError</title> + + <script src="scripts/prettify/prettify.js"> </script> + <script src="scripts/prettify/lang-css.js"> </script> + <!--[if lt IE 9]> + <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Class: IgniteClientError</h1> + + + + + + +<section> + +<header> + + <h2><span class="attribs"><span class="type-signature"></span></span>IgniteClientError<span class="signature">()</span><span class="type-signature"></span></h2> + + <div class="class-description"><p>Base Ignite client error class.</p></div> + + +</header> + +<article> + <div class="container-overview"> + + + + + <h2>Constructor</h2> + + + + <h4 class="name" id="IgniteClientError"><span class="type-signature"></span>new IgniteClientError<span class="signature">()</span><span class="type-signature"></span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="Errors.js.html">Errors.js</a>, <a href="Errors.js.html#line25">line 25</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + + + + + + + + + + + + + + + + + + +</article> + +</section> + + + + +</div> + +<nav> + <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</ a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 22 2018 12:08:49 GMT+0300 (Russia TZ 2 Standard Time) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ignite/blob/c56d16fb/modules/platforms/nodejs/api_spec/IllegalStateError.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IllegalStateError.html b/modules/platforms/nodejs/api_spec/IllegalStateError.html new file mode 100644 index 0000000..f52677b --- /dev/null +++ b/modules/platforms/nodejs/api_spec/IllegalStateError.html @@ -0,0 +1,179 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: IllegalStateError</title> + + <script src="scripts/prettify/prettify.js"> </script> + <script src="scripts/prettify/lang-css.js"> </script> + <!--[if lt IE 9]> + <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Class: IllegalStateError</h1> + + + + + + +<section> + +<header> + + <h2><span class="attribs"><span class="type-signature"></span></span>IllegalStateError<span class="signature">()</span><span class="type-signature"></span></h2> + + <div class="class-description"><p>Ignite client is not in an appropriate state for the requested operation.</p></div> + + +</header> + +<article> + <div class="container-overview"> + + + + + <h2>Constructor</h2> + + + + <h4 class="name" id="IllegalStateError"><span class="type-signature"></span>new IllegalStateError<span class="signature">()</span><span class="type-signature"></span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="Errors.js.html">Errors.js</a>, <a href="Errors.js.html#line102">line 102</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + <h3 class="subsection-title">Extends</h3> + + + + + <ul> + <li><a href="IgniteClientError.html">IgniteClientError</a></li> + </ul> + + + + + + + + + + + + + + + + + + + + + +</article> + +</section> + + + + +</div> + +<nav> + <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</ a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 22 2018 12:08:49 GMT+0300 (Russia TZ 2 Standard Time) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ignite/blob/c56d16fb/modules/platforms/nodejs/api_spec/LostConnectionError.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/LostConnectionError.html b/modules/platforms/nodejs/api_spec/LostConnectionError.html new file mode 100644 index 0000000..74a0d1a --- /dev/null +++ b/modules/platforms/nodejs/api_spec/LostConnectionError.html @@ -0,0 +1,179 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: LostConnectionError</title> + + <script src="scripts/prettify/prettify.js"> </script> + <script src="scripts/prettify/lang-css.js"> </script> + <!--[if lt IE 9]> + <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Class: LostConnectionError</h1> + + + + + + +<section> + +<header> + + <h2><span class="attribs"><span class="type-signature"></span></span>LostConnectionError<span class="signature">()</span><span class="type-signature"></span></h2> + + <div class="class-description"><p>The requested operation is not completed due to the connection lost.</p></div> + + +</header> + +<article> + <div class="container-overview"> + + + + + <h2>Constructor</h2> + + + + <h4 class="name" id="LostConnectionError"><span class="type-signature"></span>new LostConnectionError<span class="signature">()</span><span class="type-signature"></span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="Errors.js.html">Errors.js</a>, <a href="Errors.js.html#line112">line 112</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + <h3 class="subsection-title">Extends</h3> + + + + + <ul> + <li><a href="IgniteClientError.html">IgniteClientError</a></li> + </ul> + + + + + + + + + + + + + + + + + + + + + +</article> + +</section> + + + + +</div> + +<nav> + <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</ a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 22 2018 12:08:49 GMT+0300 (Russia TZ 2 Standard Time) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> \ No newline at end of file
