turn-js

    0.5.4 • Public • Published

    CircleCI npm

    Turn-JS

    TURN (Traversal Using Relay NAT) library written entirely in JavaScript.

    Features

    • implements (most of) the features specified in RFC 5766
    • supports TCP and UDP communication
    • offers callback and promise based API
    • can be browserified (to be used in chrome apps)

    Install

    npm install turn-js
    

    Usage

    Callbacks

    Promises

    API

    myClient = turn(serverAddr, serverPort, user, pwd, transport)

    myClient.allocate(function(address) {}, function(error) {})

    myClient.allocateP()

    myClient.createPermission(address, function() {}, function(error) {})

    myClient.createPermission(address)

    myClient.bindChannel(address, port, channel, lifetime, function() {}, function(error) {})

    myClient.bindChannelP(address, port, channel)

    myClient.refresh(lifetime, function() {}, function(error) {})

    myClient.refreshP(lifetime)

    myClient.close(function() {}, function(error) {})

    myClient.sendToRelay(bytes, address, port, function() {}, function(error))

    myClient.sendToRelayP(bytes, address, port)

    myClient.sendToChannel(bytes, channel, function() {}, function(error) {})

    myClient.sendToChannelP(bytes, channel)

    Events

    Keywords

    Install

    npm i turn-js

    DownloadsWeekly Downloads

    20

    Version

    0.5.4

    License

    MIT

    Last publish

    Collaborators

    • nicoj