nats

Documentation

Index

• type Config
• type DiscoverResult
• type EndpointDependencyType
  • func (t EndpointDependencyType) String() string
• type NATS
  • func NewNATS(config *Config) (*NATS, error)
  • func (nats *NATS) Discover() (*DiscoverResult, error)

Types

type Config

type Config struct {
	Server  string
	Verbose bool
	Net     *vnet.Net
}

Config has config parameters for NewNATS.

type DiscoverResult

type DiscoverResult struct {
	IsNatted          bool                   `json:"isNatted"`
	MappingBehavior   EndpointDependencyType `json:"mappingBehavior"`
	FilteringBehavior EndpointDependencyType `json:"filteringBehavior"`
	PortPreservation  bool                   `json:"portPreservation"`
	NATType           string                 `json:"natType"`
	ExternalIP        string                 `json:"externalIP"`
}

DiscoverResult contains a set of results from Discover method.

type EndpointDependencyType

type EndpointDependencyType uint8

EndpointDependencyType ...

const (
	// EndpointIndependent means the behavior is independent of the endpoint's address or port
	EndpointIndependent EndpointDependencyType = iota
	// EndpointAddrDependent means the behavior is dependent on the endpoint's address
	EndpointAddrDependent
	// EndpointAddrPortDependent means the behavior is dependent on the endpoint's address and port
	EndpointAddrPortDependent
	// EndpointUndefined ...
	EndpointUndefined
)

func (EndpointDependencyType) String

func (t EndpointDependencyType) String() string

type NATS

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

NATS a class supports NAT type discovery feature.

func NewNATS

func NewNATS(config *Config) (*NATS, error)

NewNATS creats a new instance of NATS.

func (*NATS) Discover

func (nats *NATS) Discover() (*DiscoverResult, error)

Discover performs NAT discovery process defined in RFC 5780.