dgram-as-promised

dgram-as-promised

This module provides promisified version of standard dgram class. The API is the same as for standard dgram, except bind, close and send methods which return Promise object.

Installation

npm install dgram-as-promised

Usage

dgram-as-promised can be used like standard dgram module:

const dgramAsPromised = require('dgram-as-promised')

const socket = dgramAsPromised.createSocket('udp4')

const membership = '224.0.0.1'
const port = 41234

const message = new Buffer('ABCDEFGH')

Method bind returns Promise object which is fulfilled when listening event is emitted.

await socket.bind()
console.log('Socket is listening')

socket.setBroadcast(true)
socket.setMulticastTTL(128)

socket.addMembership(MEMBERSHIP)
console.log('Membership is set')

Method send returns Promise object which is fulfilled when message has been sent.

await socket.send(message, 0, message.length, PORT, MEMBERSHIP)
console.log('Message is sent')

Method close returns Promise object which is fulfilled when close event is emitted.

await socket.close()
console.log('Socket is closed')

Promise

This module uses any-promise and any ES6 Promise library or polyfill is supported.

Ie. bluebird can be used as Promise library for this module, if it is registered before.

require('any-promise/register/bluebird')
const dgramAsPromised = require('dgram-as-promised')

License

Copyright (c) 2016-2017 Piotr Roszatycki [e-mail]

MIT

Changelog

v0.1.0 2017-02-18

• ES6
• BDD tests
• Relicensed to MIT