status-go/vendor/github.com/jackpal/go-nat-pmp/README.md

1.2 KiB

go-nat-pmp

A Go language client for the NAT-PMP internet protocol for port mapping and discovering the external IP address of a firewall.

NAT-PMP is supported by Apple brand routers and open source routers like Tomato and DD-WRT.

See http://tools.ietf.org/html/draft-cheshire-nat-pmp-03

Build Status

Get the package

go get -u github.com/jackpal/go-nat-pmp

Usage

import (
    "github.com/jackpal/gateway"
    natpmp "github.com/jackpal/go-nat-pmp"
)

gatewayIP, err = gateway.DiscoverGateway()
if err != nil {
    return
}

client := natpmp.NewClient(gatewayIP)
response, err := client.GetExternalAddress()
if err != nil {
    return
}
print("External IP address:", response.ExternalIPAddress)

Clients

This library is used in the Taipei Torrent BitTorrent client http://github.com/jackpal/Taipei-Torrent

Complete documentation

http://godoc.org/github.com/jackpal/go-nat-pmp

License

This project is licensed under the Apache License 2.0.