mux

Documentation

Index

• Constants
• type Client
  • func NewClient(ctx context.Context, underlay 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) Close() error
  • func (c *Conn) Read(p []byte) (int, error)
  • func (c *Conn) Write(p []byte) (int, error)
• type MuxConfig
• type Server
  • func NewServer(ctx context.Context, underlay tunnel.Server) (*Server, error)
  • func (s *Server) AcceptConn(tunnel.Tunnel) (tunnel.Conn, error)
  • func (s *Server) AcceptPacket(tunnel.Tunnel) (tunnel.PacketConn, error)
  • func (s *Server) Close() error
• 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 = "MUX"

Types

type Client

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

Client is a smux client

func NewClient

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

func (*Client) Close

func (c *Client) Close() error

func (*Client) DialConn

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

func (*Client) DialPacket

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

type Config

type Config struct {
	Mux MuxConfig `json:"mux" yaml:"mux"`
}

type Conn

type Conn struct {
	tunnel.Conn
	// contains filtered or unexported fields
}

func (*Conn) Close

func (c *Conn) Close() error

func (*Conn) Read

func (c *Conn) Read(p []byte) (int, error)

func (*Conn) Write

func (c *Conn) Write(p []byte) (int, error)

type MuxConfig

type MuxConfig struct {
	Enabled     bool `json:"enabled" yaml:"enabled"`
	IdleTimeout int  `json:"idle_timeout" yaml:"idle-timeout"`
	Concurrency int  `json:"concurrency" yaml:"concurrency"`
}

type Server

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

Server is a smux server

func NewServer

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

func (*Server) AcceptConn

func (s *Server) AcceptConn(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 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)