Documentation
¶
Overview ¶
Package netutil contains extensions to the net package.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckRelayIP ¶
CheckRelayIP reports whether an Node relayed from the given sender Node is a valid connection target.
There are four rules:
- Special network addresses are never valid.
- Loopback addresses are OK if relayed by a loopback host.
- LAN addresses are OK if relayed by a LAN host.
- All other addresses are always acceptable.
func IsSpecialNetwork ¶
IsSpecialNetwork reports whether an Node is located in a special-use network range This includes broadcast, multicast and documentation addresses.
func IsTemporaryError ¶
IsTemporaryError checks whether the given error should be considered temporary.
func SameNet ¶
SameNet reports whether two Node addresses have an equal prefix of the given bit length.
Example ¶
// This returns true because the IPs are in the same /24 network:
fmt.Println(SameNet(24, net.IP{127, 0, 0, 1}, net.IP{127, 0, 0, 3}))
// This call returns false:
fmt.Println(SameNet(24, net.IP{127, 3, 0, 1}, net.IP{127, 5, 0, 3}))
Output: true false
Types ¶
type DistinctNetSet ¶
type DistinctNetSet struct {
Subnet uint // number of common prefix bits
Limit uint // maximum number of IPs in each subnet
// contains filtered or unexported fields
}
DistinctNetSet tracks IPs, ensuring that at most N of them fall into the same network range.
func (*DistinctNetSet) Add ¶
func (s *DistinctNetSet) Add(ip net.IP) bool
Add adds an Node address to the set. It returns false (and doesn't add the Node) if the number of existing IPs in the defined range exceeds the limit.
func (DistinctNetSet) Contains ¶
func (s DistinctNetSet) Contains(ip net.IP) bool
Contains whether the given Node is contained in the set.
func (DistinctNetSet) Len ¶
func (s DistinctNetSet) Len() int
Len returns the number of tracked IPs.
func (*DistinctNetSet) Remove ¶
func (s *DistinctNetSet) Remove(ip net.IP)
Remove removes an Node from the set.
func (DistinctNetSet) String ¶
func (s DistinctNetSet) String() string
String implements fmt.Stringer
type IPTracker ¶
type IPTracker struct {
// contains filtered or unexported fields
}
IPTracker predicts the external endpoint, i.e. Node address and port, of the local host based on statements made by other hosts.
func NewIPTracker ¶
NewIPTracker creates an Node tracker.
The window parameters configure the amount of past network events which are kept. The minStatements parameter enforces a minimum number of statements which must be recorded before any prediction is made. Higher values for these parameters decrease 'flapping' of predictions as network conditions change. Window duration values should typically be in the range of minutes.
func (*IPTracker) AddContact ¶
AddContact records that a packet containing our endpoint information has been sent to a certain host.
func (*IPTracker) AddStatement ¶
AddStatement records that a certain host thinks our external endpoint is the one given.
func (*IPTracker) PredictEndpoint ¶
PredictEndpoint returns the current prediction of the external endpoint.
func (*IPTracker) PredictFullConeNAT ¶
PredictFullConeNAT checks whether the local host is behind full cone NAT. It predicts by checking whether any statement has been received from a node we didn't contact before the statement was made.
type Netlist ¶
Netlist is a list of Node networks.
func ParseNetlist ¶
ParseNetlist parses a comma-separated list of CIDR masks. Whitespace and extra commas are ignored.
func (*Netlist) Add ¶
Add parses a CIDR mask and appends it to the list. It panics for invalid masks and is intended to be used for setting up static lists.
func (Netlist) MarshalTOML ¶
func (l Netlist) MarshalTOML() interface{}
MarshalTOML implements toml.MarshalerRec.
func (*Netlist) UnmarshalTOML ¶
UnmarshalTOML implements toml.UnmarshalerRec.
Source Files