Fathom v0.2

component fathom.proto.upnp

This module provides an API for the UPnP protocol.


Methods Returns Description
open( callback, ip, port, ttl ) void static This function opens a multicast listening socket suitable for initiating the UPnP discovery phase.
(1) Seems the IP and port should have default values. (2) Why the argument?


  • callback <function> The callback Fathom invokes once the operation completes. When successful, its only argument is a socket descriptor. On error, its only argument is a dictionary whose member "error" describes the problem that occurred.
  • ip <string> The IP address to listen on.
  • port <integer> The port to listen on.
  • ttl <integer> The IP TTL to set on the socket.