kvclient-js

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: ProxyConfiguration</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <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: ProxyConfiguration</h1> <section> <header> <h2> ProxyConfiguration </h2> </header> <article> <div class="container-overview"> <dt> <h4 class="name" id="ProxyConfiguration"><span class="type-signature"></span>new ProxyConfiguration<span class="signature">()</span><span class="type-signature"></span></h4> </dt> <dd> <div class="description"> Defines a set of configuration values used to connect or create a proxy instance, this is just the constructor with no parameters, once this object is created feel free to change any parameter. </div> <h5 class="subsection-title">Properties:</h5> <dl> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>startProxy</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last">indicates if the module should try to start a proxy instance from which it will connect to a NoSQL Server</td> </tr> <tr> <td class="name"><code>host</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">indicates the host:port for a proxy to connect, not used when startProxy = true</td> </tr> <tr> <td class="name"><code>KVCLIENT_JAR</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">the path where the file kvclient.jar is located, required to start a local proxy</td> </tr> <tr> <td class="name"><code>PROXY_HOME</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">the path where the proxy files are located, by default they are located in this module path, but a different value can be specified to start a local proxy with different binaries</td> </tr> <tr> <td class="name"><code>kvStoreName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last">the store name to be used</td> </tr> <tr> <td class="name"><code>kvStoreHelperHosts</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Array</span> </td> <td class="description last">the helper hosts to be used by the proxy when connecting to a NoSQL Server</td> </tr> <tr> <td class="name"><code>readZones</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Array</span> </td> <td class="description last">the read zones to be used by the proxy when connecting to a NoSQL Server</td> </tr> <tr> <td class="name"><code>securityProperties</code></td> <td class="type"> <span class="param-type"><a href="SecurityProperties.html">SecurityProperties</a></span> </td> <td class="description last">used for the connection</td> </tr> <tr> <td class="name"><code>requestTimeout</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">a number in milliseconds to specify the timeout default value for a request</td> </tr> <tr> <td class="name"><code>socketOpenTimeout</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">a number in milliseconds to specify the timeout for the socket to connect</td> </tr> <tr> <td class="name"><code>socketReadTimeout</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last">a number in milliseconds to specify the timeout for the socket to read</td> </tr> </tbody> </table> </dl> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Proxy.js.html">Proxy.js</a>, <a href="Proxy.js.html#line127">line 127</a> </li></ul></dd> </dl> </dd> </div> </article> </section> </div> <nav> <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Configuration.html">Configuration</a></li><li><a href="Durability.html">Durability</a></li><li><a href="FieldRange.html">FieldRange</a></li><li><a href="Iterator.html">Iterator</a></li><li><a href="Logger.html">Logger</a></li><li><a href="Operation.html">Operation</a></li><li><a href="ProxyConfiguration.html">ProxyConfiguration</a></li><li><a href="Readable.html">Readable</a></li><li><a href="ReadOptions.html">ReadOptions</a></li><li><a href="SecurityProperties.html">SecurityProperties</a></li><li><a href="Store.html">Store</a></li><li><a href="VerifyProperties.html">VerifyProperties</a></li><li><a href="WriteOptions.html">WriteOptions</a></li></ul><h3>Global</h3><ul><li><a href="global.html#readProxyConfiguration">readProxyConfiguration</a></li><li><a href="global.html#ReplicaAckPolicy">ReplicaAckPolicy</a></li><li><a href="global.html#ReturnChoice">ReturnChoice</a></li><li><a href="global.html#SimpleConsistency">SimpleConsistency</a></li><li><a href="global.html#startProxy">startProxy</a></li><li><a href="global.html#stopProxy">stopProxy</a></li><li><a href="global.html#SyncPolicy">SyncPolicy</a></li></ul> </nav> <br clear="both"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha10</a> on Mon Dec 01 2014 16:17:12 GMT-0600 (CST) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>