zio-http/zio.http.socket/SocketProtocol

SocketProtocol

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

Server side websocket configuration

Companion:
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def clientBuilder: Builder
def serverBuilder: Builder
def withCloseFrame(code: Int, reason: String): SocketProtocol

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

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

def withCloseStatus(status: CloseStatus): SocketProtocol

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

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

def withForceCloseTimeout(duration: Duration): SocketProtocol

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

def withForwardCloseFrames(forward: Boolean): SocketProtocol

Close frames should be forwarded

Close frames should be forwarded

def withForwardPongFrames(forward: Boolean): SocketProtocol

Pong frames should be forwarded

Pong frames should be forwarded

def withHandshakeTimeout(duration: Duration): SocketProtocol

Handshake timeout in mills

Handshake timeout in mills

def withSubProtocol(name: Option[String]): SocketProtocol

Used to specify the websocket sub-protocol

Used to specify the websocket sub-protocol

Inherited methods

def productIterator: Iterator[Any]
Inherited from:
Product