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
CloseFramemessage back from the client. The connection will also be closed if the client does not respond with aCloseFrameafter some reasonable amount of time. Another way of closing the connection is by emitting aCloseFramein the stream of messages heading to the client. This method allows one to attach a message to theCloseFrameas 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 aCloseFrame. 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
- Alphabetic
- By Inheritance
- WebSocketBuilder
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
CloseFramemessage back from the client. The connection will also be closed if the client does not respond with aCloseFrameafter some reasonable amount of time. Another way of closing the connection is by emitting aCloseFramein the stream of messages heading to the client. This method allows one to attach a message to theCloseFrameas 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 aCloseFrame. 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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val headers: Headers
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val onHandshakeFailure: F[Response[F]]
- val onNonWebSocketRequest: F[Response[F]]
- val receive: Pipe[F, WebSocketFrame, Unit]
- val send: Stream[F, WebSocketFrame]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()