Packages

final case class WebSocketBuilder[F[_]](send: Stream[F, WebSocketFrame], receive: Pipe[F, WebSocketFrame, Unit], headers: Headers, onNonWebSocketRequest: F[Response[F]], onHandshakeFailure: F[Response[F]]) extends Product with Serializable

Build a response which will accept an HTTP websocket upgrade request and initiate a websocket connection using the supplied exchange to process and respond to websocket messages.

send

The send side of the Exchange represents the outgoing stream of messages that should be sent to the client

receive

The receive side of the Exchange is a sink to which the framework will push the incoming websocket messages Once both streams have terminated, the server will initiate a close of the websocket connection. As defined in the websocket specification, this means the server will send a CloseFrame to the client and wait for a CloseFrame in response before closing the connection, this ensures that no messages are lost in flight. The server will shutdown the connection when it receives the CloseFrame message back from the client. The connection will also be closed if the client does not respond with a CloseFrame after some reasonable amount of time. Another way of closing the connection is by emitting a CloseFrame in the stream of messages heading to the client. This method allows one to attach a message to the CloseFrame as defined by the websocket protocol. Unfortunately the current implementation does not quite respect the description above, it violates the websocket protocol by terminating the connection immediately upon reception of a CloseFrame. This bug will be addressed soon in an upcoming release and this message will be removed. Currently, there is no way for the server to be notified when the connection is closed, neither in the case of a normal disconnection such as a Close handshake or due to a connection error. There are plans to address this limitation in the future.

headers

Handshake response headers, such as such as:Sec-WebSocket-Protocol.

onNonWebSocketRequest

The status code to return to a client making a non-websocket HTTP request to this route. default: NotImplemented

onHandshakeFailure

The status code to return when failing to handle a websocket HTTP request to this route. default: BadRequest

Source
WebSocketBuilder.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocketBuilder
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebSocketBuilder(send: Stream[F, WebSocketFrame], receive: Pipe[F, WebSocketFrame, Unit], headers: Headers, onNonWebSocketRequest: F[Response[F]], onHandshakeFailure: F[Response[F]])

    send

    The send side of the Exchange represents the outgoing stream of messages that should be sent to the client

    receive

    The receive side of the Exchange is a sink to which the framework will push the incoming websocket messages Once both streams have terminated, the server will initiate a close of the websocket connection. As defined in the websocket specification, this means the server will send a CloseFrame to the client and wait for a CloseFrame in response before closing the connection, this ensures that no messages are lost in flight. The server will shutdown the connection when it receives the CloseFrame message back from the client. The connection will also be closed if the client does not respond with a CloseFrame after some reasonable amount of time. Another way of closing the connection is by emitting a CloseFrame in the stream of messages heading to the client. This method allows one to attach a message to the CloseFrame as defined by the websocket protocol. Unfortunately the current implementation does not quite respect the description above, it violates the websocket protocol by terminating the connection immediately upon reception of a CloseFrame. This bug will be addressed soon in an upcoming release and this message will be removed. Currently, there is no way for the server to be notified when the connection is closed, neither in the case of a normal disconnection such as a Close handshake or due to a connection error. There are plans to address this limitation in the future.

    headers

    Handshake response headers, such as such as:Sec-WebSocket-Protocol.

    onNonWebSocketRequest

    The status code to return to a client making a non-websocket HTTP request to this route. default: NotImplemented

    onHandshakeFailure

    The status code to return when failing to handle a websocket HTTP request to this route. default: BadRequest

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from WebSocketBuilder[F] to any2stringadd[WebSocketBuilder[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WebSocketBuilder[F], B)
    Implicit
    This member is added by an implicit conversion from WebSocketBuilder[F] to ArrowAssoc[WebSocketBuilder[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def ensuring(cond: (WebSocketBuilder[F]) ⇒ Boolean, msg: ⇒ Any): WebSocketBuilder[F]
    Implicit
    This member is added by an implicit conversion from WebSocketBuilder[F] to Ensuring[WebSocketBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (WebSocketBuilder[F]) ⇒ Boolean): WebSocketBuilder[F]
    Implicit
    This member is added by an implicit conversion from WebSocketBuilder[F] to Ensuring[WebSocketBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): WebSocketBuilder[F]
    Implicit
    This member is added by an implicit conversion from WebSocketBuilder[F] to Ensuring[WebSocketBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): WebSocketBuilder[F]
    Implicit
    This member is added by an implicit conversion from WebSocketBuilder[F] to Ensuring[WebSocketBuilder[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WebSocketBuilder[F] to StringFormat[WebSocketBuilder[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. val headers: Headers
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. val onHandshakeFailure: F[Response[F]]
  22. val onNonWebSocketRequest: F[Response[F]]
  23. val receive: Pipe[F, WebSocketFrame, Unit]
  24. val send: Stream[F, WebSocketFrame]
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. def →[B](y: B): (WebSocketBuilder[F], B)
    Implicit
    This member is added by an implicit conversion from WebSocketBuilder[F] to ArrowAssoc[WebSocketBuilder[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from WebSocketBuilder[F] to any2stringadd[WebSocketBuilder[F]]

Inherited by implicit conversion StringFormat from WebSocketBuilder[F] to StringFormat[WebSocketBuilder[F]]

Inherited by implicit conversion Ensuring from WebSocketBuilder[F] to Ensuring[WebSocketBuilder[F]]

Inherited by implicit conversion ArrowAssoc from WebSocketBuilder[F] to ArrowAssoc[WebSocketBuilder[F]]

Ungrouped