core

package

v0.0.0-...-e7d7f47 Latest Latest Go to latest Published: May 13, 2021 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

This section is empty.

This section is empty.

func CreateEndpoint(dev Device) stack.LinkEndpoint

type Device interface {
	Reader
	Writer
	DeviceType() string
	GetMTU() int
}

Device is a tun-like device for reading packets from system

type Endpoint struct {
	*channel.Endpoint
	Reader Reader
	Writer Writer
	// contains filtered or unexported fields
}

func (e *Endpoint) Attach(dispatcher stack.NetworkDispatcher)

Attach is to attach device to stack

func (e *Endpoint) WriteNotify()

WriteNotify will be called when a write happens to the queue.

type Handler interface {
	Handle(*TCPConn)
	HandlePacket(*UDPPacket)
}

Handler is for handling incoming TCP and UDP connections

type Reader interface {
	Read([]byte, int) (int, error)
}

type Stack struct {
	Device  Device
	Handler Handler
	Stack   *stack.Stack
}

Stack go netstack provided by gvisor.dev

func (s *Stack) Close() error

Close is to close the stack

func (s *Stack) HandlePacket(id stack.TransportEndpointID, pkt *stack.PacketBuffer) bool

func (s *Stack) HandleStream(r *tcp.ForwarderRequest)

HandleStream is to handle incoming TCP connections

func (s *Stack) Start(device Device, handler Handler) (err error)

type TCPConn struct {
	gonet.TCPConn
}

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

func (p *UDPPacket) Data() []byte

func (p *UDPPacket) Drop()

func (p *UDPPacket) LocalAddr() net.Addr

func (p *UDPPacket) RemoteAddr() net.Addr

func (p *UDPPacket) WriteBack(b []byte, addr net.Addr) (int, error)

type Writer interface {
	// Write packets to tun device
	Write([]byte, int) (int, error)
}