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

added documentation on latest fix for windows

Browse source
This commit is contained in:
Brandon Nozaki Miller 2015-07-24 12:24:29 -07:00
parent b4e4498da9
commit badac96190
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -62,7 +62,7 @@ Set these variables in the ``ipc.config`` scope to overwrite or set default valu
appspace : 'app.', appspace : 'app.',
socketRoot : '/tmp/', socketRoot : '/tmp/',
id : os.hostname(), id : os.hostname(),
networkHost : 'localhost', networkHost : '127.0.0.1', //we use this instead of localhost as default because windows without network connection turns dns off and is unable to find localhost like other... smarter... OSes
networkPort : 8000, networkPort : 8000,
encoding : 'utf8', encoding : 'utf8',
silent : false, silent : false,
@ -275,7 +275,7 @@ Used to create TCP, TLS or UDP Socket Server to which Clients can bind or other
| variable | required | definition | | variable | required | definition |
|----------|----------|------------| |----------|----------|------------|
| 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. | | host | optional | If not specified this defaults to 127.0.0.1. For TCP, TLS & UDP servers this is most likely going to be 127.0.0.1 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. |
| port | optional | The port on which the TCP, UDP, or TLS Socket server will be bound, this defaults to 8000 if not specified | | port | optional | The port on which the TCP, UDP, or TLS Socket server will be bound, this defaults to 8000 if not specified |
| 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. | 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.
| callback | optional | Function to be called when the server is created | | callback | optional | Function to be called when the server is created |
@ -460,7 +460,7 @@ This is the most basic example which will work for both local Unix Sockets and l
); );
ipc.server.emit( ipc.server.emit(
{ {
address : 'localhost', address : '127.0.0.1', //any hostname will work
port : ipc.config.networkPort port : ipc.config.networkPort
}, },
'message', 'message',