websocket

Documentation

Overview

Package websocket implements Websocket transport

Websocket transport implements an HTTP(S) compliable, surveillance proof transport method with plausible deniability.

Index

• Variables
• func Dial(ctx context.Context, dest net.Destination, ...) (internet.Connection, error)
• func ListenWS(ctx context.Context, address net.Address, port net.Port, ...) (internet.Listener, error)
• type Config
  • func (*Config) Descriptor() ([]byte, []int)
  • func (x *Config) GetAcceptProxyProtocol() bool
  • func (x *Config) GetHeader() []*Header
  • func (c *Config) GetNormalizedPath() string
  • func (x *Config) GetPath() string
  • func (c *Config) GetRequestHeader() http.Header
  • func (*Config) ProtoMessage()
  • func (x *Config) ProtoReflect() protoreflect.Message
  • func (x *Config) Reset()
  • func (x *Config) String() string
• type Header
  • func (*Header) Descriptor() ([]byte, []int)
  • func (x *Header) GetKey() string
  • func (x *Header) GetValue() string
  • func (*Header) ProtoMessage()
  • func (x *Header) ProtoReflect() protoreflect.Message
  • func (x *Header) Reset()
  • func (x *Header) String() string
• type Listener
  • func (ln *Listener) Addr() net.Addr
  • func (ln *Listener) Close() error

Variables

var File_transport_internet_websocket_config_proto protoreflect.FileDescriptor

Functions

func Dial

func Dial(ctx context.Context, dest net.Destination, streamSettings *internet.MemoryStreamConfig) (internet.Connection, error)

Dial dials a WebSocket connection to the given destination.

func ListenWS

func ListenWS(ctx context.Context, address net.Address, port net.Port, streamSettings *internet.MemoryStreamConfig, addConn internet.ConnHandler) (internet.Listener, error)

Types

type Config

type Config struct {

	// URL path to the WebSocket service. Empty value means root(/).
	Path                string    `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	Header              []*Header `protobuf:"bytes,3,rep,name=header,proto3" json:"header,omitempty"`
	AcceptProxyProtocol bool      `protobuf:"varint,4,opt,name=accept_proxy_protocol,json=acceptProxyProtocol,proto3" json:"accept_proxy_protocol,omitempty"`
	// contains filtered or unexported fields
}

func (*Config) Descriptor

func (*Config) Descriptor() ([]byte, []int)

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetAcceptProxyProtocol

func (x *Config) GetAcceptProxyProtocol() bool

func (*Config) GetHeader

func (x *Config) GetHeader() []*Header

func (*Config) GetNormalizedPath

func (c *Config) GetNormalizedPath() string

func (*Config) GetPath

func (x *Config) GetPath() string

func (*Config) GetRequestHeader

func (c *Config) GetRequestHeader() http.Header

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) ProtoReflect

func (x *Config) ProtoReflect() protoreflect.Message

func (*Config) Reset

func (x *Config) Reset()

func (*Config) String

func (x *Config) String() string

type Header

type Header struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*Header) Descriptor

func (*Header) Descriptor() ([]byte, []int)

Deprecated: Use Header.ProtoReflect.Descriptor instead.

func (*Header) GetKey

func (x *Header) GetKey() string

func (*Header) GetValue

func (x *Header) GetValue() string

func (*Header) ProtoMessage

func (*Header) ProtoMessage()

func (*Header) ProtoReflect

func (x *Header) ProtoReflect() protoreflect.Message

func (*Header) Reset

func (x *Header) Reset()

func (*Header) String

func (x *Header) String() string

type Listener

type Listener struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*Listener) Addr

func (ln *Listener) Addr() net.Addr

Addr implements net.Listener.Addr().

func (*Listener) Close

func (ln *Listener) Close() error

Close implements net.Listener.Close().