package
1.4.0
Repository: https://github.com/gobwas/ws.git
Documentation: pkg.go.dev

# Functions

CompressFrame is a shortcut for DefaultHelper.CompressFrame().
CompressFrameBuffer is a shortcut for DefaultHelper.CompressFrameBuffer().
DecompressFrame is a shortcut for DefaultHelper.DecompressFrame().
DecompressFrameBuffer is a shortcut for DefaultHelper.DecompressFrameBuffer().
IsCompressed reports whether the Per-Message Compression bit is set in header h.
NewReader returns a new Reader.
NewWriter returns a new Writer.
SetBit sets the Per-Message Compression bit in header h and returns its modified copy.
UnsetBit clears the Per-Message Compression bit in header h and returns its modified copy.

# Constants

No description provided by the author
2^15.

# Variables

DefaultHelper is a default helper instance holding standard library's `compress/flate` compressor and decompressor under the hood.
DefaultParameters holds deflate extension parameters which are assumed by DefaultHelper to be used during WebSocket handshake.
No description provided by the author
No description provided by the author

# Structs

Extension contains logic of compression extension parameters negotiation made during HTTP WebSocket handshake.
Helper is a helper struct that holds common code for compression and decompression bytes or WebSocket frames.
MessageState holds message compression state.
Parameters contains compression extension options.
Reader implements decompression from an io.Reader object using Decompressor.
Writer implements compression for an io.Writer object using Compressor.

# Interfaces

Buffer is an interface representing some bytes buffering object.
Compressor is an interface holding deflate compression implementation.
Decompressor is an interface holding deflate decompression implementation.
ReadResetter is an optional interface that Decompressor can implement.
WriteResetter is an optional interface that Compressor can implement.

# Type aliases

WindowBits specifies window size accordingly to RFC.