netutil

Documentation

Overview

Taken from taipei-torrent

Just enough UPnP to be able to forward ports

Index

• type Device
• type DeviceList
• type Envelope
• type ExternalIPAddress
• type ExternalIPAddressResponse
• type NAT
  • func Discover() (nat NAT, err error)
• type NetAddress
  • func NewNetAddress(addr net.Addr) *NetAddress
  • func NewNetAddressIPPort(ip net.IP, port uint16) *NetAddress
  • func NewNetAddressString(addr string) (*NetAddress, error)
  • func NewNetAddressStrings(addrs []string) ([]*NetAddress, error)
  • func NewNetAddressWithEnforcedPort(addr net.Addr, enforcedPort int) *NetAddress
  • func (na *NetAddress) Dial() (net.Conn, error)
  • func (na *NetAddress) DialTimeout(timeout time.Duration) (net.Conn, error)
  • func (na *NetAddress) Equals(other interface{}) bool
  • func (na *NetAddress) Less(other interface{}) bool
  • func (na *NetAddress) Local() bool
  • func (na *NetAddress) RFC1918() bool
  • func (na *NetAddress) RFC3849() bool
  • func (na *NetAddress) RFC3927() bool
  • func (na *NetAddress) RFC3964() bool
  • func (na *NetAddress) RFC4193() bool
  • func (na *NetAddress) RFC4380() bool
  • func (na *NetAddress) RFC4843() bool
  • func (na *NetAddress) RFC4862() bool
  • func (na *NetAddress) RFC6052() bool
  • func (na *NetAddress) RFC6145() bool
  • func (na *NetAddress) ReachabilityTo(o *NetAddress) int
  • func (na *NetAddress) Routable() bool
  • func (na *NetAddress) String() string
  • func (na *NetAddress) Valid() bool
• type Root
• type ServiceList
• type SoapBody
• type UPNPService
• Bugs

Types

type Device

type Device struct {
	XMLName     xml.Name    `xml:"device"`
	DeviceType  string      `xml:"deviceType"`
	DeviceList  DeviceList  `xml:"deviceList"`
	ServiceList ServiceList `xml:"serviceList"`
}

type DeviceList

type DeviceList struct {
	Device []Device `xml:"device"`
}

type Envelope

type Envelope struct {
	XMLName xml.Name `xml:"http://schemas.xmlsoap.org/soap/envelope/ Envelope"`
	Soap    *SoapBody
}

type ExternalIPAddress

type ExternalIPAddress struct {
	XMLName xml.Name `xml:"NewExternalIPAddress"`
	IP      string
}

type ExternalIPAddressResponse

type ExternalIPAddressResponse struct {
	XMLName   xml.Name `xml:"GetExternalIPAddressResponse"`
	IPAddress string   `xml:"NewExternalIPAddress"`
}

type NAT

type NAT interface {
	GetExternalAddress() (addr net.IP, err error)
	AddPortMapping(protocol string, externalPort, internalPort int, description string, timeout int) (mappedExternalPort int, err error)
	DeletePortMapping(protocol string, externalPort, internalPort int) (err error)
}

protocol is either "udp" or "tcp"

func Discover

func Discover() (nat NAT, err error)

type NetAddress

type NetAddress struct {
	IP   net.IP
	Port uint16
	// contains filtered or unexported fields
}

NetAddress defines information about a peer on the network including its IP address, and port.

func NewNetAddress

func NewNetAddress(addr net.Addr) *NetAddress

NewNetAddress returns a new NetAddress using the provided TCP address. When testing, other net.Addr (except TCP) will result in using 0.0.0.0:0. When normal run, other net.Addr (except TCP) will panic.

func NewNetAddressIPPort

func NewNetAddressIPPort(ip net.IP, port uint16) *NetAddress

NewNetAddressIPPort returns a new NetAddress using the provided IP and port number.

func NewNetAddressString

func NewNetAddressString(addr string) (*NetAddress, error)

NewNetAddressString returns a new NetAddress using the provided address in the form of "IP:Port". Also resolves the host if host is not an IP.

func NewNetAddressStrings

func NewNetAddressStrings(addrs []string) ([]*NetAddress, error)

NewNetAddressStrings returns an array of NetAddress'es build using the provided strings.

func NewNetAddressWithEnforcedPort

func NewNetAddressWithEnforcedPort(addr net.Addr, enforcedPort int) *NetAddress

func (*NetAddress) Dial

func (na *NetAddress) Dial() (net.Conn, error)

Dial calls net.Dial on the address.

func (*NetAddress) DialTimeout

func (na *NetAddress) DialTimeout(timeout time.Duration) (net.Conn, error)

DialTimeout calls net.DialTimeout on the address.

func (*NetAddress) Equals

func (na *NetAddress) Equals(other interface{}) bool

Equals reports whether na and other are the same addresses.

func (*NetAddress) Less

func (na *NetAddress) Less(other interface{}) bool

func (*NetAddress) Local

func (na *NetAddress) Local() bool

Local returns true if it is a local address.

func (*NetAddress) RFC1918

func (na *NetAddress) RFC1918() bool

func (*NetAddress) RFC3849

func (na *NetAddress) RFC3849() bool

func (*NetAddress) RFC3927

func (na *NetAddress) RFC3927() bool

func (*NetAddress) RFC3964

func (na *NetAddress) RFC3964() bool

func (*NetAddress) RFC4193

func (na *NetAddress) RFC4193() bool

func (*NetAddress) RFC4380

func (na *NetAddress) RFC4380() bool

func (*NetAddress) RFC4843

func (na *NetAddress) RFC4843() bool

func (*NetAddress) RFC4862

func (na *NetAddress) RFC4862() bool

func (*NetAddress) RFC6052

func (na *NetAddress) RFC6052() bool

func (*NetAddress) RFC6145

func (na *NetAddress) RFC6145() bool

func (*NetAddress) ReachabilityTo

func (na *NetAddress) ReachabilityTo(o *NetAddress) int

ReachabilityTo checks whenever o can be reached from na.

func (*NetAddress) Routable

func (na *NetAddress) Routable() bool

Routable returns true if the address is routable.

func (*NetAddress) String

func (na *NetAddress) String() string

String representation.

func (*NetAddress) Valid

func (na *NetAddress) Valid() bool

For IPv4 these are either a 0 or all bits set address. For IPv6 a zero address or one that matches the RFC3849 documentation address format.

type Root

type Root struct {
	Device Device
}

type ServiceList

type ServiceList struct {
	Service []UPNPService `xml:"service"`
}

type SoapBody

type SoapBody struct {
	XMLName    xml.Name `xml:"http://schemas.xmlsoap.org/soap/envelope/ Body"`
	ExternalIP *ExternalIPAddressResponse
}

type UPNPService

type UPNPService struct {
	ServiceType string `xml:"serviceType"`
	ControlURL  string `xml:"controlURL"`
}

Notes

Bugs

• TODO: use syscalls to get actual ourIP. http://pastebin.com/9exZG4rh