Create gh-pages branch via GitHub

index.html

@@ -37,7 +37,9 @@
 <p><em>a nodejs module for local and remote Inter Process Communication</em> for Linux, Mac and Windows.<br>
 A great solution for <strong>Neural Networking</strong> in Node.JS</p>
 
-<p><strong>npm install node-ipc</strong><br><a href="https://npmjs.org/package/node-ipc" title="node-ipc details from npm"><img src="https://nodei.co/npm/node-ipc.png?stars=true" alt="alt node-ipc npm details" title="node-ipc npm module details "></a></p>
+<p><strong>npm install node-ipc</strong><br>
+<img src="https://nodei.co/npm/node-ipc.png?downloads=true&amp;downloadRank=true&amp;stars=true" alt="NPM Stats for node-ipc">
+<img src="https://nodei.co/npm-dl/node-ipc.png?months=6&amp;height=3" alt="NPM Download Graph for node-ipc"></p>
 
 <p>Package details websites :</p>
 
@@ -46,9 +48,13 @@ A great solution for <strong>Neural Networking</strong> in Node.JS</p>
 <a href="http://riaevangelist.github.io/node-ipc/" title="node-ipc documentation">GitHub.io site</a>. A prettier version of this site.</li>
 <li>
 <a href="https://www.npmjs.org/package/node-ipc" title="node-ipc npm module">NPM Module</a>. The npm page for the node-ipc module.</li>
-</ul><p>This work is licenced via the <a href="http://www.dbad-license.org/">DBAD Public Licence</a>. </p>
+</ul>
 
-<hr><h4>
+<p>This work is licenced via the <a href="http://www.dbad-license.org/">DBAD Public Licence</a>. </p>
+
+<hr>
+
+<h4>
 <a name="contents" class="anchor" href="#contents"><span class="octicon octicon-link"></span></a>Contents</h4>
 
 <ol>
@@ -76,15 +82,21 @@ A great solution for <strong>Neural Networking</strong> in Node.JS</p>
 </ol>
 </li>
 <li><a href="https://github.com/RIAEvangelist/node-ipc/tree/master/example">Advanced Examples</a></li>
-</ol><hr><h4>
+</ol>
+
+<hr>
+
+<h4>
 <a name="types-of-ipc-sockets" class="anchor" href="#types-of-ipc-sockets"><span class="octicon octicon-link"></span></a>Types of IPC Sockets</h4>
 
 <table>
-<thead><tr>
+<thead>
+<tr>
 <th>Type</th>
 <th>Stability</th>
 <th>Definition</th>
-</tr></thead>
+</tr>
+</thead>
 <tbody>
 <tr>
 <td>Unix Socket</td>
@@ -110,11 +122,15 @@ A great solution for <strong>Neural Networking</strong> in Node.JS</p>
 </td>
 </tr>
 </tbody>
-</table><table>
+</table>
-<thead><tr>
+
+<table>
+<thead>
+<tr>
 <th>OS</th>
 <th>Supported Sockets</th>
-</tr></thead>
+</tr>
+</thead>
 <tbody>
 <tr>
 <td>Linux</td>
@@ -129,9 +145,13 @@ A great solution for <strong>Neural Networking</strong> in Node.JS</p>
 <td>TCP, TLS, UDP</td>
 </tr>
 </tbody>
-</table><p><strong>Windows</strong> users may want to use UDP servers for the fastest local IPC. Unix Servers are the fastest oprion on Linux and Mac, but not available for windows.  </p>
+</table>
 
-<hr><p><code>ipc.config</code>  </p>
+<p><strong>Windows</strong> users may want to use UDP servers for the fastest local IPC. Unix Servers are the fastest oprion on Linux and Mac, but not available for windows.  </p>
+
+<hr>
+
+<p><code>ipc.config</code>  </p>
 
 <p>Set these variables in the <code>ipc.config</code> scope to overwrite or set default values.</p>
 
@@ -151,10 +171,12 @@ A great solution for <strong>Neural Networking</strong> in Node.JS</p>
 </code></pre>
 
 <table>
-<thead><tr>
+<thead>
+<tr>
 <th>variable</th>
 <th>documentation</th>
-</tr></thead>
+</tr>
+</thead>
 <tbody>
 <tr>
 <td>appspace</td>
@@ -201,12 +223,18 @@ A great solution for <strong>Neural Networking</strong> in Node.JS</p>
 <td>Defaults to false mwaning clients will continue to retryt to connect to servers indefinately at the retry interval. If set to any number the client will stop retrying when that number is exceeded after each disconnect. If set to 0, the client will <strong><em>NOT</em></strong> try to reconnect.</td>
 </tr>
 </tbody>
-</table><hr><h4>
+</table>
+
+<hr>
+
+<h4>
 <a name="ipc-methods" class="anchor" href="#ipc-methods"><span class="octicon octicon-link"></span></a>IPC Methods</h4>
 
 <p>These methods are available in the IPC Scope.  </p>
 
-<hr><h5>
+<hr>
+
+<h5>
 <a name="log" class="anchor" href="#log"><span class="octicon octicon-link"></span></a>log</h5>
 
 <p><code>ipc.log(a,b,c,d,e...);</code>  </p>
@@ -239,7 +267,9 @@ colors.setTheme(
 );
 </code></pre>
 
-<hr><h5>
+<hr>
+
+<h5>
 <a name="connectto" class="anchor" href="#connectto"><span class="octicon octicon-link"></span></a>connectTo</h5>
 
 <p><code>ipc.connectTo(id,path,callback);</code>  </p>
@@ -247,11 +277,13 @@ colors.setTheme(
 <p>Used for connecting as a client to local Unix Sockets. <strong><em>This is the fastst way for processes on the same machine to communicate</em></strong> because it bypasses the network card which TCP and UDP must both use.</p>
 
 <table>
-<thead><tr>
+<thead>
+<tr>
 <th>variable</th>
 <th>required</th>
 <th>definition</th>
-</tr></thead>
+</tr>
+</thead>
 <tbody>
 <tr>
 <td>id</td>
@@ -270,7 +302,9 @@ colors.setTheme(
 <td>this is the function to execute when the socket has been created.</td>
 </tr>
 </tbody>
-</table><p><strong>examples</strong> arguments can be ommitted solong as they are still in order.</p>
+</table>
+
+<p><strong>examples</strong> arguments can be ommitted solong as they are still in order.</p>
 
 <pre><code>ipc.connectTo('world');
 </code></pre>
@@ -310,7 +344,9 @@ colors.setTheme(
 );
 </code></pre>
 
-<hr><h5>
+<hr>
+
+<h5>
 <a name="connecttonet" class="anchor" href="#connecttonet"><span class="octicon octicon-link"></span></a>connectToNet</h5>
 
 <p><code>ipc.connectToNet(id,host,port,callback)</code>  </p>
@@ -318,11 +354,13 @@ colors.setTheme(
 <p>Used to connect as a client to a TCP or TLS socket via the network card. This can be local or remote, if local, it is recommended that you use the Unix Socket Implementaion of <code>connectTo</code> instead as it is much faster since it avoids the network card alltogether.</p>
 
 <table>
-<thead><tr>
+<thead>
+<tr>
 <th>variable</th>
 <th>required</th>
 <th>definition</th>
-</tr></thead>
+</tr>
+</thead>
 <tbody>
 <tr>
 <td>id</td>
@@ -345,7 +383,9 @@ colors.setTheme(
 <td>this is the function to execute when the socket has been created.</td>
 </tr>
 </tbody>
-</table><p><strong>examples</strong> arguments can be ommitted solong as they are still in order.<br>
+</table>
+
+<p><strong>examples</strong> arguments can be ommitted solong as they are still in order.<br>
 So while the default is : (id,host,port,callback), the following examples will still work because they are still in order (id,port,callback) or (id,host,callback) or (id,port) etc.</p>
 
 <pre><code>ipc.connectToNet('world');
@@ -381,7 +421,9 @@ So while the default is : (id,host,port,callback), the following examples will s
 );
 </code></pre>
 
-<hr><h5>
+<hr>
+
+<h5>
 <a name="disconnect" class="anchor" href="#disconnect"><span class="octicon octicon-link"></span></a>disconnect</h5>
 
 <p><code>ipc.disconnect(id)</code>  </p>
@@ -389,22 +431,30 @@ So while the default is : (id,host,port,callback), the following examples will s
 <p>Used to disconnect a client from a Unix, TCP or TLS socket. The socket and its refrence will be removed from memory and the <code>ipc.of</code> scope. This can be local or remote. UDP clients do not maintain connections and so there are no Clients and this method has no value to them.</p>
 
 <table>
-<thead><tr>
+<thead>
+<tr>
 <th>variable</th>
 <th>required</th>
 <th>definition</th>
-</tr></thead>
+</tr>
-<tbody><tr>
+</thead>
+<tbody>
+<tr>
 <td>id</td>
 <td>required</td>
 <td>is the string id of the socket from which to disconnect.</td>
-</tr></tbody>
+</tr>
-</table><p><strong>examples</strong></p>
+</tbody>
+</table>
+
+<p><strong>examples</strong></p>
 
 <pre><code>ipc.disconnect('world');
 </code></pre>
 
-<hr><h5>
+<hr>
+
+<h5>
 <a name="serve" class="anchor" href="#serve"><span class="octicon octicon-link"></span></a>serve</h5>
 
 <p><code>ipc.serve(path,callback);</code>  </p>
@@ -412,11 +462,13 @@ So while the default is : (id,host,port,callback), the following examples will s
 <p>Used to create local Unix Socket Server to which Clients can bind. The server can <code>emit</code> events to specific Client Sockets, or <code>broadcast</code> events to all known Client Sockets.   </p>
 
 <table>
-<thead><tr>
+<thead>
+<tr>
 <th>variable</th>
 <th>required</th>
 <th>definition</th>
-</tr></thead>
+</tr>
+</thead>
 <tbody>
 <tr>
 <td>path</td>
@@ -430,7 +482,9 @@ So while the default is : (id,host,port,callback), the following examples will s
 </td>
 </tr>
 </tbody>
-</table><p><strong><em>examples</em></strong> arguments can be ommitted solong as they are still in order.</p>
+</table>
+
+<p><strong><em>examples</em></strong> arguments can be ommitted solong as they are still in order.</p>
 
 <pre><code>ipc.serve();
 </code></pre>
@@ -457,7 +511,9 @@ So while the default is : (id,host,port,callback), the following examples will s
 );
 </code></pre>
 
-<hr><h5>
+<hr>
+
+<h5>
 <a name="servenet" class="anchor" href="#servenet"><span class="octicon octicon-link"></span></a>serveNet</h5>
 
 <p><code>serveNet(host,port,UDPType,callback)</code></p>
@@ -465,11 +521,13 @@ So while the default is : (id,host,port,callback), the following examples will s
 <p>Used to create TCP, TLS or UDP Socket Server to which Clients can bind or other servers can send data to. The server can <code>emit</code> events to specific Client Sockets, or <code>broadcast</code> events to all known Client Sockets. </p>
 
 <table>
-<thead><tr>
+<thead>
+<tr>
 <th>variable</th>
 <th>required</th>
 <th>definition</th>
-</tr></thead>
+</tr>
+</thead>
 <tbody>
 <tr>
 <td>host</td>
@@ -492,7 +550,9 @@ So while the default is : (id,host,port,callback), the following examples will s
 <td>Function to be called when the server is created</td>
 </tr>
 </tbody>
-</table><p><strong><em>examples</em></strong> arguments can be ommitted solong as they are still in order.</p>
+</table>
+
+<p><strong><em>examples</em></strong> arguments can be ommitted solong as they are still in order.</p>
 
 <p>default tcp server</p>
 
@@ -545,14 +605,18 @@ So while the default is : (id,host,port,callback), the following examples will s
 );
 </code></pre>
 
-<hr><h3>
+<hr>
+
+<h3>
 <a name="ipc-stores-and-default-variables" class="anchor" href="#ipc-stores-and-default-variables"><span class="octicon octicon-link"></span></a>IPC Stores and Default Variables</h3>
 
 <table>
-<thead><tr>
+<thead>
+<tr>
 <th>variable</th>
 <th>definition</th>
-</tr></thead>
+</tr>
+</thead>
 <tbody>
 <tr>
 <td>ipc.of</td>
@@ -564,7 +628,11 @@ So while the default is : (id,host,port,callback), the following examples will s
 </td>
 </tr>
 </tbody>
-</table><hr><h3>
+</table>
+
+<hr>
+
+<h3>
 <a name="basic-examples" class="anchor" href="#basic-examples"><span class="octicon octicon-link"></span></a>Basic Examples</h3>
 
 <p>You can find <a href="https://github.com/RIAEvangelist/node-ipc/tree/master/example">Advanced Examples</a> in the examples folder. In the examples you will find more complex demos including multi client examples.</p>