ws

package module

Go to main page

Versions in this module

v1

v1.5.0-rc.2

Nov 3, 2026

v1.5.0-rc.1

Nov 2, 2026

v1.4.1-rc.1

Oct 29, 2026

v1.4.0

May 3, 2024

v1.3.2

Jan 8, 2024

Changes in this version

type Dialer

+ Host string

v1.3.1

Oct 30, 2023

v1.3.0

Aug 9, 2023

v1.2.1

May 18, 2023

v1.2.0

Apr 10, 2023

v1.1.0

Jul 11, 2021

Changes in this version

+ func RsvBits(rsv byte) (r1, r2, r3 bool)

+ type ConnectionRejectedError struct

+ func (r *ConnectionRejectedError) Error() string

+ func (r *ConnectionRejectedError) StatusCode() int

type Frame

+ func UnmaskFrame(f Frame) Frame

+ func UnmaskFrameInPlace(f Frame) Frame

type HTTPUpgrader

+ Negotiate func(httphead.Option) (httphead.Option, error)

type Upgrader

+ Negotiate func(httphead.Option) (httphead.Option, error)

v1.1.0-rc.6

Jul 10, 2021

v1.1.0-rc.5

Feb 10, 2021

v1.1.0-rc.4

Feb 6, 2021

v1.1.0-rc.3

Feb 5, 2021

v1.1.0-rc.2

Jan 25, 2021

v1.1.0-rc.1

Dec 8, 2020

v1.0.4

Sep 7, 2020

v1.0.3

Mar 3, 2020

v1.0.2

Jun 13, 2019

v1.0.1

Apr 27, 2019

v1.0.0

Aug 5, 2018

Changes in this version

+ var CompiledCloseGoingAway = MustCompileFrame(closeFrameGoingAway)

+ var CompiledCloseInternalServerError = MustCompileFrame(closeFrameInternalServerError)

+ var CompiledCloseInvalidFramePayloadData = MustCompileFrame(closeFrameInvalidFramePayloadData)

+ var CompiledCloseMandatoryExt = MustCompileFrame(closeFrameMandatoryExt)

+ var CompiledCloseMessageTooBig = MustCompileFrame(closeFrameMessageTooBig)

+ var CompiledCloseNoMeaningYet = MustCompileFrame(closeFrameNoMeaningYet)

+ var CompiledCloseNormalClosure = MustCompileFrame(closeFrameNormalClosure)

+ var CompiledClosePolicyViolation = MustCompileFrame(closeFramePolicyViolation)

+ var CompiledCloseProtocolError = MustCompileFrame(closeFrameProtocolError)

+ var CompiledCloseTLSHandshake = MustCompileFrame(closeFrameTLSHandshake)

+ var CompiledCloseUnsupportedData = MustCompileFrame(closeFrameUnsupportedData)

+ var ErrHandshakeUpgradeRequired = RejectConnectionError(RejectionStatus(http.StatusUpgradeRequired), ...)

+ func MustWriteFrame(w io.Writer, f Frame)

+ func NewCloseFrameBody(code StatusCode, reason string) []byte

+ func PutCloseFrameBody(p []byte, code StatusCode, reason string)

+ func RejectConnectionError(options ...RejectOption) error

type Frame

+ func MustReadFrame(r io.Reader) Frame

type HTTPUpgrader

+ Header http.Header

+ type HandshakeHeader interface

+ type HandshakeHeaderBytes []byte

+ func (b HandshakeHeaderBytes) WriteTo(w io.Writer) (int64, error)

+ type HandshakeHeaderFunc func(io.Writer) (int64, error)

+ func (f HandshakeHeaderFunc) WriteTo(w io.Writer) (int64, error)

+ type HandshakeHeaderHTTP http.Header

+ func (h HandshakeHeaderHTTP) WriteTo(w io.Writer) (int64, error)

+ type HandshakeHeaderString string

+ func (s HandshakeHeaderString) WriteTo(w io.Writer) (int64, error)

+ type RejectOption func(*rejectConnectionError)

+ func RejectionHeader(h HandshakeHeader) RejectOption

+ func RejectionReason(reason string) RejectOption

+ func RejectionStatus(code int) RejectOption

type State

+ func (s State) ClientSide() bool

+ func (s State) Extended() bool

+ func (s State) Fragmented() bool

+ func (s State) ServerSide() bool

type Upgrader

+ OnHost func(host []byte) error

v0

v0.1.0

May 5, 2018

Changes in this version

+ const DefaultClientReadBufferSize

+ const DefaultClientWriteBufferSize

+ const DefaultServerReadBufferSize

+ const DefaultServerWriteBufferSize

+ const MaxControlFramePayloadSize

+ const MaxHeaderSize

+ const MinHeaderSize

+ var CloseFrame = Frame

+ var CompiledClose = MustCompileFrame(CloseFrame)

+ var CompiledPing = MustCompileFrame(PingFrame)

+ var CompiledPong = MustCompileFrame(PongFrame)

+ var ErrHandshakeBadConnection = fmt.Errorf("handshake error: bad %q header", headerConnection)

+ var ErrHandshakeBadExtensions = fmt.Errorf("unexpected extensions in %q header", headerSecProtocol)

+ var ErrHandshakeBadHost = fmt.Errorf("handshake error: bad %q header", headerHost)

+ var ErrHandshakeBadMethod = fmt.Errorf("handshake error: bad HTTP request method")

+ var ErrHandshakeBadProtocol = fmt.Errorf("handshake error: bad HTTP protocol version")

+ var ErrHandshakeBadSecAccept = fmt.Errorf("handshake error: bad %q header", headerSecAccept)

+ var ErrHandshakeBadSecKey = fmt.Errorf("handshake error: bad %q header", headerSecKey)

+ var ErrHandshakeBadSecVersion = fmt.Errorf("handshake error: bad %q header", headerSecVersion)

+ var ErrHandshakeBadStatus = fmt.Errorf("unexpected http status")

+ var ErrHandshakeBadSubProtocol = fmt.Errorf("unexpected protocol in %q header", headerSecProtocol)

+ var ErrHandshakeBadUpgrade = fmt.Errorf("handshake error: bad %q header", headerUpgrade)

+ var ErrHeaderLengthMSB = fmt.Errorf("header error: the most significant bit must be 0")

+ var ErrHeaderLengthUnexpected = fmt.Errorf("header error: unexpected payload length bits")

+ var ErrMalformedRequest = fmt.Errorf("malformed HTTP request")

+ var ErrMalformedResponse = fmt.Errorf("malformed HTTP response")

+ var ErrNotHijacker = fmt.Errorf("given http.ResponseWriter is not a http.Hijacker")

+ var ErrProtocolContinuationExpected = ProtocolError("unexpected non-continuation data frame")

+ var ErrProtocolContinuationUnexpected = ProtocolError("unexpected continuation data frame")

+ var ErrProtocolControlNotFinal = ProtocolError("control frame is not final")

+ var ErrProtocolControlPayloadOverflow = ProtocolError("control frame payload limit exceeded")

+ var ErrProtocolInvalidUTF8 = ProtocolError("invalid utf8 sequence in close reason")

+ var ErrProtocolMaskRequired = ProtocolError("frames from client to server must be masked")

+ var ErrProtocolMaskUnexpected = ProtocolError("frames from server to client must be not masked")

+ var ErrProtocolNonZeroRsv = ProtocolError("non-zero rsv bits with no extension negotiated")

+ var ErrProtocolOpCodeReserved = ProtocolError("use of reserved op code")

+ var ErrProtocolStatusCodeApplicationLevel = ProtocolError("status code is only application level")

+ var ErrProtocolStatusCodeNoMeaning = ProtocolError("status code has no meaning yet")

+ var ErrProtocolStatusCodeNotInUse = ProtocolError("status code is not in use")

+ var ErrProtocolStatusCodeUnknown = ProtocolError("status code is not defined in spec")

+ var PingFrame = Frame

+ var PongFrame = Frame

+ var StatusRangeApplication = StatusCodeRange

+ var StatusRangeNotInUse = StatusCodeRange

+ var StatusRangePrivate = StatusCodeRange

+ var StatusRangeProtocol = StatusCodeRange

+ func CheckCloseFrameData(code StatusCode, reason string) error

+ func CheckHeader(h Header, s State) error

+ func Cipher(payload []byte, mask [4]byte, offset int)

+ func CompileFrame(f Frame) (bts []byte, err error)

+ func HeaderSize(h Header) (n int)

+ func HeaderWriter(h http.Header) func(io.Writer)

+ func MustCompileFrame(f Frame) []byte

+ func NewCloseFrameData(code StatusCode, reason string) []byte

+ func NewMask() (ret [4]byte)

+ func PutCloseFrameData(p []byte, code StatusCode, reason string) int

+ func PutReader(br *bufio.Reader)

+ func Rsv(r1, r2, r3 bool) (rsv byte)

+ func SelectEqual(v string) func(string) bool

+ func SelectFromSlice(accept []string) func(string) bool

+ func WriteFrame(w io.Writer, f Frame) error

+ func WriteHeader(w io.Writer, h Header) error

+ type Dialer struct

+ Extensions []httphead.Option

+ Header func(io.Writer)

+ NetDial func(ctx context.Context, network, addr string) (net.Conn, error)

+ OnHeader func(key, value []byte) (err error)

+ OnStatusError func(status int, reason []byte, resp io.Reader)

+ Protocols []string

+ ReadBufferSize int

+ TLSClient func(conn net.Conn, hostname string) net.Conn

+ TLSConfig *tls.Config

+ Timeout time.Duration

+ WrapConn func(conn net.Conn) net.Conn

+ WriteBufferSize int

+ var DefaultDialer Dialer

+ func (d Dialer) Dial(ctx context.Context, urlstr string) (conn net.Conn, br *bufio.Reader, hs Handshake, err error)

+ func (d Dialer) Upgrade(conn io.ReadWriter, u *url.URL) (br *bufio.Reader, hs Handshake, err error)

+ type Frame struct

+ Header Header

+ Payload []byte

+ func MaskFrame(f Frame) Frame

+ func MaskFrameInPlace(f Frame) Frame

+ func MaskFrameInPlaceWith(f Frame, m [4]byte) Frame

+ func MaskFrameWith(f Frame, mask [4]byte) Frame

+ func NewBinaryFrame(p []byte) Frame

+ func NewCloseFrame(code StatusCode, reason string) Frame

+ func NewFrame(op OpCode, fin bool, p []byte) Frame

+ func NewPingFrame(p []byte) Frame

+ func NewPongFrame(p []byte) Frame

+ func NewTextFrame(s string) Frame

+ func ReadFrame(r io.Reader) (f Frame, err error)

+ type HTTPUpgrader struct

+ Extension func(httphead.Option) bool

+ Protocol func(string) bool

+ Timeout time.Duration

+ var DefaultHTTPUpgrader HTTPUpgrader

+ func (u HTTPUpgrader) Upgrade(r *http.Request, w http.ResponseWriter, h http.Header) (conn net.Conn, rw *bufio.ReadWriter, hs Handshake, err error)

+ type Handshake struct

+ Extensions []httphead.Option

+ Protocol string

+ func Dial(ctx context.Context, urlstr string) (net.Conn, *bufio.Reader, Handshake, error)

+ func Upgrade(conn io.ReadWriter) (Handshake, error)

+ func UpgradeHTTP(r *http.Request, w http.ResponseWriter, h http.Header) (conn net.Conn, rw *bufio.ReadWriter, hs Handshake, err error)

+ type Header struct

+ Fin bool

+ Length int64

+ Mask [4]byte

+ Masked bool

+ OpCode OpCode

+ Rsv byte

+ func ReadHeader(r io.Reader) (h Header, err error)

+ func (h Header) Rsv1() bool

+ func (h Header) Rsv2() bool

+ func (h Header) Rsv3() bool

+ type OpCode byte

+ const OpBinary

+ const OpClose

+ const OpContinuation

+ const OpPing

+ const OpPong

+ const OpText

+ func (c OpCode) IsControl() bool

+ func (c OpCode) IsData() bool

+ func (c OpCode) IsReserved() bool

+ type ProtocolError string

+ func (p ProtocolError) Error() string

+ type State uint8

+ const StateClientSide

+ const StateExtended

+ const StateFragmented

+ const StateServerSide

+ func (s State) Clear(v State) State

+ func (s State) Is(v State) bool

+ func (s State) Set(v State) State

+ func (s State) SetOrClearIf(cond bool, v State) (ret State)

+ type StatusCode uint16

+ const StatusAbnormalClosure

+ const StatusGoingAway

+ const StatusInternalServerError

+ const StatusInvalidFramePayloadData

+ const StatusMandatoryExt

+ const StatusMessageTooBig

+ const StatusNoMeaningYet

+ const StatusNoStatusRcvd

+ const StatusNormalClosure

+ const StatusPolicyViolation

+ const StatusProtocolError

+ const StatusTLSHandshake

+ const StatusUnsupportedData

+ func ParseCloseFrameData(payload []byte) (code StatusCode, reason string)

+ func ParseCloseFrameDataUnsafe(payload []byte) (code StatusCode, reason string)

+ func (s StatusCode) Empty() bool

+ func (s StatusCode) In(r StatusCodeRange) bool

+ func (s StatusCode) IsApplicationSpec() bool

+ func (s StatusCode) IsNotUsed() bool

+ func (s StatusCode) IsPrivateSpec() bool

+ func (s StatusCode) IsProtocolDefined() bool

+ func (s StatusCode) IsProtocolReserved() bool

+ func (s StatusCode) IsProtocolSpec() bool

+ type StatusCodeRange struct

+ Max StatusCode

+ Min StatusCode

+ type StatusError int

+ func (s StatusError) Error() string

+ type Upgrader struct

+ Extension func(httphead.Option) bool

+ ExtensionCustom func([]byte, []httphead.Option) ([]httphead.Option, bool)

+ Header func(io.Writer)

+ OnBeforeUpgrade func() (header func(io.Writer), err error, code int)

+ OnHeader func(key, value []byte) (err error, code int)

+ OnRequest func(host, uri []byte) (err error, code int)

+ Protocol func([]byte) bool

+ ProtocolCustom func([]byte) (string, bool)

+ ReadBufferSize int

+ WriteBufferSize int

+ var DefaultUpgrader Upgrader

+ func (u Upgrader) Upgrade(conn io.ReadWriter) (hs Handshake, err error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL