client

Documentation

Index

• Constants
• func AddPluginRedirect(redirect ServerRedirect)
• func AddPluginVersion(verPlugin VersionPlugin)
• type Handles
• type Plugin
  • func (plugin *Plugin) HasRedirectPlugin() bool
  • func (plugin *Plugin) HasVersionPlugin() bool
• type ServerRedirect
• type VersionPlugin

Constants

const CommandNameClient = "client"

Functions

func AddPluginRedirect

func AddPluginRedirect(redirect ServerRedirect)

add a client plugin

func AddPluginVersion

func AddPluginVersion(verPlugin VersionPlugin)

Types

type Handles

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

type Plugin

type Plugin struct {
	RedirectPlugin ServerRedirect
	VersionPlugin  VersionPlugin
}

func (*Plugin) HasRedirectPlugin

func (plugin *Plugin) HasRedirectPlugin() bool

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

func (*Plugin) HasVersionPlugin

func (plugin *Plugin) HasVersionPlugin() bool

type ServerRedirect

type ServerRedirect interface {
	// in the plugin, we may add http header and modify remote address.
	BeforeRequest(dialer *websocket.Dialer, url *url.URL, header http.Header) error
}

type VersionPlugin

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