nat

Documentation

Index

• Variables
• type PMP
  • func DiscoverPMP(timeout time.Duration) (*PMP, er.R)
  • func (p *PMP) AddPortMapping(port uint16) er.R
  • func (p *PMP) DeletePortMapping(port uint16) er.R
  • func (p *PMP) ExternalIP() (net.IP, er.R)
  • func (p *PMP) ForwardedPorts() []uint16
  • func (p *PMP) Name() string
• type Traversal
• type UPnP
  • func DiscoverUPnP(ctx context.Context) (*UPnP, er.R)
  • func (u *UPnP) AddPortMapping(port uint16) er.R
  • func (u *UPnP) DeletePortMapping(port uint16) er.R
  • func (u *UPnP) ExternalIP() (net.IP, er.R)
  • func (u *UPnP) ForwardedPorts() []uint16
  • func (u *UPnP) Name() string

Variables

var (

	// ErrMultipleNAT is an error returned when multiple NATs have been
	// detected.
	ErrMultipleNAT = er.GenericErrorType.CodeWithDetail("ErrMultipleNAT", "multiple NATs detected")
)

Types

type PMP

type PMP struct {
	// contains filtered or unexported fields
}

PMP is a concrete implementation of the Traversal interface that uses the NAT-PMP technique.

func DiscoverPMP

func DiscoverPMP(timeout time.Duration) (*PMP, er.R)

DiscoverPMP attempts to scan the local network for a NAT-PMP enabled device within the given timeout.

func (*PMP) AddPortMapping

func (p *PMP) AddPortMapping(port uint16) er.R

AddPortMapping enables port forwarding for the given port.

func (*PMP) DeletePortMapping

func (p *PMP) DeletePortMapping(port uint16) er.R

DeletePortMapping disables port forwarding for the given port.

func (*PMP) ExternalIP

func (p *PMP) ExternalIP() (net.IP, er.R)

ExternalIP returns the external IP address of the NAT-PMP enabled device.

func (*PMP) ForwardedPorts

func (p *PMP) ForwardedPorts() []uint16

ForwardedPorts returns a list of ports currently being forwarded.

func (*PMP) Name

func (p *PMP) Name() string

Name returns the name of the specific NAT traversal technique used.

type Traversal

type Traversal interface {
	// ExternalIP returns the external IP address.
	ExternalIP() (net.IP, er.R)

	// AddPortMapping adds a port mapping for the given port between the
	// private and public addresses.
	AddPortMapping(port uint16) er.R

	// DeletePortMapping deletes a port mapping for the given port between
	// the private and public addresses.
	DeletePortMapping(port uint16) er.R

	// ForwardedPorts returns the ports currently being forwarded using NAT
	// traversal.
	ForwardedPorts() []uint16

	// Name returns the name of the specific NAT traversal technique used.
	Name() string
}

Traversal is an interface that brings together the different NAT traversal techniques.

type UPnP

type UPnP struct {
	// contains filtered or unexported fields
}

UPnP is a concrete implementation of the Traversal interface that uses the UPnP technique.

func DiscoverUPnP

func DiscoverUPnP(ctx context.Context) (*UPnP, er.R)

DiscoverUPnP scans the local network for a UPnP enabled device.

func (*UPnP) AddPortMapping

func (u *UPnP) AddPortMapping(port uint16) er.R

AddPortMapping enables port forwarding for the given port.

func (*UPnP) DeletePortMapping

func (u *UPnP) DeletePortMapping(port uint16) er.R

DeletePortMapping disables port forwarding for the given port.

func (*UPnP) ExternalIP

func (u *UPnP) ExternalIP() (net.IP, er.R)

ExternalIP returns the external IP address of the UPnP enabled device.

func (*UPnP) ForwardedPorts

func (u *UPnP) ForwardedPorts() []uint16

ForwardedPorts returns a list of ports currently being forwarded.

func (*UPnP) Name

func (u *UPnP) Name() string

Name returns the name of the specific NAT traversal technique used.