websocket

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 InboundConn
  • func (c *InboundConn) Close() error
• type OutboundConn
  • func (c *OutboundConn) Metadata() *tunnel.Metadata
  • func (c *OutboundConn) RemoteAddr() net.Addr
• 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, underlay tunnel.Client) (tunnel.Client, error)
  • func (*Tunnel) NewServer(ctx context.Context, underlay tunnel.Server) (tunnel.Server, error)
• type WebsocketConfig

Constants

const Name = "WEBSOCKET"

Types

type Client

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

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 {
	RemoteHost string          `json:"remote_addr" yaml:"remote-addr"`
	RemotePort int             `json:"remote_port" yaml:"remote-port"`
	Websocket  WebsocketConfig `json:"websocket" yaml:"websocket"`
}

type InboundConn

type InboundConn struct {
	OutboundConn
	// contains filtered or unexported fields
}

func (*InboundConn) Close

func (c *InboundConn) Close() error

type OutboundConn

type OutboundConn struct {
	*websocket.Conn
	// contains filtered or unexported fields
}

func (*OutboundConn) Metadata

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

func (*OutboundConn) RemoteAddr

func (c *OutboundConn) RemoteAddr() net.Addr

type Server

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

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, underlay tunnel.Client) (tunnel.Client, error)

func (*Tunnel) NewServer

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

type WebsocketConfig

type WebsocketConfig struct {
	Enabled bool   `json:"enabled" yaml:"enabled"`
	Host    string `json:"host" yaml:"host"`
	Path    string `json:"path" yaml:"path"`
}