Documentation
¶
Overview ¶
Package net contains common network utilities.
Index ¶
Constants ¶
const ( // TCPNetwork represents the TCP network. TCPNetwork = Network("tcp") // UDPNetwork represents the UDP network. UDPNetwork = Network("udp") // KCPNetwork represents the KCP network. KCPNetwork = Network("kcp") )
Variables ¶
var ( LocalHostIP = IPAddress([]byte{127, 0, 0, 1}) AnyIP = IPAddress([]byte{0, 0, 0, 0}) )
var ( // ErrInvalidPortRage indicates an error during port range parsing. ErrInvalidPortRange = errors.New("Invalid port range.") )
Functions ¶
This section is empty.
Types ¶
type Address ¶
type Address interface {
IP() net.IP // IP of this Address
Domain() string // Domain of this Address
IsIPv4() bool // True if this Address is an IPv4 address
IsIPv6() bool // True if this Address is an IPv6 address
IsDomain() bool // True if this Address is an domain address
String() string // String representation of this Address
Equals(Address) bool
}
Address represents a network address to be communicated with. It may be an IP address or domain address, not both. This interface doesn't resolve IP address for a given domain.
func DomainAddress ¶
DomainAddress creates an Address with given domain.
func ParseAddress ¶
ParseAddress parses a string into an Address. The return value will be an IPAddress when the string is in the form of IPv4 or IPv6 address, or a DomainAddress otherwise.
type Destination ¶
type Destination interface {
Network() Network // Protocol of communication (tcp / udp)
Address() Address // Address of destination
Port() Port
String() string // String representation of the destination
NetAddr() string
Equals(Destination) bool
IsTCP() bool // True if destination is reachable via TCP
IsUDP() bool // True if destination is reachable via UDP
}
Destination represents a network destination including address and protocol (tcp / udp).
func TCPDestination ¶
func TCPDestination(address Address, port Port) Destination
TCPDestination creates a TCP destination with given address
func UDPDestination ¶
func UDPDestination(address Address, port Port) Destination
UDPDestination creates a UDP destination with given address
type IPNet ¶
type IPNet struct {
// contains filtered or unexported fields
}
func NewIPNetInitialValue ¶
type Network ¶
type Network string
Network represents a communication network on internet.
func (Network) AsList ¶
func (this Network) AsList() *NetworkList
type NetworkList ¶
type NetworkList []Network
NetworkList is a list of Networks.
func NewNetworkList ¶
func NewNetworkList(networks collect.StringList) NetworkList
NewNetworkList construsts a NetWorklist from the given StringListeralList.
func (*NetworkList) HasNetwork ¶
func (this *NetworkList) HasNetwork(network Network) bool
HashNetwork returns true if the given network is in this NetworkList.
type Port ¶
type Port uint16
Port represents a network port in TCP and UDP protocol.
func PortFromBytes ¶
PortFromBytes converts a byte array to a Port, assuming bytes are in big endian order. @unsafe Caller must ensure that the byte array has at least 2 elements.
func PortFromInt ¶
PortFromInt converts an integer to a Port. @error when the integer is not positive or larger then 65535
func PortFromString ¶
PortFromString converts a string to a Port. @error when the string is not an integer or the integral value is a not a valid Port.
type TimeOutReader ¶
type TimeOutReader struct {
// contains filtered or unexported fields
}
func NewTimeOutReader ¶
func NewTimeOutReader(timeout int, connection net.Conn) *TimeOutReader
func (*TimeOutReader) GetTimeOut ¶
func (reader *TimeOutReader) GetTimeOut() int
func (*TimeOutReader) Release ¶
func (reader *TimeOutReader) Release()
func (*TimeOutReader) SetTimeOut ¶
func (reader *TimeOutReader) SetTimeOut(value int)
Source Files
Directories