zhttp/zhttp.socket

zhttp.socket

package zhttp.socket

Type members

Classlikes

sealed abstract class CloseStatus(val asJava: WebSocketCloseStatus)
Companion:
object
object CloseStatus
Companion:
class
final case class SocketApp[-R](decoder: SocketDecoder, protocol: SocketProtocol, message: Option[ChannelEvent[WebSocketFrame, WebSocketFrame] => ZIO[R, Throwable, Any]])
Companion:
object
object SocketApp
Companion:
class
final case class SocketDecoder(maxFramePayloadLength: Int, expectMaskedFrames: Boolean, allowMaskMismatch: Boolean, allowExtensions: Boolean, closeOnProtocolViolation: Boolean, withUTF8Validator: Boolean)

Frame decoder configuration

Frame decoder configuration

Companion:
object
object SocketDecoder
Companion:
class
final case class SocketProtocol(subprotocols: Option[String], handshakeTimeoutMillis: Long, forceCloseTimeoutMillis: Long, handleCloseFrames: Boolean, sendCloseFrame: WebSocketCloseStatus, dropPongFrames: Boolean, decoderConfig: SocketDecoder)

Server side websocket configuration

Server side websocket configuration

Companion:
object
object SocketProtocol
Companion:
class
sealed trait WebSocketFrame extends Product with Serializable
Companion:
object
object WebSocketFrame
Companion:
class

Types

type WebSocketChannel = Channel[WebSocketFrame]

A channel that allows websocket frames to be written to it.

A channel that allows websocket frames to be written to it.

type WebSocketChannelEvent = ChannelEvent[WebSocketFrame, WebSocketFrame]

A channel that allows websocket frames to be read and write to it.

A channel that allows websocket frames to be read and write to it.