aboutsummaryrefslogtreecommitdiff
path: root/node_modules/killable
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/killable
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/killable')
-rw-r--r--node_modules/killable/LICENSE5
-rw-r--r--node_modules/killable/README.md55
-rw-r--r--node_modules/killable/index.js24
-rw-r--r--node_modules/killable/package.json27
4 files changed, 111 insertions, 0 deletions
diff --git a/node_modules/killable/LICENSE b/node_modules/killable/LICENSE
new file mode 100644
index 00000000..a650ead0
--- /dev/null
+++ b/node_modules/killable/LICENSE
@@ -0,0 +1,5 @@
+Copyright 2014 Marten de Vries
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/node_modules/killable/README.md b/node_modules/killable/README.md
new file mode 100644
index 00000000..9fe06dba
--- /dev/null
+++ b/node_modules/killable/README.md
@@ -0,0 +1,55 @@
+killable
+========
+
+Keeps track of a server's open sockets so they can be destroyed at a
+moment's notice. This way, the server connection can be killed very
+fast.
+
+Installation
+------------
+
+```
+npm install killable
+```
+
+Example usage
+-------------
+
+Using express:
+('server' in the example is just an ``http.server``, so other frameworks
+or pure Node should work just as well.)
+
+```javascript
+var killable = require('killable');
+
+var app = require('express')();
+var server;
+
+app.route('/', function (req, res, next) {
+ res.send('Server is going down NOW!');
+
+ server.kill(function () {
+ //the server is down when this is called. That won't take long.
+ });
+});
+
+var server = app.listen(8080);
+killable(server);
+```
+
+API
+---
+
+The ``killable`` module is callable. When you call it on a Node
+``http.Server`` object, it will add a ``server.kill()`` method on it. It
+returns the server object.
+
+``server.kill([callback])`` closes all open sockets and calls
+``server.close()``, to which the ``callback`` is passed on.
+
+Inspired by: http://stackoverflow.com/a/14636625
+
+License
+-------
+
+ISC
diff --git a/node_modules/killable/index.js b/node_modules/killable/index.js
new file mode 100644
index 00000000..e9dbbc4b
--- /dev/null
+++ b/node_modules/killable/index.js
@@ -0,0 +1,24 @@
+module.exports = function makeKillable(server) {
+ var sockets = [];
+
+ server.on('connection', function (socket) {
+ //add socket to list
+ sockets.push(socket);
+
+ socket.once('close', function () {
+ //remove socket from list
+ sockets.splice(sockets.indexOf(socket), 1);
+ });
+ });
+
+ server.kill = function (cb) {
+ server.close(cb);
+ sockets.forEach(function (socket) {
+ socket.destroy();
+ });
+ // reset so the server can be restarted
+ sockets = [];
+ };
+
+ return server;
+};
diff --git a/node_modules/killable/package.json b/node_modules/killable/package.json
new file mode 100644
index 00000000..bbbc347b
--- /dev/null
+++ b/node_modules/killable/package.json
@@ -0,0 +1,27 @@
+{
+ "name": "killable",
+ "version": "1.0.1",
+ "description": "Keeps track of a server's open sockets so they can be destroyed at a moment's notice.",
+ "main": "index.js",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/marten-de-vries/killable.git"
+ },
+ "keywords": [
+ "express",
+ "http",
+ "server",
+ "socket",
+ "kill",
+ "truncate",
+ "destroy",
+ "restart",
+ "shutdown",
+ "immeadiately"
+ ],
+ "author": "Marten de Vries",
+ "license": "ISC",
+ "bugs": {
+ "url": "https://github.com/marten-de-vries/killable/issues"
+ }
+}