stun

package

v0.0.0-...-65db379 Latest Latest Go to latest Published: Aug 17, 2013 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/gwik/go-stun

Links

Open Source Insights

Documentation ¶

Overview ¶

go-stun is a STUN (RFC 3489 and RFC 5389) client implementation in golang.

It is extremely easy to use -- just one line of code.

nat, host, err := stun.Discover()

More details please go to `example.go`.

Index ¶

Constants
func SetServerAddr(address string)
func SetServerHost(host string, port int) error
func SetSoftwareName(name string)
type Host
- func Discover() (int, *Host, error)

Constants ¶

View Source

const (
	DefaultServerHost   = "provserver.televolution.net"
	DefaultServerPort   = 3478
	DefaultSoftwareName = "StunClient"
)

View Source

const (
	NAT_ERROR = iota
	NAT_UNKNOWN
	NAT_NONE
	NAT_BLOCKED
	NAT_FULL
	NAT_SYMETRIC
	NAT_RESTRICTED
	NAT_PORT_RESTRICTED
	NAT_SYMETRIC_UDP_FIREWALL
)

Variables ¶

This section is empty.

Functions ¶

func SetServerAddr ¶

func SetServerAddr(address string)

SetServerAddr allows user to set the transport layer STUN server address

func SetServerHost ¶

func SetServerHost(host string, port int) error

SetServerHost allows user to set the STUN hostname and port

func SetSoftwareName ¶

func SetSoftwareName(name string)

SetSoftwareName allows user to set the name of her software

Types ¶

type Host ¶

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

func Discover ¶

func Discover() (int, *Host, error)

Discover contacts the STUN server and gets the response of NAT type, host for UDP punching

func (*Host) Family ¶

func (h *Host) Family() uint16

func (*Host) Ip ¶

func (h *Host) Ip() string

func (*Host) Port ¶

func (h *Host) Port() uint16

func (*Host) TransportAddr ¶

func (h *Host) TransportAddr() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL