blob: 9fe06dbac399e2a3c5f493ebedfaa490f381dc73 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
|
