client

Documentation

Index

• Variables
• func AddPluginOption(opPlugin OptionPlugin) error
• func AddPluginRequest(redirect RequestPlugin) error
• func AddPluginVersion(verPlugin VersionPlugin) error
• func NewHttpClient() (*http.Client, *http.Transport)
• type Handles
  • func NewClientHandles() *Handles
  • func (hdl *Handles) CliWait(once *sync.Once)
  • func (hdl *Handles) CreateServerConn(c *Options, ctx context.Context) (*wss.WebSocketClient, error)
  • func (hdl *Handles) NegotiateVersion(ctx context.Context, remoteUrl string) error
  • func (hdl *Handles) NotifyClose(once *sync.Once, wait bool)
  • func (hdl *Handles) StartClient(c *Options, once *sync.Once)
  • func (hdl *Handles) Wait() error
• type OptionPlugin
• type Options
• type Plugins
  • func (plugin *Plugins) HasOptionPlugin() bool
  • func (plugin *Plugins) HasRequestPlugin() bool
  • func (plugin *Plugins) HasVersionPlugin() bool
• type RequestPlugin
• type VersionPlugin

Variables

var ErrPluginOccupied = errors.New("the plugin is occupied by another plugin")

Functions

func AddPluginOption

func AddPluginOption(opPlugin OptionPlugin) error

add an option plugin

func AddPluginRequest

func AddPluginRequest(redirect RequestPlugin) error

add a request plugin

func AddPluginVersion

func AddPluginVersion(verPlugin VersionPlugin) error

add a version plugin

func NewHttpClient

func NewHttpClient() (*http.Client, *http.Transport)

Types

type Handles

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

func NewClientHandles

func NewClientHandles() *Handles

func (*Handles) CliWait

func (hdl *Handles) CliWait(once *sync.Once)

CliWait can be used in cli env to wait service to finish. similar to Wait, but CliWait is usually used in cli.

func (*Handles) CreateServerConn

func (hdl *Handles) CreateServerConn(c *Options, ctx context.Context) (*wss.WebSocketClient, error)

CreateServerConn create a server websocket connection based on user options.

func (*Handles) NegotiateVersion

func (hdl *Handles) NegotiateVersion(ctx context.Context, remoteUrl string) error

func (*Handles) NotifyClose

func (hdl *Handles) NotifyClose(once *sync.Once, wait bool)

NotifyClose send closing message to all running tasks

func (*Handles) StartClient

func (hdl *Handles) StartClient(c *Options, once *sync.Once)

func (*Handles) Wait

func (hdl *Handles) Wait() error

Wait waits an error in client connection. If the connection lost or any other connection error happens, Wait will return an error.

type OptionPlugin

type OptionPlugin interface {
	OnOptionSet(options Options) error
}

pass read-only connection option to OnOptionSet when options are set. we can check connection options by returning an error and may set RemoteUrl here.

type Options

type Options struct {
	LocalSocks5Addr string      // local listening address
	HttpEnabled     bool        // enable http and https proxy
	LocalHttpAddr   string      // listen address of http and https(if it is enabled)
	RemoteUrl       *url.URL    // url of server
	RemoteHeaders   http.Header // parsed websocket headers (not presented in flag).
	ConnectionKey   string      // connection key for authentication
	SkipTLSVerify   bool        // skip TSL verify
}

type Plugins

type Plugins struct {
	OptionPlugin  OptionPlugin
	RequestPlugin RequestPlugin
	VersionPlugin VersionPlugin
}

Plugins is a collection of all possible plugins on client

func (*Plugins) HasOptionPlugin

func (plugin *Plugins) HasOptionPlugin() bool

check whether the option plugin has been added. this plugin can only be at most one instance.

func (*Plugins) HasRequestPlugin

func (plugin *Plugins) HasRequestPlugin() bool

check whether the request plugin has been added. this plugin can only be at most one instance.

func (*Plugins) HasVersionPlugin

func (plugin *Plugins) HasVersionPlugin() bool

type RequestPlugin

type RequestPlugin interface {
	BeforeRequest(hc *http.Client, transport *http.Transport, url *url.URL, header *http.Header) error
}

in the plugin, we may add http header and modify remote address.

type VersionPlugin

type VersionPlugin interface {
	OnServerVersion(ver wss.VersionNeg) error
}