akaustel / pmp Goto Github PK

gateway is optional (just pass an empty string or null if you do not know the address)
If you do know the address it does speed things up - otherwise it will try to find it.

error returns an error number or 0 if successful


result is an object

result.externalIP = the external IP address
result.error = error text if any

usage

var pmp = require('pmp');
pmp.getExternalAddress('',function(err,rslt){
    console.log(err,rslt);
});

gateway is optional (just pass an empty string or null if you don't know the address)
If you do know the address it does speed things up - otherwise it will try to find it.

localport is the port on the local machine you want to map to - sometimes know as the private port.

externalport is the port of the externalIP that you want the local port mapped to.

ttl is the time in seconds you want this mapping to remain effective.

pmp.portMap('',3000,3000,20,function(err,rslt){1
    console.log(err,rslt);
});

 result is an object

    result.externalIP = the external IP address
    result.error = error text if any
    result.privatePort = the port you gave (local port)
    result.publicPort = the external port - IT COULD BE DIFFERENT then the external port you requested
                        the RFC allows the router to assign an alternate if the one you requested is not available
    result.ttl = how long the mapping will remain active
    result.portMappingInitialized = time in seconds since the port mapping table was initialized (usually router uptime)
    result.gateway = the router address
    result.error = the error text if things did not work