Options controlling compression in aWebSocket.

ACompressionOptions instance can be passed toWebSocket.connect, orused in other similar places whereWebSocket compression is configured.

In most cases the defaultcompressionDefault is sufficient, but in somesituations, it might be desirable to use different compression parameters,for example to preserve memory on small devices.

Constructors

CompressionOptions({boolclientNoContextTakeover =false,boolserverNoContextTakeover =false,int?clientMaxWindowBits,int?serverMaxWindowBits,boolenabled =true})

const

Properties

clientMaxWindowBits→int?

The maximal window size bit count requested by the client.

final

clientNoContextTakeover→bool

Whether the client will reuse its compression instances.

final

enabled→bool

Whether WebSocket compression is enabled.

final

hashCode→int

The hash code for this object.

no setterinherited

runtimeType→Type

A representation of the runtime type of the object.

no setterinherited

serverMaxWindowBits→int?

The maximal window size bit count requested by the server.

final

serverNoContextTakeover→bool

Whether the server will reuse its compression instances.

final

Methods

noSuchMethod(Invocationinvocation)→ dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString()→String

A string representation of this object.

inherited

Operators

operator ==(Objectother)→bool

The equality operator.

inherited

Constants

compressionDefault→ constCompressionOptions

DefaultWebSocket compression configuration.

compressionOff→ constCompressionOptions

No-compression configuration.