Packages

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

Server side websocket configuration

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

Instance Constructors

  1. new SocketProtocol(subprotocols: Option[String] = None, handshakeTimeoutMillis: Long = 10000L, forceCloseTimeoutMillis: Long = -1L, handleCloseFrames: Boolean = true, sendCloseFrame: WebSocketCloseStatus = WebSocketCloseStatus.NORMAL_CLOSURE, 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 clientBuilder: Builder
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. val decoderConfig: SocketDecoder
  8. val dropPongFrames: Boolean
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val forceCloseTimeoutMillis: Long
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. val handleCloseFrames: Boolean
  13. val handshakeTimeoutMillis: Long
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. val sendCloseFrame: WebSocketCloseStatus
  20. def serverBuilder: Builder
  21. val subprotocols: Option[String]
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. def withCloseFrame(code: Int, reason: String): SocketProtocol

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

  27. def withCloseStatus(status: CloseStatus): SocketProtocol

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

  28. def withDecoderConfig(socketDecoder: SocketDecoder): SocketProtocol
  29. def withForceCloseTimeout(duration: zio.Duration): SocketProtocol

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

  30. def withForwardCloseFrames(forward: Boolean): SocketProtocol

    Close frames should be forwarded

  31. def withForwardPongFrames(forward: Boolean): SocketProtocol

    Pong frames should be forwarded

  32. def withHandshakeTimeout(duration: zio.Duration): SocketProtocol

    Handshake timeout in mills

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

    Used to specify the websocket sub-protocol

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 Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped