transport

Documentation

Index

• Constants
• type Client
  • func NewClient(ctx context.Context, c tunnel.Client) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) DialConn(*tunnel.Address, tunnel.Tunnel) (tunnel.Conn, error)
  • func (c *Client) DialPacket(tunnel.Tunnel) (tunnel.PacketConn, error)
• type Config
• type Conn
  • func (c *Conn) Metadata() *tunnel.Metadata
• type Server
  • func NewServer(ctx context.Context, _ tunnel.Server) (*Server, error)
  • func (s *Server) AcceptConn(overlay tunnel.Tunnel) (tunnel.Conn, error)
  • func (s *Server) AcceptPacket(tunnel.Tunnel) (tunnel.PacketConn, error)
  • func (s *Server) Close() error
• type TransportPluginConfig
• type Tunnel
  • func (*Tunnel) Name() string
  • func (*Tunnel) NewClient(ctx context.Context, client tunnel.Client) (tunnel.Client, error)
  • func (*Tunnel) NewServer(ctx context.Context, server tunnel.Server) (tunnel.Server, error)

Constants

const Name = "TRANSPORT"

Types

type Client

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

Client implements tunnel.Client

func NewClient

func NewClient(ctx context.Context, c tunnel.Client) (*Client, error)

NewClient creates a transport layer client

func (*Client) Close

func (c *Client) Close() error

func (*Client) DialConn

func (c *Client) DialConn(*tunnel.Address, tunnel.Tunnel) (tunnel.Conn, error)

DialConn implements tunnel.Client. It will ignore the params and directly dial to the remote server

func (*Client) DialPacket

func (c *Client) DialPacket(tunnel.Tunnel) (tunnel.PacketConn, error)

type Config

type Config struct {
	LocalHost       string                `json:"local_addr" yaml:"local-addr"`
	LocalPort       int                   `json:"local_port" yaml:"local-port"`
	RemoteHost      string                `json:"remote_addr" yaml:"remote-addr"`
	RemotePort      int                   `json:"remote_port" yaml:"remote-port"`
	TransportPlugin TransportPluginConfig `json:"transport_plugin" yaml:"transport-plugin"`
}

type Conn

type Conn struct {
	net.Conn
}

func (*Conn) Metadata

func (c *Conn) Metadata() *tunnel.Metadata

type Server

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

Server is a server of transport layer

func NewServer

func NewServer(ctx context.Context, _ tunnel.Server) (*Server, error)

NewServer creates a transport layer server

func (*Server) AcceptConn

func (s *Server) AcceptConn(overlay tunnel.Tunnel) (tunnel.Conn, error)

func (*Server) AcceptPacket

func (s *Server) AcceptPacket(tunnel.Tunnel) (tunnel.PacketConn, error)

func (*Server) Close

func (s *Server) Close() error

type TransportPluginConfig

type TransportPluginConfig struct {
	Enabled      bool     `json:"enabled" yaml:"enabled"`
	Type         string   `json:"type" yaml:"type"`
	Command      string   `json:"command" yaml:"command"`
	PluginOption string   `json:"plugin_option" yaml:"plugin-option"`
	Arg          []string `json:"arg" yaml:"arg"`
	Env          []string `json:"env" yaml:"env"`
}

type Tunnel

type Tunnel struct{}

func (*Tunnel) Name

func (*Tunnel) Name() string

func (*Tunnel) NewClient

func (*Tunnel) NewClient(ctx context.Context, client tunnel.Client) (tunnel.Client, error)

func (*Tunnel) NewServer

func (*Tunnel) NewServer(ctx context.Context, server tunnel.Server) (tunnel.Server, error)