From b7b0b14e8cdfb587f56eeec63c38bf6c0c83d6aa Mon Sep 17 00:00:00 2001 From: Brandon Nozaki Miller Date: Sun, 31 Aug 2014 11:05:06 -0700 Subject: [PATCH] documented maxRetries properly --- README.md | 4 ++-- node-ipc.js | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8d8db5c..a783304 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ Set these variables in the ``ipc.config`` scope to overwrite or set default valu silent : false, maxConnections : 100, retry : 500, - maxRetries : 0, + maxRetries : 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 | | 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. | -| 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. | ---- diff --git a/node-ipc.js b/node-ipc.js index 92ff7bd..61ae0b6 100644 --- a/node-ipc.js +++ b/node-ipc.js @@ -28,7 +28,8 @@ var defaults={ silent : false, maxConnections : 100, retry : 500, - stopRetrying : false, + maxRetries : false, + stopRetrying : false } var ipc = {