datagram-stream

A streaming UDP module with broadcast, multicast and unicast options.

install

1npm install datagram-stream

usage

multicast

1var udp = require('datagram-stream');
2
3var stream = udp({
4    address     : '0.0.0.0'   //address to bind to
5    , multicast : '239.5.5.5' //multicast ip address to send to and listen on
6    , port      : 5555        //udp port to send to
7    , bindingPort : 5556      //udp port to listen on. Default: port
8    , reuseAddr : true        //boolean: allow multiple processes to bind to the
9                              //         same address and port. Default: true
10    , loopback  : true        //boolean: whether or not to receive sent datagrams
11                              //         on the loopback device. Only applies to
12                              //         multicast. Default: false
13});
14
15//pipe whatever is received to stdout
16stream.pipe(process.stdout);
17
18//pipe whatever is received on stdin over udp
19process.stdin.pipe(stream);

broadcast

1var udp = require('datagram-stream');
2
3var stream = udp({
4    address     : '0.0.0.0'         //address to bind to
5    , broadcast : '255.255.255.255' //broadcast ip address to send to
6    , port      : 5555              //udp port to send to
7    , bindingPort : 5556            //udp port to listen on. Default: port
8    , reuseAddr : true              //boolean: allow multiple processes to bind to the
9                                    //         same address and port. Default: true
10 });
11
12//pipe whatever is received to stdout
13stream.pipe(process.stdout);
14
15//pipe whatever is received on stdin over udp
16process.stdin.pipe(stream);

unicast

1var udp = require('datagram-stream');
2
3var stream = udp({
4    address     : '0.0.0.0'   //address to bind to
5    , unicast   : '127.0.0.1' //unicast ip address to send to
6    , port      : 5555        //udp port to send to
7    , bindingPort : 5556      //udp port to listen on. Default: port
8    , reuseAddr : true        //boolean: allow multiple processes to bind to the
9                              //         same address and port. Default: true
10 });
11
12//pipe whatever is received to stdout
13stream.pipe(process.stdout);
14
15//pipe whatever is received on stdin over udp
16process.stdin.pipe(stream);

acknowledgments

I used @dominictarr's broadcast-stream as a guide for how to implement the stream.

license

MIT