Troplo/node-ipc
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Wiki Activity

Create gh-pages branch via GitHub

Browse source
This commit is contained in:
Brandon Nozaki Miller 2015-04-15 21:39:03 -07:00
parent aab42d360b
commit 978b918b6c
2 changed files with 22 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
index.html
View file

@ -32,7 +32,7 @@
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h1>
<a name="node-ipc" class="anchor" href="#node-ipc"><span class="octicon octicon-link"></span></a>node-ipc</h1>
<a id="node-ipc" class="anchor" href="#node-ipc" aria-hidden="true"><span class="octicon octicon-link"></span></a>node-ipc</h1>
<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>
@ -55,7 +55,7 @@ A great solution for <strong>Neural Networking</strong> in Node.JS</p>
<hr>
<h4>
<a name="contents" class="anchor" href="#contents"><span class="octicon octicon-link"></span></a>Contents</h4>
<a id="contents" class="anchor" href="#contents" aria-hidden="true"><span class="octicon octicon-link"></span></a>Contents</h4>
<ol>
<li><a href="#types-of-ipc-sockets">Types of IPC Sockets and Supporting OS</a></li>
@ -87,7 +87,7 @@ A great solution for <strong>Neural Networking</strong> in Node.JS</p>
<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>
<a id="types-of-ipc-sockets" class="anchor" href="#types-of-ipc-sockets" aria-hidden="true"><span class="octicon octicon-link"></span></a>Types of IPC Sockets</h4>
<table>
<thead>
@ -228,14 +228,14 @@ A great solution for <strong>Neural Networking</strong> in Node.JS</p>
<hr>
<h4>
<a name="ipc-methods" class="anchor" href="#ipc-methods"><span class="octicon octicon-link"></span></a>IPC Methods</h4>
<a id="ipc-methods" class="anchor" href="#ipc-methods" aria-hidden="true"><span class="octicon octicon-link"></span></a>IPC Methods</h4>
<p>These methods are available in the IPC Scope. </p>
<hr>
<h5>
<a name="log" class="anchor" href="#log"><span class="octicon octicon-link"></span></a>log</h5>
<a id="log" class="anchor" href="#log" aria-hidden="true"><span class="octicon octicon-link"></span></a>log</h5>
<p><code>ipc.log(a,b,c,d,e...);</code> </p>
@ -270,7 +270,7 @@ colors.setTheme(
<hr>
<h5>
<a name="connectto" class="anchor" href="#connectto"><span class="octicon octicon-link"></span></a>connectTo</h5>
<a id="connectto" class="anchor" href="#connectto" aria-hidden="true"><span class="octicon octicon-link"></span></a>connectTo</h5>
<p><code>ipc.connectTo(id,path,callback);</code> </p>
@ -347,7 +347,7 @@ colors.setTheme(
<hr>
<h5>
<a name="connecttonet" class="anchor" href="#connecttonet"><span class="octicon octicon-link"></span></a>connectToNet</h5>
<a id="connecttonet" class="anchor" href="#connecttonet" aria-hidden="true"><span class="octicon octicon-link"></span></a>connectToNet</h5>
<p><code>ipc.connectToNet(id,host,port,callback)</code> </p>
@ -424,7 +424,7 @@ So while the default is : (id,host,port,callback), the following examples will s
<hr>
<h5>
<a name="disconnect" class="anchor" href="#disconnect"><span class="octicon octicon-link"></span></a>disconnect</h5>
<a id="disconnect" class="anchor" href="#disconnect" aria-hidden="true"><span class="octicon octicon-link"></span></a>disconnect</h5>
<p><code>ipc.disconnect(id)</code> </p>
@ -455,7 +455,7 @@ So while the default is : (id,host,port,callback), the following examples will s
<hr>
<h5>
<a name="serve" class="anchor" href="#serve"><span class="octicon octicon-link"></span></a>serve</h5>
<a id="serve" class="anchor" href="#serve" aria-hidden="true"><span class="octicon octicon-link"></span></a>serve</h5>
<p><code>ipc.serve(path,callback);</code> </p>
@ -514,7 +514,7 @@ So while the default is : (id,host,port,callback), the following examples will s
<hr>
<h5>
<a name="servenet" class="anchor" href="#servenet"><span class="octicon octicon-link"></span></a>serveNet</h5>
<a id="servenet" class="anchor" href="#servenet" aria-hidden="true"><span class="octicon octicon-link"></span></a>serveNet</h5>
<p><code>serveNet(host,port,UDPType,callback)</code></p>
@ -608,7 +608,7 @@ So while the default is : (id,host,port,callback), the following examples will s
<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>
<a id="ipc-stores-and-default-variables" class="anchor" href="#ipc-stores-and-default-variables" aria-hidden="true"><span class="octicon octicon-link"></span></a>IPC Stores and Default Variables</h3>
<table>
<thead>
@ -633,12 +633,12 @@ So while the default is : (id,host,port,callback), the following examples will s
<hr>
<h3>
<a name="basic-examples" class="anchor" href="#basic-examples"><span class="octicon octicon-link"></span></a>Basic Examples</h3>
<a id="basic-examples" class="anchor" href="#basic-examples" aria-hidden="true"><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>
<h4>
<a name="server-for-unix-sockets--tcp-sockets" class="anchor" href="#server-for-unix-sockets--tcp-sockets"><span class="octicon octicon-link"></span></a>Server for Unix Sockets &amp; TCP Sockets</h4>
<a id="server-for-unix-sockets--tcp-sockets" class="anchor" href="#server-for-unix-sockets--tcp-sockets" aria-hidden="true"><span class="octicon octicon-link"></span></a>Server for Unix Sockets &amp; TCP Sockets</h4>
<p>The server is the process keeping a socket for IPC open. Multiple sockets can connect to this server and talk to it. It can also broadcast to all clients or emit to a specific client. This is the most basic example which will work for both local Unix Sockets and local or remote network TCP Sockets.</p>
@ -666,7 +666,7 @@ ipc.server.start();
</code></pre>
<h4>
<a name="client-for-unix-sockets--tcp-sockets" class="anchor" href="#client-for-unix-sockets--tcp-sockets"><span class="octicon octicon-link"></span></a>Client for Unix Sockets &amp; TCP Sockets</h4>
<a id="client-for-unix-sockets--tcp-sockets" class="anchor" href="#client-for-unix-sockets--tcp-sockets" aria-hidden="true"><span class="octicon octicon-link"></span></a>Client for Unix Sockets &amp; TCP Sockets</h4>
<p>The client connects to the servers socket for Inter Process Communication. The socket will recieve events emitted to it specifically as well as events which are broadcast out on the socket by the server. This is the most basic example which will work for both local Unix Sockets and local or remote network TCP Sockets.</p>
@ -705,7 +705,7 @@ ipc.connectTo(
</code></pre>
<h4>
<a name="server--client-for-udp-sockets" class="anchor" href="#server--client-for-udp-sockets"><span class="octicon octicon-link"></span></a>Server &amp; Client for UDP Sockets</h4>
<a id="server--client-for-udp-sockets" class="anchor" href="#server--client-for-udp-sockets" aria-hidden="true"><span class="octicon octicon-link"></span></a>Server &amp; Client for UDP Sockets</h4>
<p>UDP Sockets are different than Unix &amp; TCP Sockets because they must be bound to a unique port on their machine to recieve messages. For example, A TCP or Unix Socket client could just connect to a seperate TCP or Unix Socket sever. That client could then exchange, both send and recive, data on the servers port or location. UDP Sockets can not do this. They must bind to a port to recieve or send data. </p>
@ -714,7 +714,7 @@ ipc.connectTo(
<p>This is the most basic example which will work for both local Unix Sockets and local or remote network TCP Sockets.</p>
<h5>
<a name="udp-server-1---world" class="anchor" href="#udp-server-1---world"><span class="octicon octicon-link"></span></a>UDP Server 1 - "World"</h5>
<a id="udp-server-1---world" class="anchor" href="#udp-server-1---world" aria-hidden="true"><span class="octicon octicon-link"></span></a>UDP Server 1 - "World"</h5>
<pre><code>var ipc=require('../../../node-ipc');
@ -750,7 +750,7 @@ ipc.server.start();
</code></pre>
<h5>
<a name="udp-server-2---hello" class="anchor" href="#udp-server-2---hello"><span class="octicon octicon-link"></span></a>UDP Server 2 - "Hello"</h5>
<a id="udp-server-2---hello" class="anchor" href="#udp-server-2---hello" aria-hidden="true"><span class="octicon octicon-link"></span></a>UDP Server 2 - "Hello"</h5>
<p><em>note</em> we set the port here to 8001 because the world server is already using the default ipc.config.networkPort of 8000. So we can not bind to 8000 while world is using it.</p>
@ -793,7 +793,7 @@ ipc.server.start();
<div id="footer_wrap" class="outer">
<footer class="inner">
<p class="copyright">Node-ipc maintained by <a href="https://github.com/RIAEvangelist">RIAEvangelist</a></p>
<p>Published with <a href="http://pages.github.com">GitHub Pages</a></p>
<p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
</footer>
</div>

6
stylesheets/stylesheet.css
View file

@ -201,12 +201,14 @@ ul, ol, dl {
}
ul {
list-style: inside;
list-style-position: inside;
list-style: disc;
padding-left: 20px;
}
ol {
list-style: decimal inside;
list-style-position: inside;
list-style: decimal;
padding-left: 20px;
}