Documentation ¶
Overview ¶
Package net is a drop-in replacement to Golang's net package, with some more functionalities.
Index ¶
- Constants
- Variables
- type Addr
- type AddrError
- type Address
- type AddressFamily
- type Conn
- type Destination
- type Dialer
- type Endpoint
- func (p *Endpoint) AsDestination() Destination
- func (*Endpoint) Descriptor() ([]byte, []int)
- func (m *Endpoint) GetAddress() *IPOrDomain
- func (m *Endpoint) GetNetwork() Network
- func (m *Endpoint) GetPort() uint32
- func (*Endpoint) ProtoMessage()
- func (m *Endpoint) Reset()
- func (m *Endpoint) String() string
- type Error
- type IP
- type IPMask
- type IPNet
- type IPNetTable
- type IPOrDomain
- func (d *IPOrDomain) AsAddress() Address
- func (*IPOrDomain) Descriptor() ([]byte, []int)
- func (m *IPOrDomain) GetAddress() isIPOrDomain_Address
- func (m *IPOrDomain) GetDomain() string
- func (m *IPOrDomain) GetIp() []byte
- func (*IPOrDomain) ProtoMessage()
- func (m *IPOrDomain) Reset()
- func (m *IPOrDomain) String() string
- func (*IPOrDomain) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type IPOrDomain_Domain
- type IPOrDomain_Ip
- type Listener
- type Network
- type NetworkList
- func (*NetworkList) Descriptor() ([]byte, []int)
- func (l NetworkList) Get(idx int) Network
- func (m *NetworkList) GetNetwork() []Network
- func (l NetworkList) HasNetwork(network Network) bool
- func (*NetworkList) ProtoMessage()
- func (m *NetworkList) Reset()
- func (l NetworkList) Size() int
- func (m *NetworkList) String() string
- type Port
- type PortRange
- func (p PortRange) Contains(port Port) bool
- func (*PortRange) Descriptor() ([]byte, []int)
- func (p PortRange) FromPort() Port
- func (m *PortRange) GetFrom() uint32
- func (m *PortRange) GetTo() uint32
- func (*PortRange) ProtoMessage()
- func (m *PortRange) Reset()
- func (m *PortRange) String() string
- func (p PortRange) ToPort() Port
- type TCPAddr
- type TCPConn
- type TCPListener
- type UDPAddr
- type UDPConn
- type UnixAddr
- type UnixConn
- type UnixListener
Constants ¶
const ( // AddressFamilyIPv4 represents address as IPv4 AddressFamilyIPv4 = AddressFamily(0) // AddressFamilyIPv6 represents address as IPv6 AddressFamilyIPv6 = AddressFamily(1) // AddressFamilyDomain represents address as Domain AddressFamilyDomain = AddressFamily(2) )
const IPv4len = net.IPv4len
const IPv6len = net.IPv6len
Variables ¶
var ( // LocalHostIP is a constant value for localhost IP in IPv4. LocalHostIP = IPAddress([]byte{127, 0, 0, 1}) // AnyIP is a constant value for any IP in IPv4. AnyIP = IPAddress([]byte{0, 0, 0, 0}) // LocalHostDomain is a constant value for localhost domain. LocalHostDomain = DomainAddress("localhost") // LocalHostIPv6 is a constant value for localhost IP in IPv6. LocalHostIPv6 = IPAddress([]byte{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1}) )
var CIDRMask = net.CIDRMask
var DialTCP = net.DialTCP
DialTCP is an injectable function. Default to net.DialTCP
var DialUDP = net.DialUDP
var DialUnix = net.DialUnix
var FileConn = net.FileConn
var Listen = net.Listen
var ListenTCP = net.ListenTCP
var ListenUDP = net.ListenUDP
var LookupIP = net.LookupIP
var Network_name = map[int32]string{
0: "Unknown",
1: "RawTCP",
2: "TCP",
3: "UDP",
}
var Network_value = map[string]int32{
"Unknown": 0,
"RawTCP": 1,
"TCP": 2,
"UDP": 3,
}
var ParseIP = net.ParseIP
var SplitHostPort = net.SplitHostPort
Functions ¶
This section is empty.
Types ¶
type Address ¶
type Address interface { IP() net.IP // IP of this Address Domain() string // Domain of this Address Family() AddressFamily String() string // String representation of this Address }
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 ¶ added in v1.9.1
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 AddressFamily ¶ added in v1.24.3
type AddressFamily int
AddressFamily is the type of address.
func (AddressFamily) Either ¶ added in v1.24.3
func (af AddressFamily) Either(fs ...AddressFamily) bool
Either returns true if current AddressFamily matches any of the AddressFamilies provided.
func (AddressFamily) IsDomain ¶ added in v1.24.3
func (af AddressFamily) IsDomain() bool
IsDomain returns true if current AddressFamily is Domain.
func (AddressFamily) IsIPv4 ¶ added in v1.24.3
func (af AddressFamily) IsIPv4() bool
IsIPv4 returns true if current AddressFamily is IPv4.
func (AddressFamily) IsIPv6 ¶ added in v1.24.3
func (af AddressFamily) IsIPv6() bool
IsIPv6 returns true if current AddressFamily is IPv6.
type Destination ¶
Destination represents a network destination including address and protocol (tcp / udp).
func DestinationFromAddr ¶ added in v1.24.3
func DestinationFromAddr(addr net.Addr) Destination
DestinationFromAddr generates a Destination from a net address.
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
func (Destination) IsValid ¶
func (d Destination) IsValid() bool
IsValid returns true if this Destination is valid.
func (Destination) NetAddr ¶ added in v1.9.1
func (d Destination) NetAddr() string
NetAddr returns the network address in this Destination in string form.
func (Destination) String ¶
func (d Destination) String() string
String returns the strings form of this Destination.
type Endpoint ¶
type Endpoint struct { Network Network `protobuf:"varint,1,opt,name=network,enum=v2ray.core.common.net.Network" json:"network,omitempty"` Address *IPOrDomain `protobuf:"bytes,2,opt,name=address" json:"address,omitempty"` Port uint32 `protobuf:"varint,3,opt,name=port" json:"port,omitempty"` }
Endpoint of a network connection.
func (*Endpoint) AsDestination ¶
func (p *Endpoint) AsDestination() Destination
AsDestination converts current Enpoint into Destination.
func (*Endpoint) Descriptor ¶
func (*Endpoint) GetAddress ¶
func (m *Endpoint) GetAddress() *IPOrDomain
func (*Endpoint) GetNetwork ¶
func (*Endpoint) ProtoMessage ¶
func (*Endpoint) ProtoMessage()
type IPNetTable ¶
type IPNetTable struct {
// contains filtered or unexported fields
}
func NewIPNetTable ¶
func NewIPNetTable() *IPNetTable
func (*IPNetTable) Add ¶
func (n *IPNetTable) Add(ipNet *net.IPNet)
func (*IPNetTable) AddIP ¶
func (n *IPNetTable) AddIP(ip []byte, mask byte)
func (*IPNetTable) IsEmpty ¶
func (n *IPNetTable) IsEmpty() bool
type IPOrDomain ¶
type IPOrDomain struct { // Types that are valid to be assigned to Address: // *IPOrDomain_Ip // *IPOrDomain_Domain Address isIPOrDomain_Address `protobuf_oneof:"address"` }
Address of a network host. It may be either an IP address or a domain address.
func NewIPOrDomain ¶
func NewIPOrDomain(addr Address) *IPOrDomain
NewIPOrDomain translates Address to IPOrDomain
func (*IPOrDomain) AsAddress ¶
func (d *IPOrDomain) AsAddress() Address
AsAddress translates IPOrDomain to Address.
func (*IPOrDomain) Descriptor ¶
func (*IPOrDomain) Descriptor() ([]byte, []int)
func (*IPOrDomain) GetAddress ¶
func (m *IPOrDomain) GetAddress() isIPOrDomain_Address
func (*IPOrDomain) GetDomain ¶
func (m *IPOrDomain) GetDomain() string
func (*IPOrDomain) GetIp ¶
func (m *IPOrDomain) GetIp() []byte
func (*IPOrDomain) ProtoMessage ¶
func (*IPOrDomain) ProtoMessage()
func (*IPOrDomain) Reset ¶
func (m *IPOrDomain) Reset()
func (*IPOrDomain) String ¶
func (m *IPOrDomain) String() string
func (*IPOrDomain) XXX_OneofFuncs ¶
func (*IPOrDomain) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
type IPOrDomain_Domain ¶
type IPOrDomain_Domain struct {
Domain string `protobuf:"bytes,2,opt,name=domain,oneof"`
}
type IPOrDomain_Ip ¶
type IPOrDomain_Ip struct {
Ip []byte `protobuf:"bytes,1,opt,name=ip,proto3,oneof"`
}
type Network ¶ added in v0.14.4
type Network int32
func ParseNetwork ¶
func (Network) AsList ¶ added in v1.9.1
func (n Network) AsList() *NetworkList
func (Network) EnumDescriptor ¶
func (Network) SystemString ¶
type NetworkList ¶ added in v0.14.4
type NetworkList struct {
Network []Network `protobuf:"varint,1,rep,packed,name=network,enum=v2ray.core.common.net.Network" json:"network,omitempty"`
}
NetworkList is a list of Networks.
func (*NetworkList) Descriptor ¶
func (*NetworkList) Descriptor() ([]byte, []int)
func (NetworkList) Get ¶
func (l NetworkList) Get(idx int) Network
func (*NetworkList) GetNetwork ¶
func (m *NetworkList) GetNetwork() []Network
func (NetworkList) HasNetwork ¶ added in v0.14.4
func (l NetworkList) HasNetwork(network Network) bool
HasNetwork returns true if the given network is in v NetworkList.
func (*NetworkList) ProtoMessage ¶
func (*NetworkList) ProtoMessage()
func (*NetworkList) Reset ¶
func (m *NetworkList) Reset()
func (NetworkList) Size ¶
func (l NetworkList) Size() int
Size returns the number of networks in this network list.
func (*NetworkList) String ¶
func (m *NetworkList) String() string
type Port ¶ added in v1.1.1
type Port uint16
Port represents a network port in TCP and UDP protocol.
func PortFromBytes ¶ added in v1.1.1
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 ¶ added in v1.9.1
PortFromInt converts an integer to a Port. @error when the integer is not positive or larger then 65535
func PortFromString ¶ added in v1.9.1
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.
func (Port) Bytes ¶ added in v1.1.1
Bytes returns the correspoding bytes of a Port, in big endian order.
type PortRange ¶ added in v0.14.4
type PortRange struct { // The port that this range starts from. From uint32 `protobuf:"varint,1,opt,name=From" json:"From,omitempty"` // The port that this range ends with (inclusive). To uint32 `protobuf:"varint,2,opt,name=To" json:"To,omitempty"` }
PortRange represents a range of ports.
func SinglePortRange ¶
SinglePortRange returns a PortRange contains a single port.
func (PortRange) Contains ¶ added in v1.9.1
Contains returns true if the given port is within the range of a PortRange.
func (*PortRange) Descriptor ¶
func (*PortRange) ProtoMessage ¶
func (*PortRange) ProtoMessage()
type TCPListener ¶
type TCPListener = net.TCPListener
type UnixListener ¶
type UnixListener = net.UnixListener