- Notifications
You must be signed in to change notification settings - Fork0
Cocker, a socket module to aggressively handle connection retries.
License
rootslab/cocker
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Cocker, a socket module toaggressively handle connection retries.
NOTE: It directly inherits fromnet.Socket.
$ npm install cocker [-g]
require:
constCocker=require('cocker');
$cd cocker/$ npmtest
to execute a single test file simply do:
$ node test/file-name.js
Arguments between [ ] are optional.
Cocker([Objectoptions])
or
newCocker([Objectoptions])
NOTE: default options are listed.
It accepts a configuration hash/object:
{,address :Object,connection :Object,reconnection :Object}
{host :'127.0.0.1',port :0,family :null/* * Specify an IPC endpoint, like a unix domain socket, if a string is * provided, the TCP-specific options above are ignored. * For further details, see "Identifying paths for IPC connections" in * the /api/net section. */,path :null}
{// should connect fromlocalAddress :undefined,localPort:undefined// custom lookup and hints,lookup :dns.lookup,hints :0}
{encoding :null,keepAlive :true,timeout :0,noDelay :true,allowHalfOpen :false}
{trials :3,interval :1000/* * A value to use for calculating the pause between two * connection attempts. Default value is the golden ratio. * Final value is calculated as: * interval * Math.pow( factor, curr.attempts + 1 ) */,factor :(Math.sqrt(5)+1)/2}
NOTE: do not mess up with these properties.
Cocker.options :Object
Cocker.attempts :Number
Cocker.lost :Boolean
Cocker.stop :Boolean
Cocker.lapse :Number
all the methods from net.Socket module are inherited.
| name | description |
|---|---|
| bye | end the connection. |
| run | connect to a socket or attempting to. |
| die | end the connection. (Promise) |
| hunt | connect to a socket or attempting to. (Promise) |
| prey | connect using a list of hosts. (Promise) |
| watch | re-connect after losing the current connection. (Promise) |
Arguments between [ ] are optional.
'bye' :function([Buffer|Stringdata[,Stringenc]]) :undefined
// it optionally accepts a cocker option object to reconfigure the socket.'run' :function([Objectcocker_options]) :undefined
// Promise will not be resolved until 'lost' event'die' :function([Buffer|Stringdata[,Stringenc]]) :Promise
/* * Try to connect to a socket. Promise will not be resolved until 'online', * rejected after 'lost' event; it optionally accepts a cocker option object * to reconfigure the socket. */'hunt' :function([Objectcocker_options]) :Promise
/* * It recursively scan a list, using #hunt Promises. The #prey Promise will * not be resolved until a connection will be made, definitively rejected * when no hosts had accepted one. * Every host in the list should be an object like Cocker.options.address. */'prey' :function(Arrayhosts) :Promise
/* * When the current established connection is lost, it tries to reconnect. * This Promise has the same resolution as for #hunt, the only difference is * that this Promise was "registered" on socket disconnection, then it will be * resolved/rejected only after capturing a 'lost' event from the current * broken connection. See examples. */'watch' :function([Objectcocker_options]) :Promise
all the events from net.Socket module are inherited.
// when: soon after socket !connect event'online' :function(Objectaddress)
// when: on the first !close event for the current socket'offline' :function(Objectaddress)
// when: after !offline, on every connection attempt, until !lost or !online'attempt' :function(Numbert,Objectaddress,Numberlapse)
// when: soon before the last !close event.'lost' :function(Numbert,Objectaddress,Numberlapse)
- connection with hunt
- connection with prey (through an address list)
- looping with watch
- looping (indefinitely) with hunt and watch
Seeexamples.
Copyright (c) 2013-present < Guglielmo Ferri :44gatti@gmail.com >
Permission is hereby granted, free of charge, to any person obtaininga copy of this software and associated documentation files (the'Software'), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and topermit persons to whom the Software is furnished to do so, subject tothe following conditions:
The above copyright notice and this permission notice shall beincluded in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANYCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THESOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
About
Cocker, a socket module to aggressively handle connection retries.