-
-
a nodejs module for local and remote Inter Process Communication for Linux, Mac and Windows.
+
a nodejs module for local and remote Inter Process Communication with full support for Linux, Mac and Windows.
A great solution for Neural Networking in Node.JS
npm install node-ipc
-
-
npm install node-ipc
+ +npm info : See npm trends and stats for node-ipc
+
GitHub info :
+
Package details websites :
@@ -50,7 +56,7 @@ A great solution for Neural Networking in Node.JS NPM Module. The npm page for the node-ipc module. -This work is licenced via the DBAD Public Licence.
+This work is licenced via the DBAD Public Licence.
Windows 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.
-ipc.config
ascii utf8 utf16le ucs2 base64 hex .Buffer NOT an Object as JSON. This is great for Binary or hex IPC, and communicating with other processes in languages like C and C++ipc.log(a,b,c,d,e...);
ipc.log will accept any number of arguments and if ipc.config.silent is not set, it will concat them all with a sincle space ' ' between them and then log them to the console. This is fast because it prevents any concation from happening if the ipc is set to silent. That way if you leave your logging in place it should not effect performance.
ipc.log will accept any number of arguments and if ipc.config.silent is not set, it will concat them all with a sincle space ' ' between them and then log them to the console. This is fast because it prevents any concatenation from happening if the ipc is set to silent. That way if you leave your logging in place it should not effect performance.
the log also supports colors implementation. All of the available styles are supported and the theme styles are as follows :
+The log also supports colors implementation. All of the available styles are supported and the theme styles are as follows :
{
good : 'green',
@@ -274,7 +283,7 @@ colors.setTheme(
ipc.connectTo(id,path,callback);
-Used for connecting as a client to local Unix Sockets. This is the fastst way for processes on the same machine to communicate because it bypasses the network card which TCP and UDP must both use.
+Used for connecting as a client to local Unix Sockets and Windows Sockets. This is the fastst way for processes on the same machine to communicate because it bypasses the network card which TCP and UDP must both use.
@@ -293,7 +302,7 @@ colors.setTheme(
path
optional
-is the path of the Unix Domain Socket File, if not set this will be defaylted to ipc.config.socketRoot+ipc.config.appspace+id
+ is the path of the Unix Domain Socket File, if the System is Windows, this will automatically be converted to an appropriate pipe with the same information as the Unix Domain Socket File. If not set this will default to ipc.config.socketRoot+ipc.config.appspace+id
@@ -304,7 +313,7 @@ colors.setTheme(
-examples arguments can be ommitted solong as they are still in order.
+examples arguments can be ommitted so long as they are still in order.
ipc.connectTo('world');
@@ -317,7 +326,7 @@ colors.setTheme(
ipc.of.world.on(
'hello',
function(data){
- ipc.log(data.debug);
+ ipc.log(data.debug);
//if data was a string, it would have the color set to the debug style applied to it
}
)
@@ -351,7 +360,7 @@ colors.setTheme(
ipc.connectToNet(id,host,port,callback)
-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 connectTo instead as it is much faster since it avoids the network card alltogether.
+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 and Windows Socket Implementaion of connectTo instead as it is much faster since it avoids the network card altogether.
@@ -365,7 +374,7 @@ colors.setTheme(
id
required
-is the string id of the socket being connected to. For TCP & TLS sockets, this id is added to the ipc.of object when the socket is created with a refrence to the socket.
+is the string id of the socket being connected to. For TCP & TLS sockets, this id is added to the ipc.of object when the socket is created with a reference to the socket.
host
@@ -385,7 +394,7 @@ colors.setTheme(
-examples arguments can be ommitted solong as they are still in order.
+
examples arguments can be ommitted so long as they are still in order.
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.
ipc.connectToNet('world');
@@ -428,7 +437,7 @@ So while the default is : (id,host,port,callback), the following examples will s
ipc.disconnect(id)
-Used to disconnect a client from a Unix, TCP or TLS socket. The socket and its refrence will be removed from memory and the ipc.of 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.
+Used to disconnect a client from a Unix, Windows, TCP or TLS socket. The socket and its refrence will be removed from memory and the ipc.of 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.
@@ -459,7 +468,7 @@ So while the default is : (id,host,port,callback), the following examples will s
ipc.serve(path,callback);
-Used to create local Unix Socket Server to which Clients can bind. The server can emit events to specific Client Sockets, or broadcast events to all known Client Sockets.
+Used to create local Unix Socket Server or Windows Socket Server to which Clients can bind. The server can emit events to specific Client Sockets, or broadcast events to all known Client Sockets.
@@ -473,7 +482,8 @@ So while the default is : (id,host,port,callback), the following examples will s
path
optional
-This is the Unix Domain Socket path to bind to. If not supplied, it will default to : ipc.config.socketRoot + ipc.config.appspace + ipc.config.id;
+This is the path of the Unix Domain Socket File, if the System is Windows, this will automatically be converted to an appropriate pipe with the same information as the Unix Domain Socket File. If not set this will default to ipc.config.socketRoot+ipc.config.appspace+id
+
callback
@@ -484,7 +494,7 @@ So while the default is : (id,host,port,callback), the following examples will s
-examples arguments can be ommitted solong as they are still in order.
+examples arguments can be omitted so long as they are still in order.
ipc.serve();
@@ -518,7 +528,7 @@ So while the default is : (id,host,port,callback), the following examples will s
serveNet(host,port,UDPType,callback)
-Used to create TCP, TLS or UDP Socket Server to which Clients can bind or other servers can send data to. The server can emit events to specific Client Sockets, or broadcast events to all known Client Sockets.
+Used to create TCP, TLS or UDP Socket Server to which Clients can bind or other servers can send data to. The server can emit events to specific Client Sockets, or broadcast events to all known Client Sockets.
@@ -532,12 +542,12 @@ So while the default is : (id,host,port,callback), the following examples will s
host
optional
-If not specified this defaults to localhost. For TCP, TLS & UDP servers this is most likely going to be localhost or 0.0.0.0 unless you have something like node-http-server installed to run subdomains for you.
+If not specified this defaults to the first address in os.networkInterfaces(). For TCP, TLS & UDP servers this is most likely going to be 127.0.0.1 or ::1
port
optional
-The port on which the TCP, UDP, or TLS Socket server will be bound, this defaults to 8000 if not specified
+The port on wunich the TCP, UDP, or TLS Socket server will be bound, this defaults to 8000 if not specified
UDPType
@@ -638,9 +648,9 @@ So while the default is : (id,host,port,callback), the following examples will s
You can find Advanced Examples in the examples folder. In the examples you will find more complex demos including multi client examples.
-Server for Unix Sockets & TCP Sockets
+Server for Unix Sockets, Windows Sockets & TCP Sockets
-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.
+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 local Unix and Windows Sockets as well as local or remote network TCP Sockets.
var ipc=require('node-ipc');
@@ -654,6 +664,7 @@ ipc.serve(
function(data,socket){
ipc.log('got a message : '.debug, data);
ipc.server.emit(
+ socket,
'message',
data+' world!'
);
@@ -668,9 +679,9 @@ ipc.server.start();
Client for Unix Sockets & TCP Sockets
-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.
+The client connects to the servers socket for Inter Process Communication. The socket will receive 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.
-var ipc=require('../../../node-ipc');
+var ipc=require('node-ipc');
ipc.config.id = 'hello';
ipc.config.retry= 1500;
@@ -707,11 +718,11 @@ ipc.connectTo(
Server & Client for UDP Sockets
-UDP Sockets are different than Unix & 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.
+UDP Sockets are different than Unix, Windows & TCP Sockets because they must be bound to a unique port on their machine to receive messages. For example, A TCP, Unix, or Windows Socket client could just connect to a separate TCP, Unix, or Windows Socket sever. That client could then exchange, both send and receive, data on the servers port or location. UDP Sockets can not do this. They must bind to a port to receive or send data.
-This means a UDP Client and Server are the same thing because inorder to recieve data, a UDP Socket must have its own port to recieve data on, and only one process can use this port at a time. It also means that inorder to emit or broadcast data the UDP server will need to know the host and port of the Socket it intends to broadcast the data to.
+This means a UDP Client and Server are the same thing because in order to receive data, a UDP Socket must have its own port to receive data on, and only one process can use this port at a time. It also means that in order to emit or broadcast data the UDP server will need to know the host and port of the Socket it intends to broadcast the data to.
-This is the most basic example which will work for both local Unix Sockets and local or remote network TCP Sockets.
+This is the most basic example which will work for both local and remote UDP Sockets.
UDP Server 1 - "World"
@@ -770,7 +781,7 @@ ipc.serveNet(
);
ipc.server.emit(
{
- address : 'localhost',
+ address : '127.0.0.1', //any hostname will work
port : ipc.config.networkPort
},
'message',
@@ -785,6 +796,63 @@ ipc.serveNet(
ipc.server.define.listen.message='This event type listens for message strings as value of data key.';
ipc.server.start();
+
+
+
+Raw Buffer or Binary Sockets
+
+Binary or Buffer sockets can be used with any of the above socket types, however the way data events are emit is slightly different.
+
+When setting up a rawBuffer socket you must specify it as such :
+
+ipc.config.rawBuffer=true;
+
+
+You can also specify its encoding type. The default is utf8
+
+ipc.config.encoding='utf8';
+
+
+emit string buffer :
+
+//server
+ipc.server.emit(
+ socket,
+ 'hello'
+);
+
+//client
+ipc.of.world.emit(
+ 'hello'
+)
+
+
+emit byte array buffer :
+
+//server
+ipc.server.emit(
+ socket,
+ [10,20,30]
+);
+
+//client
+ipc.server.emit(
+ [10,20,30]
+);
+
+
+emit hex array buffer :
+
+//server
+ipc.server.emit(
+ socket,
+ [0x05,0x6d,0x5c]
+);
+
+//client
+ipc.server.emit(
+ [0x05,0x6d,0x5c]
+);
diff --git a/params.json b/params.json
index 5480738..f241cc1 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"name":"Node-ipc","tagline":"Inter Process Communication Module for node supporting Unix sockets, TCP, TLS, and UDP. Giving lightning speed on Linux, Mac, and Windows. Neural Networking in Node.JS","body":"node-ipc\r\n================\r\n*a nodejs module for local and remote Inter Process Communication* for Linux, Mac and Windows. \r\nA great solution for **Neural Networking** in Node.JS\r\n\r\n**npm install node-ipc** \r\n\r\n\r\n\r\nPackage details websites :\r\n* [GitHub.io site](http://riaevangelist.github.io/node-ipc/ \"node-ipc documentation\"). A prettier version of this site.\r\n* [NPM Module](https://www.npmjs.org/package/node-ipc \"node-ipc npm module\"). The npm page for the node-ipc module.\r\n\r\nThis work is licenced via the [DBAD Public Licence](http://www.dbad-license.org/). \r\n\r\n----\r\n#### Contents\r\n\r\n1. [Types of IPC Sockets and Supporting OS](#types-of-ipc-sockets)\r\n2. [IPC Methods](#ipc-methods)\r\n 1. [log](#log)\r\n 2. [connectTo](#connectto)\r\n 3. [connectToNet](#connecttonet)\r\n 4. [disconnect](#disconnect)\r\n 5. [serve](#serve)\r\n 6. [serveNet](#servenet)\r\n3. [IPC Stores and Default Variables](#ipc-stores-and-default-variables)\r\n4. [Basic Examples](#basic-examples)\r\n 1. [Server for Unix Sockets & TCP Sockets](#server-for-unix-sockets--tcp-sockets)\r\n 2. [Client for Unix Sockets & TCP Sockets](#client-for-unix-sockets--tcp-sockets)\r\n 3. [Server & Client for UDP Sockets](#server--client-for-udp-sockets)\r\n5. [Advanced Examples](https://github.com/RIAEvangelist/node-ipc/tree/master/example)\r\n\r\n\r\n----\r\n#### Types of IPC Sockets\r\n\r\n| Type | Stability |Definition |\r\n|-----------|-----------|-----------|\r\n|Unix Socket| Stable | Gives Linux and Mac lightning fast communication and avoids the network card to reduce overhead and latency. [Local Unix Socket examples ](https://github.com/RIAEvangelist/node-ipc/tree/master/example/unixSocket/ \"Unix Socket Node IPC examples\") |\r\n|TCP Socket | Stable | Gives the most reliable communication across the network. Can be used for local IPC as well, but is slower than #1's Unix Socket Implementation because TCP sockets go through the network card while Unix Sockets do not. [Local or remote network TCP Socket examples ](https://github.com/RIAEvangelist/node-ipc/tree/master/example/TCPSocket/ \"TCP Socket Node IPC examples\") |\r\n|TLS Socket | Alpha | ***coming soon...*** |\r\n|UDP Sockets| Stable | Gives the **fastest network communication**. UDP is less reliable but much faster than TCP. It is best used for streaming non critical data like sound, video, or multiplayer game data as it can drop packets depending on network connectivity and other factors. UDP can be used for local IPC as well, but is slower than #1's Unix Socket Implementation because UDP sockets go through the network card while Unix Sockets do not. [Local or remote network UDP Socket examples ](https://github.com/RIAEvangelist/node-ipc/tree/master/example/UDPSocket/ \"UDP Socket Node IPC examples\") | \r\n\r\n| OS | Supported Sockets |\r\n|-----|--------------------|\r\n|Linux| Unix, TCP, TLS, UDP|\r\n|Mac | Unix, TCP, TLS, UDP|\r\n|Win | TCP, TLS, UDP | \r\n\r\n**Windows** 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. \r\n\r\n----\r\n\r\n``ipc.config`` \r\n\r\nSet these variables in the ``ipc.config`` scope to overwrite or set default values.\r\n\r\n {\r\n appspace : 'app.',\r\n socketRoot : '/tmp/',\r\n id : os.hostname(),\r\n networkHost : 'localhost',\r\n networkPort : 8000,\r\n encoding : 'utf8',\r\n silent : false,\r\n maxConnections : 100,\r\n retry : 500,\r\n maxRetries : false,\r\n stopRetrying : false\r\n }\r\n\r\n\r\n| variable | documentation |\r\n|----------|---------------|\r\n| appspace | used for Unix Socket (Unix Domain Socket) namespacing. If not set specifically, the Unix Domain Socket will combine the socketRoot, appspace, and id to form the Unix Socket Path for creation or binding. This is available incase you have many apps running on your system, you may have several sockets with the same id, but if you change the appspace, you will still have app specic unique sockets.|\r\n| socketRoot| the directory in which to create or bind to a Unix Socket |\r\n| id | the id of this socket or service |\r\n| networkHost| the local or remote host on which TCP, TLS or UDP Sockets should connect |\r\n| networkPort| the default port on which TCP, TLS, or UDP sockets should connect |\r\n| encoding | the default encoding for data sent on sockets |\r\n| silent | turn on/off logging default is false which means logging is on |\r\n| maxConnections| this is the max number of connections allowed to a socket. It is currently only being set on Unix Sockets. Other Socket types are using the system defaults. |\r\n| retry | this is the time in milliseconds a client will wait before trying to reconnect to a server if the connection is lost. This does not effect UDP sockets since they do not have a client server relationship like Unix Sockets and TCP Sockets. |\r\n| maxRetries | if set, it represents the maximum number of retries after each disconnect before giving up and completely killing a specific connection |\r\n| stopRetrying| 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 ***NOT*** try to reconnect. |\r\n\r\n----\r\n\r\n#### IPC Methods \r\nThese methods are available in the IPC Scope. \r\n\r\n----\r\n##### log\r\n\r\n``ipc.log(a,b,c,d,e...);`` \r\n\r\nipc.log will accept any number of arguments and if ``ipc.config.silent`` is not set, it will concat them all with a sincle space ' ' between them and then log them to the console. This is fast because it prevents any concation from happening if the ipc is set to silent. That way if you leave your logging in place it should not effect performance.\r\n\r\nthe log also supports [colors](https://github.com/Marak/colors.js) implementation. All of the available styles are supported and the theme styles are as follows :\r\n\r\n {\r\n good : 'green',\r\n notice : 'yellow',\r\n warn : 'red',\r\n error : 'redBG',\r\n debug : 'magenta',\r\n variable: 'cyan',\r\n data : 'blue'\r\n } \r\n\r\nYou can override any of these settings by requireing colors and setting the theme as follows :\r\n\r\n var colors=require('colors');\r\n \r\n colors.setTheme(\r\n {\r\n good : 'zebra',\r\n notice : 'redBG',\r\n ...\r\n } \r\n );\r\n----\r\n##### connectTo\r\n\r\n``ipc.connectTo(id,path,callback);`` \r\n\r\nUsed for connecting as a client to local Unix Sockets. ***This is the fastst way for processes on the same machine to communicate*** because it bypasses the network card which TCP and UDP must both use.\r\n\r\n| variable | required | definition |\r\n|----------|----------|------------|\r\n| id | required | is the string id of the socket being connected to. The socket with this id is added to the ipc.of object when created. |\r\n| path | optional | is the path of the Unix Domain Socket File, if not set this will be defaylted to ``ipc.config.socketRoot``+``ipc.config.appspace``+``id`` |\r\n| callback | optional | this is the function to execute when the socket has been created. |\r\n\r\n**examples** arguments can be ommitted solong as they are still in order.\r\n\r\n ipc.connectTo('world');\r\n \r\nor using just an id and a callback\r\n \r\n ipc.connectTo(\r\n 'world',\r\n function(){\r\n ipc.of.world.on(\r\n 'hello',\r\n function(data){\r\n ipc.log(data.debug); \r\n //if data was a string, it would have the color set to the debug style applied to it\r\n }\r\n )\r\n }\r\n );\r\n\r\nor explicitly setting the path\r\n\r\n ipc.connectTo(\r\n 'world',\r\n 'myapp.world'\r\n );\r\n \r\nor explicitly setting the path with callback\r\n\r\n ipc.connectTo(\r\n 'world',\r\n 'myapp.world',\r\n function(){\r\n ...\r\n }\r\n );\r\n----\r\n##### connectToNet\r\n\r\n``ipc.connectToNet(id,host,port,callback)`` \r\n\r\nUsed 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 ``connectTo`` instead as it is much faster since it avoids the network card alltogether.\r\n\r\n| variable | required | definition |\r\n|----------|----------|------------|\r\n| id | required | is the string id of the socket being connected to. For TCP & TLS sockets, this id is added to the ``ipc.of`` object when the socket is created with a refrence to the socket. |\r\n| host | optional | is the host on which the TCP or TLS socket resides. This will default to ``ipc.config.networkHost`` if not specified. |\r\n| port | optional | the port on which the TCP or TLS socket resides. |\r\n| callback | optional | this is the function to execute when the socket has been created. |\r\n\r\n**examples** arguments can be ommitted solong as they are still in order. \r\nSo 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.\r\n\r\n ipc.connectToNet('world');\r\n \r\nor using just an id and a callback\r\n \r\n ipc.connectToNet(\r\n 'world',\r\n function(){\r\n ...\r\n }\r\n );\r\n\r\nor explicitly setting the host and path\r\n\r\n ipc.connectToNet(\r\n 'world',\r\n 'myapp.com',serve(path,callback)\r\n 3435\r\n );\r\n \r\nor only explicitly setting port and callback\r\n\r\n ipc.connectToNet(\r\n 'world',\r\n 3435,\r\n function(){\r\n ...\r\n }\r\n );\r\n\r\n----\r\n##### disconnect\r\n\r\n``ipc.disconnect(id)`` \r\n\r\nUsed to disconnect a client from a Unix, TCP or TLS socket. The socket and its refrence will be removed from memory and the ``ipc.of`` 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.\r\n\r\n| variable | required | definition |\r\n|----------|----------|------------|\r\n| id | required | is the string id of the socket from which to disconnect. |\r\n\r\n**examples**\r\n\r\n ipc.disconnect('world');\r\n\r\n----\r\n##### serve\r\n``ipc.serve(path,callback);`` \r\n\r\nUsed to create local Unix Socket Server to which Clients can bind. The server can ``emit`` events to specific Client Sockets, or ``broadcast`` events to all known Client Sockets. \r\n\r\n| variable | required | definition |\r\n|----------|----------|------------|\r\n| path | optional | This is the Unix Domain Socket path to bind to. If not supplied, it will default to : ipc.config.socketRoot + ipc.config.appspace + ipc.config.id; |\r\n| callback | optional | This is a function to be called after the Server has started. This can also be done by binding an event to the start event like ``ipc.server.on('start',function(){});`` |\r\n\r\n***examples*** arguments can be ommitted solong as they are still in order.\r\n\r\n ipc.serve();\r\n\r\nor specifying callback\r\n\r\n ipc.serve(\r\n function(){...}\r\n );\r\n \r\nor specify path\r\n\r\n ipc.serve(\r\n '/tmp/myapp.myservice'\r\n );\r\n \r\nor specifying everything\r\n\r\n ipc.serve(\r\n '/tmp/myapp.myservice',\r\n function(){...}\r\n );\r\n\r\n---- \r\n##### serveNet\r\n\r\n``serveNet(host,port,UDPType,callback)``\r\n\r\nUsed to create TCP, TLS or UDP Socket Server to which Clients can bind or other servers can send data to. The server can ``emit`` events to specific Client Sockets, or ``broadcast`` events to all known Client Sockets. \r\n\r\n\r\n| variable | required | definition |\r\n|----------|----------|------------|\r\n| host | optional | If not specified this defaults to localhost. For TCP, TLS & UDP servers this is most likely going to be localhost or 0.0.0.0 unless you have something like [node-http-server](https://github.com/RIAEvangelist/node-http-server) installed to run subdomains for you. |\r\n| port | optional | The port on which the TCP, UDP, or TLS Socket server will be bound, this defaults to 8000 if not specified |\r\n| UDPType | optional | If set this will create the server as a UDP socket. 'udp4' or 'udp6' are valid values. This defaults to not being set.\r\n| callback | optional | Function to be called when the server is created |\r\n\r\n***examples*** arguments can be ommitted solong as they are still in order.\r\n\r\ndefault tcp server\r\n\r\n ipc.serveNet();\r\n \r\ndefault udp server\r\n\r\n ipc.serveNet('udp4');\r\n\r\nor specifying TCP server with callback\r\n\r\n ipc.serveNet(\r\n function(){...}\r\n );\r\n \r\nor specifying UDP server with callback\r\n\r\n ipc.serveNet(\r\n 'udp4',\r\n function(){...}\r\n );\r\n \r\nor specify port\r\n\r\n ipc.serveNet(\r\n 3435\r\n );\r\n \r\nor specifying everything TCP\r\n\r\n ipc.serveNet(\r\n 'MyMostAwesomeApp.com',\r\n 3435,\r\n function(){...}\r\n );\r\n\r\nor specifying everything UDP\r\n\r\n ipc.serveNet(\r\n 'MyMostAwesomeApp.com',\r\n 3435,\r\n 'udp4',\r\n function(){...}\r\n );\r\n\r\n----\r\n### IPC Stores and Default Variables \r\n\r\n| variable | definition |\r\n|-----------|------------|\r\n| ipc.of | This is where socket connection refrences will be stored when connecting to them as a client via the ``ipc.connectTo`` or ``iupc.connectToNet``. They will be stored based on the ID used to create them, eg : ipc.of.mySocket|\r\n| ipc.server| This is a refrence to the server created by ``ipc.serve`` or ``ipc.serveNet``|\r\n\r\n----\r\n### Basic Examples \r\nYou can find [Advanced Examples](https://github.com/RIAEvangelist/node-ipc/tree/master/example) in the examples folder. In the examples you will find more complex demos including multi client examples.\r\n\r\n#### Server for Unix Sockets & TCP Sockets \r\nThe 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.\r\n\r\n var ipc=require('node-ipc');\r\n\r\n ipc.config.id = 'world';\r\n ipc.config.retry= 1500;\r\n \r\n ipc.serve(\r\n function(){\r\n ipc.server.on(\r\n 'message',\r\n function(data,socket){\r\n ipc.log('got a message : '.debug, data);\r\n ipc.server.emit(\r\n 'message',\r\n data+' world!'\r\n );\r\n }\r\n );\r\n }\r\n );\r\n \r\n ipc.server.start();\r\n\r\n#### Client for Unix Sockets & TCP Sockets \r\nThe 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.\r\n\r\n var ipc=require('../../../node-ipc');\r\n\r\n ipc.config.id = 'hello';\r\n ipc.config.retry= 1500;\r\n \r\n ipc.connectTo(\r\n 'world',\r\n function(){\r\n ipc.of.world.on(\r\n 'connect',\r\n function(){\r\n ipc.log('## connected to world ##'.rainbow, ipc.config.delay);\r\n ipc.of.world.emit(\r\n 'message',\r\n 'hello'\r\n )\r\n }\r\n );\r\n ipc.of.world.on(\r\n 'disconnect',\r\n function(){\r\n ipc.log('disconnected from world'.notice);\r\n }\r\n );\r\n ipc.of.world.on(\r\n 'message',\r\n function(data){\r\n ipc.log('got a message from world : '.debug, data);\r\n }\r\n );\r\n }\r\n );\r\n \r\n#### Server & Client for UDP Sockets \r\nUDP Sockets are different than Unix & 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. \r\n\r\nThis means a UDP Client and Server are the same thing because inorder to recieve data, a UDP Socket must have its own port to recieve data on, and only one process can use this port at a time. It also means that inorder to ``emit`` or ``broadcast`` data the UDP server will need to know the host and port of the Socket it intends to broadcast the data to.\r\n\r\nThis is the most basic example which will work for both local Unix Sockets and local or remote network TCP Sockets.\r\n\r\n##### UDP Server 1 - \"World\" \r\n\r\n var ipc=require('../../../node-ipc');\r\n\r\n ipc.config.id = 'world';\r\n ipc.config.retry= 1500;\r\n \r\n ipc.serveNet(\r\n 'udp4',\r\n function(){\r\n console.log(123);\r\n ipc.server.on(\r\n 'message',\r\n function(data,socket){\r\n ipc.log('got a message from '.debug, data.from.variable ,' : '.debug, data.message.variable);\r\n ipc.server.emit(\r\n socket,\r\n 'message',\r\n {\r\n from : ipc.config.id,\r\n message : data.message+' world!'\r\n }\r\n );\r\n }\r\n );\r\n \r\n console.log(ipc.server);\r\n }\r\n );\r\n \r\n ipc.server.define.listen.message='This event type listens for message strings as value of data key.';\r\n \r\n ipc.server.start();\r\n \r\n##### UDP Server 2 - \"Hello\"\r\n*note* 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.\r\n\r\n ipc.config.id = 'hello';\r\n ipc.config.retry= 1500;\r\n \r\n ipc.serveNet(\r\n 8001,\r\n 'udp4',\r\n function(){\r\n ipc.server.on(\r\n 'message',\r\n function(data){\r\n ipc.log('got Data');\r\n ipc.log('got a message from '.debug, data.from.variable ,' : '.debug, data.message.variable);\r\n }\r\n );\r\n ipc.server.emit(\r\n {\r\n address : 'localhost',\r\n port : ipc.config.networkPort\r\n },\r\n 'message',\r\n {\r\n from : ipc.config.id,\r\n message : 'Hello'\r\n }\r\n );\r\n }\r\n );\r\n \r\n ipc.server.define.listen.message='This event type listens for message strings as value of data key.';\r\n \r\n ipc.server.start();\r\n","google":"UA-48524110-1","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
+{"name":"Node-ipc","tagline":"Inter Process Communication Module for node supporting Unix sockets, TCP, TLS, and UDP. Giving lightning speed on Linux, Mac, and Windows. Neural Networking in Node.JS","body":"node-ipc\r\n================\r\n*a nodejs module for local and remote Inter Process Communication* with full support for Linux, Mac and Windows. \r\nA great solution for **Neural Networking** in Node.JS\r\n\r\n**npm install node-ipc**\r\n\r\n\r\nnpm info : [See npm trends and stats for node-ipc](http://npm-stat.com/charts.html?package=node-ipc&author=&from=&to=) \r\n    \r\n\r\n[](https://github.com/RIAEvangelist)\r\n\r\nGitHub info : \r\n  \r\n\r\nPackage details websites :\r\n* [GitHub.io site](http://riaevangelist.github.io/node-ipc/ \"node-ipc documentation\"). A prettier version of this site.\r\n* [NPM Module](https://www.npmjs.org/package/node-ipc \"node-ipc npm module\"). The npm page for the node-ipc module.\r\n\r\nThis work is licenced via the [DBAD Public Licence](http://www.dbad-license.org/).\r\n\r\n----\r\n#### Contents\r\n\r\n1. [Types of IPC Sockets and Supporting OS](#types-of-ipc-sockets)\r\n2. [IPC Methods](#ipc-methods)\r\n 1. [log](#log)\r\n 2. [connectTo](#connectto)\r\n 3. [connectToNet](#connecttonet)\r\n 4. [disconnect](#disconnect)\r\n 5. [serve](#serve)\r\n 6. [serveNet](#servenet)\r\n3. [IPC Stores and Default Variables](#ipc-stores-and-default-variables)\r\n4. [Basic Examples](#basic-examples)\r\n 1. [Server for Unix||Windows Sockets & TCP Sockets](#server-for-unix-sockets--tcp-sockets)\r\n 2. [Client for Unix||Windows Sockets & TCP Sockets](#client-for-unix-sockets--tcp-sockets)\r\n 3. [Server & Client for UDP Sockets](#server--client-for-udp-sockets)\r\n5. [Advanced Examples](https://github.com/RIAEvangelist/node-ipc/tree/master/example)\r\n\r\n\r\n----\r\n#### Types of IPC Sockets\r\n\r\n| Type | Stability |Definition |\r\n|-----------|-----------|-----------|\r\n|Unix Socket or Windows Socket| Stable | Gives Linux, Mac, and Windows lightning fast communication and avoids the network card to reduce overhead and latency. [Local Unix and Windows Socket examples ](https://github.com/RIAEvangelist/node-ipc/tree/master/example/unixWindowsSocket/ \"Unix and Windows Socket Node IPC examples\") |\r\n|TCP Socket | Stable | Gives the most reliable communication across the network. Can be used for local IPC as well, but is slower than #1's Unix Socket Implementation because TCP sockets go through the network card while Unix Sockets and Windows Sockets do not. [Local or remote network TCP Socket examples ](https://github.com/RIAEvangelist/node-ipc/tree/master/example/TCPSocket/ \"TCP Socket Node IPC examples\") |\r\n|TLS Socket | Alpha | ***coming soon...*** |\r\n|UDP Sockets| Stable | Gives the **fastest network communication**. UDP is less reliable but much faster than TCP. It is best used for streaming non critical data like sound, video, or multiplayer game data as it can drop packets depending on network connectivity and other factors. UDP can be used for local IPC as well, but is slower than #1's Unix Socket or Windows Socket Implementation because UDP sockets go through the network card while Unix and Windows Sockets do not. [Local or remote network UDP Socket examples ](https://github.com/RIAEvangelist/node-ipc/tree/master/example/UDPSocket/ \"UDP Socket Node IPC examples\") | \r\n\r\n| OS | Supported Sockets |\r\n|-----|--------------------|\r\n|Linux| Unix, Posix, TCP, TLS, UDP|\r\n|Mac | Unix, Posix, TCP, TLS, UDP|\r\n|Win | Windows, TCP, TLS, UDP | \r\n\r\n----\r\n\r\n`ipc.config` \r\n\r\nSet these variables in the `ipc.config` scope to overwrite or set default values.\r\n\r\n {\r\n appspace : 'app.',\r\n socketRoot : '/tmp/',\r\n id : os.hostname(),\r\n networkHost : 'localhost', //should resolve to 127.0.0.1 or ::1 see the table below related to this\r\n networkPort : 8000,\r\n encoding : 'utf8',\r\n rawBuffer : false,\r\n silent : false,\r\n maxConnections : 100,\r\n retry : 500,\r\n maxRetries : false,\r\n stopRetrying : false\r\n }\r\n\r\n\r\n| variable | documentation |\r\n|----------|---------------|\r\n| appspace | used for Unix Socket (Unix Domain Socket) namespacing. If not set specifically, the Unix Domain Socket will combine the socketRoot, appspace, and id to form the Unix Socket Path for creation or binding. This is available incase you have many apps running on your system, you may have several sockets with the same id, but if you change the appspace, you will still have app specic unique sockets.|\r\n| socketRoot| the directory in which to create or bind to a Unix Socket |\r\n| id | the id of this socket or service |\r\n| networkHost| the local or remote host on which TCP, TLS or UDP Sockets should connect |\r\n| networkPort| the default port on which TCP, TLS, or UDP sockets should connect |\r\n| encoding | the default encoding for data sent on sockets. Mostly used if rawBuffer is set to true. Valid values are : ` ascii` ` utf8 ` ` utf16le` ` ucs2` ` base64` ` hex ` .\r\n| rawBuffer| if true, data will be sent and received as a raw node ` Buffer ` __NOT__ an ` Object ` as JSON. This is great for Binary or hex IPC, and communicating with other processes in languages like C and C++ |\r\n| silent | turn on/off logging default is false which means logging is on |\r\n| maxConnections| this is the max number of connections allowed to a socket. It is currently only being set on Unix Sockets. Other Socket types are using the system defaults. |\r\n| retry | this is the time in milliseconds a client will wait before trying to reconnect to a server if the connection is lost. This does not effect UDP sockets since they do not have a client server relationship like Unix Sockets and TCP Sockets. |\r\n| maxRetries | if set, it represents the maximum number of retries after each disconnect before giving up and completely killing a specific connection |\r\n| stopRetrying| Defaults to false meaning clients will continue to retry to connect to servers indefinitely 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 ***NOT*** try to reconnect. |\r\n\r\n----\r\n\r\n#### IPC Methods \r\nThese methods are available in the IPC Scope. \r\n\r\n----\r\n##### log\r\n\r\n`ipc.log(a,b,c,d,e...);` \r\n\r\nipc.log will accept any number of arguments and if `ipc.config.silent` is not set, it will concat them all with a sincle space ' ' between them and then log them to the console. This is fast because it prevents any concatenation from happening if the ipc is set to silent. That way if you leave your logging in place it should not effect performance.\r\n\r\nThe log also supports [colors](https://github.com/Marak/colors.js) implementation. All of the available styles are supported and the theme styles are as follows :\r\n\r\n {\r\n good : 'green',\r\n notice : 'yellow',\r\n warn : 'red',\r\n error : 'redBG',\r\n debug : 'magenta',\r\n variable: 'cyan',\r\n data : 'blue'\r\n } \r\n\r\nYou can override any of these settings by requireing colors and setting the theme as follows :\r\n\r\n var colors=require('colors');\r\n\r\n colors.setTheme(\r\n {\r\n good : 'zebra',\r\n notice : 'redBG',\r\n ...\r\n } \r\n );\r\n----\r\n##### connectTo\r\n\r\n`ipc.connectTo(id,path,callback);` \r\n\r\nUsed for connecting as a client to local Unix Sockets and Windows Sockets. ***This is the fastst way for processes on the same machine to communicate*** because it bypasses the network card which TCP and UDP must both use.\r\n\r\n| variable | required | definition |\r\n|----------|----------|------------|\r\n| id | required | is the string id of the socket being connected to. The socket with this id is added to the ipc.of object when created. |\r\n| path | optional | is the path of the Unix Domain Socket File, if the System is Windows, this will automatically be converted to an appropriate pipe with the same information as the Unix Domain Socket File. If not set this will default to ` ipc.config.socketRoot `+` ipc.config.appspace `+` id ` |\r\n| callback | optional | this is the function to execute when the socket has been created. |\r\n\r\n**examples** arguments can be ommitted so long as they are still in order.\r\n\r\n ipc.connectTo('world');\r\n\r\nor using just an id and a callback\r\n\r\n ipc.connectTo(\r\n 'world',\r\n function(){\r\n ipc.of.world.on(\r\n 'hello',\r\n function(data){\r\n ipc.log(data.debug);\r\n //if data was a string, it would have the color set to the debug style applied to it\r\n }\r\n )\r\n }\r\n );\r\n\r\nor explicitly setting the path\r\n\r\n ipc.connectTo(\r\n 'world',\r\n 'myapp.world'\r\n );\r\n\r\nor explicitly setting the path with callback\r\n\r\n ipc.connectTo(\r\n 'world',\r\n 'myapp.world',\r\n function(){\r\n ...\r\n }\r\n );\r\n----\r\n##### connectToNet\r\n\r\n`ipc.connectToNet(id,host,port,callback)` \r\n\r\nUsed 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 and Windows Socket Implementaion of `connectTo` instead as it is much faster since it avoids the network card altogether.\r\n\r\n| variable | required | definition |\r\n|----------|----------|------------|\r\n| id | required | is the string id of the socket being connected to. For TCP & TLS sockets, this id is added to the `ipc.of` object when the socket is created with a reference to the socket. |\r\n| host | optional | is the host on which the TCP or TLS socket resides. This will default to `ipc.config.networkHost` if not specified. |\r\n| port | optional | the port on which the TCP or TLS socket resides. |\r\n| callback | optional | this is the function to execute when the socket has been created. |\r\n\r\n**examples** arguments can be ommitted so long as they are still in order. \r\nSo 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.\r\n\r\n ipc.connectToNet('world');\r\n\r\nor using just an id and a callback\r\n\r\n ipc.connectToNet(\r\n 'world',\r\n function(){\r\n ...\r\n }\r\n );\r\n\r\nor explicitly setting the host and path\r\n\r\n ipc.connectToNet(\r\n 'world',\r\n 'myapp.com',serve(path,callback)\r\n 3435\r\n );\r\n\r\nor only explicitly setting port and callback\r\n\r\n ipc.connectToNet(\r\n 'world',\r\n 3435,\r\n function(){\r\n ...\r\n }\r\n );\r\n\r\n----\r\n##### disconnect\r\n\r\n`ipc.disconnect(id)` \r\n\r\nUsed to disconnect a client from a Unix, Windows, TCP or TLS socket. The socket and its refrence will be removed from memory and the `ipc.of` 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.\r\n\r\n| variable | required | definition |\r\n|----------|----------|------------|\r\n| id | required | is the string id of the socket from which to disconnect. |\r\n\r\n**examples**\r\n\r\n ipc.disconnect('world');\r\n\r\n----\r\n##### serve\r\n`ipc.serve(path,callback);` \r\n\r\nUsed to create local Unix Socket Server or Windows Socket Server to which Clients can bind. The server can `emit` events to specific Client Sockets, or `broadcast` events to all known Client Sockets. \r\n\r\n| variable | required | definition |\r\n|----------|----------|------------|\r\n| path | optional | This is the path of the Unix Domain Socket File, if the System is Windows, this will automatically be converted to an appropriate pipe with the same information as the Unix Domain Socket File. If not set this will default to ` ipc.config.socketRoot `+` ipc.config.appspace `+` id ` |\r\n| callback | optional | This is a function to be called after the Server has started. This can also be done by binding an event to the start event like `ipc.server.on('start',function(){});` |\r\n\r\n***examples*** arguments can be omitted so long as they are still in order.\r\n\r\n ipc.serve();\r\n\r\nor specifying callback\r\n\r\n ipc.serve(\r\n function(){...}\r\n );\r\n\r\nor specify path\r\n\r\n ipc.serve(\r\n '/tmp/myapp.myservice'\r\n );\r\n\r\nor specifying everything\r\n\r\n ipc.serve(\r\n '/tmp/myapp.myservice',\r\n function(){...}\r\n );\r\n\r\n---- \r\n##### serveNet\r\n\r\n`serveNet(host,port,UDPType,callback)`\r\n\r\nUsed to create TCP, TLS or UDP Socket Server to which Clients can bind or other servers can send data to. The server can `emit` events to specific Client Sockets, or `broadcast` events to all known Client Sockets.\r\n\r\n\r\n| variable | required | definition |\r\n|----------|----------|------------|\r\n| host | optional | If not specified this defaults to the first address in os.networkInterfaces(). For TCP, TLS & UDP servers this is most likely going to be 127.0.0.1 or ::1 |\r\n| port | optional | The port on wunich the TCP, UDP, or TLS Socket server will be bound, this defaults to 8000 if not specified |\r\n| UDPType | optional | If set this will create the server as a UDP socket. 'udp4' or 'udp6' are valid values. This defaults to not being set.\r\n| callback | optional | Function to be called when the server is created |\r\n\r\n***examples*** arguments can be ommitted solong as they are still in order.\r\n\r\ndefault tcp server\r\n\r\n ipc.serveNet();\r\n\r\ndefault udp server\r\n\r\n ipc.serveNet('udp4');\r\n\r\nor specifying TCP server with callback\r\n\r\n ipc.serveNet(\r\n function(){...}\r\n );\r\n\r\nor specifying UDP server with callback\r\n\r\n ipc.serveNet(\r\n 'udp4',\r\n function(){...}\r\n );\r\n\r\nor specify port\r\n\r\n ipc.serveNet(\r\n 3435\r\n );\r\n\r\nor specifying everything TCP\r\n\r\n ipc.serveNet(\r\n 'MyMostAwesomeApp.com',\r\n 3435,\r\n function(){...}\r\n );\r\n\r\nor specifying everything UDP\r\n\r\n ipc.serveNet(\r\n 'MyMostAwesomeApp.com',\r\n 3435,\r\n 'udp4',\r\n function(){...}\r\n );\r\n\r\n----\r\n### IPC Stores and Default Variables \r\n\r\n| variable | definition |\r\n|-----------|------------|\r\n| ipc.of | This is where socket connection refrences will be stored when connecting to them as a client via the `ipc.connectTo` or `iupc.connectToNet`. They will be stored based on the ID used to create them, eg : ipc.of.mySocket|\r\n| ipc.server| This is a refrence to the server created by `ipc.serve` or `ipc.serveNet`|\r\n\r\n----\r\n### Basic Examples\r\nYou can find [Advanced Examples](https://github.com/RIAEvangelist/node-ipc/tree/master/example) in the examples folder. In the examples you will find more complex demos including multi client examples.\r\n\r\n#### Server for Unix Sockets, Windows Sockets & TCP Sockets\r\nThe 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 local Unix and Windows Sockets as well as local or remote network TCP Sockets.\r\n\r\n var ipc=require('node-ipc');\r\n\r\n ipc.config.id = 'world';\r\n ipc.config.retry= 1500;\r\n\r\n ipc.serve(\r\n function(){\r\n ipc.server.on(\r\n 'message',\r\n function(data,socket){\r\n ipc.log('got a message : '.debug, data);\r\n ipc.server.emit(\r\n socket,\r\n 'message',\r\n data+' world!'\r\n );\r\n }\r\n );\r\n }\r\n );\r\n\r\n ipc.server.start();\r\n\r\n#### Client for Unix Sockets & TCP Sockets\r\nThe client connects to the servers socket for Inter Process Communication. The socket will receive 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.\r\n\r\n var ipc=require('node-ipc');\r\n\r\n ipc.config.id = 'hello';\r\n ipc.config.retry= 1500;\r\n\r\n ipc.connectTo(\r\n 'world',\r\n function(){\r\n ipc.of.world.on(\r\n 'connect',\r\n function(){\r\n ipc.log('## connected to world ##'.rainbow, ipc.config.delay);\r\n ipc.of.world.emit(\r\n 'message',\r\n 'hello'\r\n )\r\n }\r\n );\r\n ipc.of.world.on(\r\n 'disconnect',\r\n function(){\r\n ipc.log('disconnected from world'.notice);\r\n }\r\n );\r\n ipc.of.world.on(\r\n 'message',\r\n function(data){\r\n ipc.log('got a message from world : '.debug, data);\r\n }\r\n );\r\n }\r\n );\r\n\r\n#### Server & Client for UDP Sockets\r\nUDP Sockets are different than Unix, Windows & TCP Sockets because they must be bound to a unique port on their machine to receive messages. For example, A TCP, Unix, or Windows Socket client could just connect to a separate TCP, Unix, or Windows Socket sever. That client could then exchange, both send and receive, data on the servers port or location. UDP Sockets can not do this. They must bind to a port to receive or send data. \r\n\r\nThis means a UDP Client and Server are the same thing because in order to receive data, a UDP Socket must have its own port to receive data on, and only one process can use this port at a time. It also means that in order to `emit` or `broadcast` data the UDP server will need to know the host and port of the Socket it intends to broadcast the data to.\r\n\r\nThis is the most basic example which will work for both local and remote UDP Sockets.\r\n\r\n##### UDP Server 1 - \"World\"\r\n\r\n var ipc=require('../../../node-ipc');\r\n\r\n ipc.config.id = 'world';\r\n ipc.config.retry= 1500;\r\n\r\n ipc.serveNet(\r\n 'udp4',\r\n function(){\r\n console.log(123);\r\n ipc.server.on(\r\n 'message',\r\n function(data,socket){\r\n ipc.log('got a message from '.debug, data.from.variable ,' : '.debug, data.message.variable);\r\n ipc.server.emit(\r\n socket,\r\n 'message',\r\n {\r\n from : ipc.config.id,\r\n message : data.message+' world!'\r\n }\r\n );\r\n }\r\n );\r\n\r\n console.log(ipc.server);\r\n }\r\n );\r\n\r\n ipc.server.define.listen.message='This event type listens for message strings as value of data key.';\r\n\r\n ipc.server.start();\r\n\r\n##### UDP Server 2 - \"Hello\"\r\n*note* 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.\r\n\r\n ipc.config.id = 'hello';\r\n ipc.config.retry= 1500;\r\n\r\n ipc.serveNet(\r\n 8001,\r\n 'udp4',\r\n function(){\r\n ipc.server.on(\r\n 'message',\r\n function(data){\r\n ipc.log('got Data');\r\n ipc.log('got a message from '.debug, data.from.variable ,' : '.debug, data.message.variable);\r\n }\r\n );\r\n ipc.server.emit(\r\n {\r\n address : '127.0.0.1', //any hostname will work\r\n port : ipc.config.networkPort\r\n },\r\n 'message',\r\n {\r\n from : ipc.config.id,\r\n message : 'Hello'\r\n }\r\n );\r\n }\r\n );\r\n\r\n ipc.server.define.listen.message='This event type listens for message strings as value of data key.';\r\n\r\n ipc.server.start();\r\n\r\n#### Raw Buffer or Binary Sockets\r\nBinary or Buffer sockets can be used with any of the above socket types, however the way data events are emit is ***slightly*** different.\r\n\r\nWhen setting up a rawBuffer socket you must specify it as such :\r\n\r\n ipc.config.rawBuffer=true;\r\n\r\nYou can also specify its encoding type. The default is ` utf8 `\r\n\r\n ipc.config.encoding='utf8';\r\n\r\n\r\nemit string buffer :\r\n\r\n //server\r\n ipc.server.emit(\r\n socket,\r\n 'hello'\r\n );\r\n\r\n //client\r\n ipc.of.world.emit(\r\n 'hello'\r\n )\r\n\r\nemit byte array buffer :\r\n\r\n //server\r\n ipc.server.emit(\r\n socket,\r\n [10,20,30]\r\n );\r\n\r\n //client\r\n ipc.server.emit(\r\n [10,20,30]\r\n );\r\n\r\nemit hex array buffer :\r\n\r\n //server\r\n ipc.server.emit(\r\n socket,\r\n [0x05,0x6d,0x5c]\r\n );\r\n\r\n //client\r\n ipc.server.emit(\r\n [0x05,0x6d,0x5c]\r\n );\r\n","google":"UA-48524110-1","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
diff --git a/stylesheets/github-light.css b/stylesheets/github-light.css
new file mode 100644
index 0000000..872a6f4
--- /dev/null
+++ b/stylesheets/github-light.css
@@ -0,0 +1,116 @@
+/*
+ Copyright 2014 GitHub Inc.
+
+ Licensed 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.
+
+*/
+
+.pl-c /* comment */ {
+ color: #969896;
+}
+
+.pl-c1 /* constant, markup.raw, meta.diff.header, meta.module-reference, meta.property-name, support, support.constant, support.variable, variable.other.constant */,
+.pl-s .pl-v /* string variable */ {
+ color: #0086b3;
+}
+
+.pl-e /* entity */,
+.pl-en /* entity.name */ {
+ color: #795da3;
+}
+
+.pl-s .pl-s1 /* string source */,
+.pl-smi /* storage.modifier.import, storage.modifier.package, storage.type.java, variable.other, variable.parameter.function */ {
+ color: #333;
+}
+
+.pl-ent /* entity.name.tag */ {
+ color: #63a35c;
+}
+
+.pl-k /* keyword, storage, storage.type */ {
+ color: #a71d5d;
+}
+
+.pl-pds /* punctuation.definition.string, string.regexp.character-class */,
+.pl-s /* string */,
+.pl-s .pl-pse .pl-s1 /* string punctuation.section.embedded source */,
+.pl-sr /* string.regexp */,
+.pl-sr .pl-cce /* string.regexp constant.character.escape */,
+.pl-sr .pl-sra /* string.regexp string.regexp.arbitrary-repitition */,
+.pl-sr .pl-sre /* string.regexp source.ruby.embedded */ {
+ color: #183691;
+}
+
+.pl-v /* variable */ {
+ color: #ed6a43;
+}
+
+.pl-id /* invalid.deprecated */ {
+ color: #b52a1d;
+}
+
+.pl-ii /* invalid.illegal */ {
+ background-color: #b52a1d;
+ color: #f8f8f8;
+}
+
+.pl-sr .pl-cce /* string.regexp constant.character.escape */ {
+ color: #63a35c;
+ font-weight: bold;
+}
+
+.pl-ml /* markup.list */ {
+ color: #693a17;
+}
+
+.pl-mh /* markup.heading */,
+.pl-mh .pl-en /* markup.heading entity.name */,
+.pl-ms /* meta.separator */ {
+ color: #1d3e81;
+ font-weight: bold;
+}
+
+.pl-mq /* markup.quote */ {
+ color: #008080;
+}
+
+.pl-mi /* markup.italic */ {
+ color: #333;
+ font-style: italic;
+}
+
+.pl-mb /* markup.bold */ {
+ color: #333;
+ font-weight: bold;
+}
+
+.pl-md /* markup.deleted, meta.diff.header.from-file */ {
+ background-color: #ffecec;
+ color: #bd2c00;
+}
+
+.pl-mi1 /* markup.inserted, meta.diff.header.to-file */ {
+ background-color: #eaffea;
+ color: #55a532;
+}
+
+.pl-mdr /* meta.diff.range */ {
+ color: #795da3;
+ font-weight: bold;
+}
+
+.pl-mo /* meta.output */ {
+ color: #1d3e81;
+}
+
diff --git a/stylesheets/stylesheet.css b/stylesheets/stylesheet.css
index 619d19d..3da3485 100644
--- a/stylesheets/stylesheet.css
+++ b/stylesheets/stylesheet.css
@@ -3,7 +3,7 @@ Slate Theme for GitHub Pages
by Jason Costello, @jsncostello
*******************************************************************************/
-@import url(pygment_trac.css);
+@import url(github-light.css);
/*******************************************************************************
MeyerWeb Reset