netadon

0.1.3 • Public • Published

Netadon

Netadon is a Node.js addon using Javascript and C++ to implement optimised UDP networking. Currently only Windows hosts, UDP and IPv4 are supported.

Installation

Install Node.js for your platform. This software has been developed against the long term stable (LTS) release.

Netadon is designed to be required to use from your own application to provide UDP networking.

npm install --save netadon

Node.js addons use libuv which by default supports up to 4 async threads in a threadpool for activities such as file I/O. These same threads are used by netadon and if you wish to use a number of the functions in one Node.js process then you will need to set the environment variable UV_THREADPOOL_SIZE to a suitable number before the first use of the libuv threadpool.

Using netadon

To use netadon in your own application, require the module then create ports as required. The functions are intended to follow the interface of the Node.js dgram module where possible. There are some differences but it should be straightforward to test with either implementation. The options argument in socket create has added optional fields:

  • receiveArray - When this is set to true, the message event will return an array containing multiple buffers that have been received.
  • packetSize - The number of bytes in a send packet
  • recvMinPackets - The memory to pre-allocate for receiving packets from the network
  • sendMinPackets - The memory to pre-allocate for queuing packets to be sent to the network
var netadon = require('netadon');
var udpPort = netadon.createSocket({type:'udp4', reuseAddr:false, receiveArray:false, packetSize:1500, recvMinPackets:16384, sendMinPackets:16384);
 
udpPort.on('error', (err) => {
  console.log(`server error: ${err}`);
  udpPort.close();
});
 
udpPort.on('message', (data, rinfo) => {
  console.log(`server data: ${data.length} from ${rinfo.address}:${rinfo.port}`);
});
 
udpPort.on('listening', () => {
  var address = udpPort.address;
  console.log(`server listening ${address.address}:${address.port}`);
});
 
udpPort.bind(port, addr);
udpPort.send(buf, 0, buf.length, port, addr);
udpPort.close();

Status, support and further development

Currently only Windows hosts, UDP and IPv4 are supported.

Contributions can be made via pull requests and will be considered by the author on their merits. Enhancement requests and bug reports should be raised as github issues. For support, please contact Streampunk Media.

License

This software is released under the Apache 2.0 license. Copyright 2017 Streampunk Media Ltd.

Readme

Keywords

none

Package Sidebar

Install

npm i netadon

Weekly Downloads

2

Version

0.1.3

License

Apache-2.0

Unpacked Size

5.32 MB

Total Files

34

Last publish

Collaborators

  • streampunk