net

Documentation

Index

• Constants
• func ChanToWriter(writer io.Writer, stream <-chan *alloc.Buffer) error
• func ReadAllBytes(reader io.Reader, buffer []byte) (int, error)
• func ReadFrom(reader io.Reader, buffer *alloc.Buffer) (*alloc.Buffer, error)
• func ReaderToChan(stream chan<- *alloc.Buffer, reader io.Reader) error
• type Address
  • func DomainAddress(domain string, port uint16) Address
  • func IPAddress(ip []byte, port uint16) Address
• type Destination
  • func NewTCPDestination(address Address) Destination
  • func NewUDPDestination(address Address) Destination
• type DomainAddressImpl
  • func (addr DomainAddressImpl) Domain() string
  • func (addr DomainAddressImpl) IP() net.IP
  • func (addr DomainAddressImpl) IsDomain() bool
  • func (addr DomainAddressImpl) IsIPv4() bool
  • func (addr DomainAddressImpl) IsIPv6() bool
  • func (addr DomainAddressImpl) String() string
• type IPv4Address
  • func (addr IPv4Address) Domain() string
  • func (addr IPv4Address) IP() net.IP
  • func (addr IPv4Address) IsDomain() bool
  • func (addr IPv4Address) IsIPv4() bool
  • func (addr IPv4Address) IsIPv6() bool
  • func (addr IPv4Address) String() string
• type IPv6Address
  • func (addr IPv6Address) Domain() string
  • func (addr IPv6Address) IP() net.IP
  • func (addr IPv6Address) IsDomain() bool
  • func (addr IPv6Address) IsIPv4() bool
  • func (addr IPv6Address) IsIPv6() bool
  • func (addr IPv6Address) String() string
• type Network
• type NetworkList
• type Packet
  • func NewPacket(dest Destination, firstChunk *alloc.Buffer, moreChunks bool) Packet
• type PortAddress
  • func (addr PortAddress) Port() uint16
  • func (addr PortAddress) PortBytes() []byte
• type PortRange
• type TCPDestination
  • func (dest TCPDestination) Address() Address
  • func (dest TCPDestination) IsTCP() bool
  • func (dest TCPDestination) IsUDP() bool
  • func (dest TCPDestination) Network() string
  • func (dest TCPDestination) String() string
• type TimeOutReader
  • func NewTimeOutReader(timeout int, connection net.Conn) *TimeOutReader
  • func (reader *TimeOutReader) GetTimeOut() int
  • func (reader *TimeOutReader) Read(p []byte) (int, error)
  • func (reader *TimeOutReader) SetTimeOut(value int)
• type UDPDestination
  • func (dest UDPDestination) Address() Address
  • func (dest UDPDestination) IsTCP() bool
  • func (dest UDPDestination) IsUDP() bool
  • func (dest UDPDestination) Network() string
  • func (dest UDPDestination) String() string

Constants

const (
	TCPNetwork = Network("tcp")
	UDPNetwork = Network("udp")
)

Functions

func ChanToWriter

func ChanToWriter(writer io.Writer, stream <-chan *alloc.Buffer) error

ChanToWriter dumps all content from a given chan to a writer until the chan is closed.

func ReadAllBytes

func ReadAllBytes(reader io.Reader, buffer []byte) (int, error)

ReadAllBytes reads all bytes required from reader, if no error happens.

func ReadFrom

func ReadFrom(reader io.Reader, buffer *alloc.Buffer) (*alloc.Buffer, error)

ReadFrom reads from a reader and put all content to a buffer. If buffer is nil, ReadFrom creates a new normal buffer.

func ReaderToChan

func ReaderToChan(stream chan<- *alloc.Buffer, reader io.Reader) error

ReaderToChan dumps all content from a given reader to a chan by constantly reading it until EOF.

Types

type Address

type Address interface {
	IP() net.IP        // IP of this Address
	Domain() string    // Domain of this Address
	Port() uint16      // Port of this Address
	PortBytes() []byte // Port in bytes, network byte order

	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
}

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

func DomainAddress(domain string, port uint16) Address

DomainAddress creates an Address with given domain and port.

func IPAddress

func IPAddress(ip []byte, port uint16) Address

IPAddress creates an Address with given IP and port.

type Destination

type Destination interface {
	Network() string  // Protocol of communication (tcp / udp)
	Address() Address // Address of destination
	String() string   // String representation of the destination

	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 NewTCPDestination

func NewTCPDestination(address Address) Destination

NewTCPDestination creates a TCP destination with given address

func NewUDPDestination

func NewUDPDestination(address Address) Destination

NewUDPDestination creates a UDP destination with given address

type DomainAddressImpl

type DomainAddressImpl struct {
	PortAddress
	// contains filtered or unexported fields
}

func (DomainAddressImpl) Domain

func (addr DomainAddressImpl) Domain() string

func (DomainAddressImpl) IP

func (addr DomainAddressImpl) IP() net.IP

func (DomainAddressImpl) IsDomain

func (addr DomainAddressImpl) IsDomain() bool

func (DomainAddressImpl) IsIPv4

func (addr DomainAddressImpl) IsIPv4() bool

func (DomainAddressImpl) IsIPv6

func (addr DomainAddressImpl) IsIPv6() bool

func (DomainAddressImpl) String

func (addr DomainAddressImpl) String() string

type IPv4Address

type IPv4Address struct {
	PortAddress
	// contains filtered or unexported fields
}

func (IPv4Address) Domain

func (addr IPv4Address) Domain() string

func (IPv4Address) IP

func (addr IPv4Address) IP() net.IP

func (IPv4Address) IsDomain

func (addr IPv4Address) IsDomain() bool

func (IPv4Address) IsIPv4

func (addr IPv4Address) IsIPv4() bool

func (IPv4Address) IsIPv6

func (addr IPv4Address) IsIPv6() bool

func (IPv4Address) String

func (addr IPv4Address) String() string

type IPv6Address

type IPv6Address struct {
	PortAddress
	// contains filtered or unexported fields
}

func (IPv6Address) Domain

func (addr IPv6Address) Domain() string

func (IPv6Address) IP

func (addr IPv6Address) IP() net.IP

func (IPv6Address) IsDomain

func (addr IPv6Address) IsDomain() bool

func (IPv6Address) IsIPv4

func (addr IPv6Address) IsIPv4() bool

func (IPv6Address) IsIPv6

func (addr IPv6Address) IsIPv6() bool

func (IPv6Address) String

func (addr IPv6Address) String() string

type Network

type Network string

type NetworkList

type NetworkList interface {
	HasNetwork(Network) bool
}

type Packet

type Packet interface {
	Destination() Destination
	Chunk() *alloc.Buffer // First chunk of this commnunication
	MoreChunks() bool
}

Packet is a network packet to be sent to destination.

func NewPacket

func NewPacket(dest Destination, firstChunk *alloc.Buffer, moreChunks bool) Packet

NewPacket creates a new Packet with given destination and payload.

type PortAddress

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

func (PortAddress) Port

func (addr PortAddress) Port() uint16

func (PortAddress) PortBytes

func (addr PortAddress) PortBytes() []byte

type PortRange

type PortRange interface {
	From() uint16
	To() uint16
}

type TCPDestination

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

func (TCPDestination) Address

func (dest TCPDestination) Address() Address

func (TCPDestination) IsTCP

func (dest TCPDestination) IsTCP() bool

func (TCPDestination) IsUDP

func (dest TCPDestination) IsUDP() bool

func (TCPDestination) Network

func (dest TCPDestination) Network() string

func (TCPDestination) String

func (dest TCPDestination) String() string

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) Read

func (reader *TimeOutReader) Read(p []byte) (int, error)

func (*TimeOutReader) SetTimeOut

func (reader *TimeOutReader) SetTimeOut(value int)

type UDPDestination

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

func (UDPDestination) Address

func (dest UDPDestination) Address() Address

func (UDPDestination) IsTCP

func (dest UDPDestination) IsTCP() bool

func (UDPDestination) IsUDP

func (dest UDPDestination) IsUDP() bool

func (UDPDestination) Network

func (dest UDPDestination) Network() string

func (UDPDestination) String

func (dest UDPDestination) String() string