The CompressionOptions class allows you to control the options of WebSocket compression.

Constants

DEFAULT CompressionOptions

Default WebSocket Compression options. Compression will be enabled with the following options: clientNoContextTakeover: false serverNoContextTakeover: false clientMaxWindowBits: 15 serverMaxWindowBits: 15

OFF CompressionOptions

Disables WebSocket Compression.

const CompressionOptions(enabled: false)

Constructors

CompressionOptions({bool clientNoContextTakeover: false, bool serverNoContextTakeover: false, int clientMaxWindowBits, int serverMaxWindowBits, bool enabled: true})

const

Properties

clientMaxWindowBits int

Sets the Max Window Bits for the Client.

read-only
clientNoContextTakeover bool

Control whether the client will reuse it's compression instances.

read-only
enabled bool

Enables or disables WebSocket compression.

read-only
hashCode int

Get a hash code for this object.

read-only, inherited
runtimeType Type

A representation of the runtime type of the object.

read-only, inherited
serverMaxWindowBits int

Sets the Max Window Bits for the Server.

read-only
serverNoContextTakeover bool

Control whether the server will reuse it's compression instances.

read-only

Operators

operator ==(other) bool

The equality operator.

inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
toString() String

Returns a string representation of this object.

inherited