tun

Documentation

Index

• Variables
• type Addr
• type Client
• type ClientOption
  • func WithConnectAddress(addr string) ClientOption
• type ClientOptions
• type ConnIDContextKey
• type Handler
• type Server
• type ServerOption
  • func WithListenAddress(addr string) ServerOption
• type ServerOptions

Variables

var (
	DefaultConnectAddress = "ws://127.0.0.1:8080/stream"
)

default client options

var (
	DefaultListenAddress = "ws://0.0.0.0:8080/stream"
)

default server options

var (
	NewClient = newWsClient
)

default client

var (
	NewServer = newWsServer
)

default server

Types

type Addr

type Addr interface {
	String() string
}

Addr is tunnel address

type Client

type Client interface {
	DialAndServe(ctx context.Context, h Handler) error
}

Client is tunnel client

type ClientOption

type ClientOption func(*ClientOptions)

ClientOption is option setter for client

func WithConnectAddress

func WithConnectAddress(addr string) ClientOption

WithConnectAddress sets client connect address opt

type ClientOptions

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

ClientOptions is client options

type ConnIDContextKey

type ConnIDContextKey struct{}

ConnIDContextKey is context key of connID

type Handler

type Handler interface {
	ServeTun(ctx context.Context, r io.Reader, w io.Writer)
}

Handler is tunnel handler

type Server

type Server interface {
	ListenAndServe(ctx context.Context, h Handler) error
}

Server is tunnel server

type ServerOption

type ServerOption func(*ServerOptions)

ServerOption is option setter for server

func WithListenAddress

func WithListenAddress(addr string) ServerOption

WithListenAddress sets server listen address opt

type ServerOptions

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

ServerOptions is server options