node-ssdp-js

A node.js SSDP client and server library.

Installation

Usage - Client

    var Client = require('node-ssdp-js').Client
      , client = new Client();
 
    client.on('response', function (response) {
      console.log('Got a response to an m-search.');
    });
 
    // browse for a service type
    client.browse('urn:schemas-upnp-org:service:ContentDirectory:1');
 
    // Or get a list of all services on the network
 
    client.browse('ssdp:all');

Usage - Server

    var Server = require('node-ssdp').Server
      , server = new Server()
    ;
 
    server.addUSN('upnp:rootdevice');
    server.addUSN('urn:schemas-upnp-org:device:MediaServer:1');
    server.addUSN('urn:schemas-upnp-org:service:ContentDirectory:1');
    server.addUSN('urn:schemas-upnp-org:service:ConnectionManager:1');
 
    server.on('advertise-alive', function (headers) {
      // Expire old devices from your cache.
      // Register advertising device somewhere (as designated in http headers heads)
    });
 
    server.on('advertise-bye', function (headers) {
      // Remove specified device from cache.
    });
 
    // start the server
    server.start();
 
    process.on('exit', function(){
      server.stop() // advertise shutting down and stop listening
    })

Configuration

TODO

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.