quickws

May 21, 2024

Changes in this version

+ var ErrUnexpectedFlateStream = errors.New("quickws: internal error, unexpected bytes at end of flate stream")

type ClientOption

+ func WithClientContextTakeover() ClientOption

+ func WithClientMaxWindowsBits(bits uint8) ClientOption

+ func WithClientReadMaxMessage(size int64) ClientOption

type ServerOption

+ func WithServerContextTakeover() ServerOption

+ func WithServerMaxWindowBits(bits uint8) ServerOption

+ func WithServerReadMaxMessage(size int64) ServerOption

type StatusCode

+ func (s StatusCode) Error() string

Dec 15, 2023

Changes in this version

+ var ErrDialFuncAndProxyFunc = errors.New("dialFunc and proxyFunc can't be set at the same time")

type ClientOption

+ func WithClientProxyFunc(proxyFunc func(*http.Request) (*url.URL, error)) ClientOption

+ func WithClientSubprotocols(subprotocols []string) ClientOption

Dec 12, 2023

Changes in this version

type ClientOption

+ func WithClientDialFunc(dialFunc func() (Dialer, error)) ClientOption

+ type Dialer interface

+ Dial func(network, addr string) (c net.Conn, err error)

Sep 5, 2023

Changes in this version

type Conn

+ func (c *Conn) NetConn() net.Conn

type ServerOption

+ func WithServerSubprotocols(subprotocols []string) ServerOption

Sep 2, 2023

Changes in this version

type ClientOption

+ func WithClientBindHTTPHeader(h *http.Header) ClientOption

Aug 24, 2023

Changes in this version

type ClientOption

+ func WithClientCallbackFunc(open OnOpenFunc, m OnMessageFunc, c OnCloseFunc) ClientOption

+ func WithClientDelayWriteInitBufferSize(n int32) ClientOption

+ func WithClientMaxDelayWriteDuration(d time.Duration) ClientOption

+ func WithClientMaxDelayWriteNum(n int32) ClientOption

+ func WithClientOnCloseFunc(onClose func(c *Conn, err error)) ClientOption

+ func WithClientReadTimeout(t time.Duration) ClientOption

type Conn

+ func (c *Conn) SetWriteDeadline(t time.Time) error

+ type OnCloseFunc func(*Conn, error)

+ func (o OnCloseFunc) OnClose(c *Conn, err error)

+ func (o OnCloseFunc) OnMessage(_ *Conn, _ Opcode, _ []byte)

+ func (o OnCloseFunc) OnOpen(_ *Conn)

+ type OnOpenFunc func(*Conn)

type ServerOption

+ func WithServerCallbackFunc(open OnOpenFunc, m OnMessageFunc, c OnCloseFunc) ServerOption

+ func WithServerOnCloseFunc(onClose func(c *Conn, err error)) ServerOption

Aug 6, 2023

Changes in this version

+ var ErrClosed = errors.New("closed")

type Conn

+ func (c *Conn) WriteMessageDelay(op Opcode, writeBuf []byte) (err error)

type ServerOption

+ func WithServerDelayWriteInitBufferSize(n int32) ServerOption

+ func WithServerMaxDelayWriteDuration(d time.Duration) ServerOption

+ func WithServerMaxDelayWriteNum(n int32) ServerOption

Aug 5, 2023

Changes in this version

type ClientOption

+ func WithClientBufioMultipleTimesPayloadSize(mt float32) ClientOption

type ServerOption

+ func WithServerBufioMultipleTimesPayloadSize(mt float32) ServerOption

Aug 2, 2023

Changes in this version

type ClientOption

+ func WithClientBufioParseMode() ClientOption

+ func WithClientDisableBufioClearHack() ClientOption

+ func WithClientEnableUTF8Check() ClientOption

+ func WithClientIgnorePong() ClientOption

+ func WithClientWindowsMultipleTimesPayloadSize(mt float32) ClientOption

+ func WithClientWindowsParseMode() ClientOption

type Config

+ func ClientOptionToConf(opts ...ClientOption) *Config

type Conn

+ func DialConf(rawUrl string, conf *Config) (*Conn, error)

+ func (c *Conn) WriteControl(op Opcode, data []byte) (err error)

+ func (c *Conn) WritePing(data []byte) (err error)

+ func (c *Conn) WritePong(data []byte) (err error)

type ServerOption

+ func WithServerBufioParseMode() ServerOption

+ func WithServerDisableBufioClearHack() ServerOption

+ func WithServerEnableUTF8Check() ServerOption

+ func WithServerWindowsMultipleTimesPayloadSize(mt float32) ServerOption

+ func WithServerWindowsParseMode() ServerOption

Jul 22, 2023

Changes in this version

+ const Binary

+ const Close

+ const Continuation

+ const ParseModeBufio

+ const ParseModeWindows

+ const Ping

+ const Pong

+ const Text

+ var ErrClose = "websocket"

+ var ErrClosePayloadTooSmall = errors.New("error:close payload too small")

+ var ErrCloseValue = errors.New("error:close value is wrong")

+ var ErrConnectionFieldValue = errors.New("The value of the connection field is not 'upgrade'")

+ var ErrEmptyClose = errors.New("error:close value is empty")

+ var ErrFrameOpcode = errors.New("error:since all data frames after the initial data frame must have opcode 0.")

+ var ErrHTTPProtocolNotSupported = errors.New("HTTP protocol not supported")

+ var ErrHostCannotBeEmpty = errors.New("Host cannot be empty")

+ var ErrMaxControlFrameSize = errors.New("error:max control frame size > 125")

+ var ErrNOTBeFragmented = errors.New("error:since control message MUST NOT be fragmented")

+ var ErrNotFoundHijacker = errors.New("not found Hijacker")

+ var ErrOnlyGETSupported = errors.New("error:Only get methods are supported")

+ var ErrOpcode = errors.New("error:wrong opcode")

+ var ErrRsv123 = errors.New("error:rsv1 or rsv2 or rsv3 has a value")

+ var ErrSecWebSocketAccept = errors.New("The value of Sec-WebSocketAaccept field is invalid")

+ var ErrSecWebSocketKey = errors.New("The value of SEC websocket key field is wrong")

+ var ErrSecWebSocketVersion = errors.New("The value of SEC websocket version field is wrong, not 13")

+ var ErrTextNotUTF8 = errors.New("error:text is not utf8 data")

+ var ErrUpgradeFieldValue = errors.New("The value of the upgrade field is not 'websocket'")

+ var ErrWriteClosed = errors.New("write close")

+ var ErrWrongStatusCode = errors.New("Wrong status code")

+ func GetNoPortExists() string

+ func StringToBytes(s string) (b []byte)

+ type Callback interface

+ OnClose func(*Conn, error)

+ OnMessage func(*Conn, Opcode, []byte)

+ OnOpen func(*Conn)

+ type ClientOption func(*DialOption)

+ func WithClientCallback(cb Callback) ClientOption

+ func WithClientCompression() ClientOption

+ func WithClientDecompressAndCompress() ClientOption

+ func WithClientDecompression() ClientOption

+ func WithClientDialTimeout(t time.Duration) ClientOption

+ func WithClientHTTPHeader(h http.Header) ClientOption

+ func WithClientOnMessageFunc(cb OnMessageFunc) ClientOption

+ func WithClientReplyPing() ClientOption

+ func WithClientTCPDelay() ClientOption

+ func WithClientTLSConfig(tls *tls.Config) ClientOption

+ func WithServerOnMessageFunc(cb func(*Conn, Opcode, []byte)) ClientOption

+ type CloseErrMsg struct

+ Code StatusCode

+ Msg string

+ func (c CloseErrMsg) Error() string

+ type Config struct

+ func ClientOpt(opts ...ClientOption) *Config

+ type Conn struct

+ func Dial(rawUrl string, opts ...ClientOption) (*Conn, error)

+ func DialWithConfig(rawUrl string, conf *Config) (*Conn, error)

+ func Upgrade(w http.ResponseWriter, r *http.Request, opts ...ServerOption) (c *Conn, err error)

+ func (c *Conn) Close() (err error)

+ func (c *Conn) ReadLoop() error

+ func (c *Conn) SetDeadline(t time.Time) error

+ func (c *Conn) StartReadLoop()

+ func (c *Conn) WriteCloseTimeout(sc StatusCode, t time.Duration) (err error)

+ func (c *Conn) WriteMessage(op Opcode, writeBuf []byte) (err error)

+ func (c *Conn) WriteMessageUnsafe(op Opcode, writeBuf []byte) (err error)

+ func (c *Conn) WriteTimeout(op Opcode, data []byte, t time.Duration) (err error)

+ type ConnOption struct

+ type DefCallback struct

+ func (defcallback *DefCallback) OnClose(_ *Conn, _ error)

+ func (defcallback *DefCallback) OnMessage(_ *Conn, _ Opcode, _ []byte)

+ func (defcallback *DefCallback) OnOpen(_ *Conn)

+ type DialOption struct

+ Header http.Header

+ func (d *DialOption) Dial() (c *Conn, err error)

+ type OnMessageFunc func(*Conn, Opcode, []byte)

+ func (o OnMessageFunc) OnClose(_ *Conn, _ error)

+ func (o OnMessageFunc) OnMessage(c *Conn, op Opcode, data []byte)

+ func (o OnMessageFunc) OnOpen(_ *Conn)

+ type Opcode = opcode.Opcode

+ type ServerOption func(*ConnOption)

+ func WithBufioParseMode() ServerOption

+ func WithServerCallback(cb Callback) ServerOption

+ func WithServerDecompressAndCompress() ServerOption

+ func WithServerDecompression() ServerOption

+ func WithServerDisableUTF8Check() ServerOption

+ func WithServerIgnorePong() ServerOption

+ func WithServerReadTimeout(t time.Duration) ServerOption

+ func WithServerReplyPing() ServerOption

+ func WithServerTCPDelay() ServerOption

+ func WithWindowsMultipleTimesPayloadSize(mt float32) ServerOption

+ func WithWindowsParseMode() ServerOption

+ type StatusCode int16

+ const DataCannotAccept

+ const EndpointGoingAway

+ const NoExtensions

+ const NormalClosure

+ const NotConsistentMessageType

+ const ProtocolError

+ const ServerTerminating

+ const TerminatingConnection

+ const TooBigMessage

+ func (s StatusCode) String() string

+ type UpgradeServer struct

+ func NewUpgrade(opts ...ServerOption) *UpgradeServer

+ func (u *UpgradeServer) Upgrade(w http.ResponseWriter, r *http.Request) (c *Conn, err error)