Giter Club home page Giter Club logo

udp-request's Introduction

udp-request

Small module for making requests/responses over UDP

npm install udp-request

build status

Usage

var udp = require('udp-request')
var socket = udp()

socket.on('request', function (request, peer) {
  console.log('request:', request.toString())
  socket.response('echo: ' + request.toString(), peer)
})

socket.listen(10000, function () {
  socket.request('hello', {port: 10000, host: '127.0.0.1'}, function (err, response) {
    console.log('response', response.toString())
    socket.destroy()
  })
})

API

var socket = udp([options])

Create a new request/response udp socket. Options include:

{
  timeout: 1000, // request timeout
  socket: udpSocket, // supply your own udp socket
  retry: true, // retry requests if they time out. defaults to false
  requestEncoding: someEncoder, // abstract-encoding compliant encoder
  responseEncoding: someEncoder, // abstract-encoding compliant encoder
}

var id = socket.request(buffer, peer, [options], [callback])

Send a new request. buffer is the request payload and peer should be an object containing {port, host}. When the response arrives (or the request times out) the callback is called with the following arguments

callback(error, response, peer)

Options include:

{
  retry: true
}

socket.response(buffer, peer)

Send a response back to a request.

socket.cancel(id)

Cancels a pending request.

socket.on('request', buffer, peer)

Emitted when a new request arrives. Call the above .response with the same peer object to send a response back to this request.

socket.on('response', buffer, peer)

Emitted when any response arrives.

socket.on('error', err)

Emitted when a critical error happens.

socket.on('warning', err)

Emitted when a non critical error happens (you usually do not need to listen for this).

socket.on('close')

Emitted when the request socket closes (after it is destroyed).

socket.on('listening')

Emitted when the socket is listening.

socket.listen([port], [callback])

Listen on a specific port. If port is omitted a random one will be used.

socket.destroy()

Completely destroy the request socket (cancels all pending requests).

License

MIT

udp-request's People

Contributors

mafintosh avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.