zio-http
API
Generated with
zio-http/zio.http/WebSocketConfig

WebSocketConfig

zio.http.WebSocketConfig
See theWebSocketConfig companion object
final case class WebSocketConfig(subprotocols: Option[String], handshakeTimeoutMillis: Long, forceCloseTimeoutMillis: Long, handleCloseFrames: Boolean, sendCloseFrame: CloseStatus, dropPongFrames: Boolean, decoderConfig: SocketDecoder)

Server side websocket configuration

Attributes

Companion
object
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 closeFrame(code: Int, reason: String): WebSocketConfig

Close frame to send, when close frame was not sent manually.

Close frame to send, when close frame was not sent manually.

Attributes

def closeStatus(status: CloseStatus): WebSocketConfig

Close frame to send, when close frame was not sent manually.

Close frame to send, when close frame was not sent manually.

Attributes

def forceCloseTimeout(duration: Duration): WebSocketConfig

Close the connection if it was not closed by the client after timeout specified

Close the connection if it was not closed by the client after timeout specified

Attributes

def forwardCloseFrames(forward: Boolean): WebSocketConfig

Close frames should be forwarded instead of handled solely by Netty, invisibly to the Websocket Client

Close frames should be forwarded instead of handled solely by Netty, invisibly to the Websocket Client

Attributes

def forwardPongFrames(forward: Boolean): WebSocketConfig

Pong frames should be forwarded

Pong frames should be forwarded

Attributes

def handshakeTimeout(duration: Duration): WebSocketConfig

Handshake timeout in mills

Handshake timeout in mills

Attributes

def subProtocol(name: Option[String]): WebSocketConfig

Used to specify the websocket sub-protocol

Used to specify the websocket sub-protocol

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with