natt

README

go-libp2p-natt

Documentation

Index

• Constants
• Variables
• func GetOutboundIP() net.IP
• type Host
  • func CreateHost(identityKey crypto.PrivKey, port int, NATdiscoverAddr string) (*Host, error)
  • func (h *Host) ConnectPeer(peerAddr string) error
  • func (h *Host) GetBroadcastAddrInfo() string
  • func (h *Host) GetHost() host.Host
  • func (h *Host) GetHostID() peer.ID
  • func (h *Host) GetInternalPort() int
  • func (h *Host) GetNATType() network.Reachability
  • func (h *Host) Quit()
• type TraversalMethod

Constants

const (
	TraversalPMP       = "pmp"
	TraversalHolePunch = "punching"
	TraversalHW        = "highway"
	TraversalNone      = "none"
)

Variables

var (
	//ErrShouldHaveIPAddress ...
	ErrShouldHaveIPAddress = errors.New("error machine should have an assigned IP address")
	//ErrNoNATDeviceFound ...
	ErrNoNATDeviceFound = errors.New("error no NAT devices found")
	//ErrCreatingHost ...
	ErrCreatingHost = errors.New("error creating host")
	//ErrCantUpdateBroadcastAddress ...
	ErrCantUpdateBroadcastAddress = errors.New("error cant update broadcast address")
	//ErrCantConnectToNATDiscoverAddress ...
	ErrCantConnectToNATDiscoverAddress = errors.New("error cant connect to NAT discover address")
	// ErrNoMapping signals no mapping exists for an address
	ErrNoMapping = errors.New("mapping not established")
	// ErrCantGetExternalAddress ...
	ErrCantGetExternalAddress = errors.New("error cant get external address")
)

Functions

func GetOutboundIP

func GetOutboundIP() net.IP

Get preferred outbound ip of this machine

Types

type Host

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

func CreateHost

func CreateHost(identityKey crypto.PrivKey, port int, NATdiscoverAddr string) (*Host, error)

func (*Host) ConnectPeer

func (h *Host) ConnectPeer(peerAddr string) error

func (*Host) GetBroadcastAddrInfo

func (h *Host) GetBroadcastAddrInfo() string

func (*Host) GetHost

func (h *Host) GetHost() host.Host

func (*Host) GetHostID

func (h *Host) GetHostID() peer.ID

func (*Host) GetInternalPort

func (h *Host) GetInternalPort() int

func (*Host) GetNATType

func (h *Host) GetNATType() network.Reachability

func (*Host) Quit

func (h *Host) Quit()

type TraversalMethod

type TraversalMethod string