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

documented maxRetries properly

Browse source
This commit is contained in:
Brandon Nozaki Miller 2014-08-31 11:05:06 -07:00
parent 6b81bd069e
commit b7b0b14e8c
2 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -64,7 +64,7 @@ Set these variables in the ``ipc.config`` scope to overwrite or set default valu
silent : false, silent : false,
maxConnections : 100, maxConnections : 100,
retry : 500, retry : 500,
maxRetries : 0, maxRetries : false,
stopRetrying : false stopRetrying : false
} }
@ -80,7 +80,7 @@ Set these variables in the ``ipc.config`` scope to overwrite or set default valu
| silent | turn on/off logging default is false which means logging is on | | silent | turn on/off logging default is false which means logging is on |
| 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. | | 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. |
| 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. | | 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. |
| maxRetries | the maximum number of retries after each disconnect before giving up and completely killing a specific connection | | maxRetries | if set, it represents the maximum number of retries after each disconnect before giving up and completely killing a specific connection |
| 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. | | 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. |
---- ----

3
node-ipc.js
View file

@ -28,7 +28,8 @@ var defaults={
silent : false, silent : false,
maxConnections : 100, maxConnections : 100,
retry : 500, retry : 500,
stopRetrying : false, maxRetries : false,
stopRetrying : false
} }
var ipc = { var ipc = {