final case class WebSocketConfig(subprotocols: Option[String] = None, handshakeTimeoutMillis: Long = 10000L, forceCloseTimeoutMillis: Long = -1L, handleCloseFrames: Boolean = true, sendCloseFrame: CloseStatus = ..., dropPongFrames: Boolean = true, decoderConfig: SocketDecoder = SocketDecoder.default) extends Product with Serializable

Server side websocket configuration

Self Type
WebSocketConfig
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocketConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebSocketConfig(subprotocols: Option[String] = None, handshakeTimeoutMillis: Long = 10000L, forceCloseTimeoutMillis: Long = -1L, handleCloseFrames: Boolean = true, sendCloseFrame: CloseStatus = ..., dropPongFrames: Boolean = true, decoderConfig: SocketDecoder = SocketDecoder.default)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. def closeFrame(code: Int, reason: String): WebSocketConfig

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

  7. def closeStatus(status: CloseStatus): WebSocketConfig

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

  8. def decoderConfig(socketDecoder: SocketDecoder): WebSocketConfig
  9. val decoderConfig: SocketDecoder
  10. val dropPongFrames: Boolean
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def forceCloseTimeout(duration: zio.Duration): WebSocketConfig

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

  13. val forceCloseTimeoutMillis: Long
  14. def forwardCloseFrames(forward: Boolean): WebSocketConfig

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

  15. def forwardPongFrames(forward: Boolean): WebSocketConfig

    Pong frames should be forwarded

  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  17. val handleCloseFrames: Boolean
  18. def handshakeTimeout(duration: zio.Duration): WebSocketConfig

    Handshake timeout in mills

  19. val handshakeTimeoutMillis: Long
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  24. val sendCloseFrame: CloseStatus
  25. def subProtocol(name: Option[String]): WebSocketConfig

    Used to specify the websocket sub-protocol

  26. val subprotocols: Option[String]
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped