SocketDecoder

zio.http.SocketDecoder
See theSocketDecoder companion object
final case class SocketDecoder(maxFramePayloadLength: Int = ..., expectMaskedFrames: Boolean = ..., allowMaskMismatch: Boolean = ..., allowExtensions: Boolean = ..., closeOnProtocolViolation: Boolean = ..., withUTF8Validator: Boolean = ...)

Frame decoder configuration

Attributes

Companion
object
Source
SocketDecoder.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Concrete methods

def extensions(allowed: Boolean): SocketDecoder

Attributes

Source
SocketDecoder.scala
def maskMismatch(allowed: Boolean): SocketDecoder

When set to true, frames which are not masked properly according to the standard will still be accepted.

When set to true, frames which are not masked properly according to the standard will still be accepted.

Attributes

Source
SocketDecoder.scala
def maskedFrames(allowed: Boolean): SocketDecoder

Web socket servers must set this to true to reject incoming masked payload.

Web socket servers must set this to true to reject incoming masked payload.

Attributes

Source
SocketDecoder.scala
def maxFramePayloadLength(length: Int): SocketDecoder

Sets Maximum length of a frame's payload. Setting this to an appropriate value for you application helps check for denial of services attacks.

Sets Maximum length of a frame's payload. Setting this to an appropriate value for you application helps check for denial of services attacks.

Attributes

Source
SocketDecoder.scala
def protocolViolation(allowed: Boolean): SocketDecoder

Flag to not send close frame immediately on any protocol violation.ion.

Flag to not send close frame immediately on any protocol violation.ion.

Attributes

Source
SocketDecoder.scala
def uTF8Validation(enable: Boolean): SocketDecoder

Allows you to avoid adding of Utf8FrameValidator to the pipeline on the WebSocketServerProtocolHandler creation. This is useful (less overhead) when you use only BinaryWebSocketFrame within your web socket connection.

Allows you to avoid adding of Utf8FrameValidator to the pipeline on the WebSocketServerProtocolHandler creation. This is useful (less overhead) when you use only BinaryWebSocketFrame within your web socket connection.

Attributes

Source
SocketDecoder.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product