README.md

#SocketWatcher

SocketWatcher is a JavaScript binding for uv_poll based on code by TobyEalden (with permission) for node_mdns. It's useful as a drop-in replacement for Node's old, private module IOWatcher.

More information on uv_poll:

• libuv header (look for uv_poll_t)
• External I/O with polling (libuv docs)
• fs: remove fs.watchFile(), IOWatcher (Node.js bug #3348)
• IOWatcher broken since 0.7.9 (Node.js bug #4136)

##Installation and use

$ npm install socketwatcher

var SocketWatcher = require("socketwatcher").SocketWatcher;
var watcher = new SocketWatcher();
watcher.callback = function() { [...] };
watcher.set(fd, read_flag, write_flag);
watcher.start();
// watcher.stop();

Note: since version 0.2.0, you must use require("socketwatcher").SocketWatcher, instead of using the module object directly. Sorry for the inconvenience.

##Original work

The files contributed to node_mdns:

• socket_watcher.hpp
• socket_watcher.cpp

##License

MIT licensed, see LICENSE.