Package

unfiltered.netty

websockets

Permalink

package websockets

Module defining function types used in the WebSockets module as well as function defaults

Source
package.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. websockets
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Binary(buf: ByteBuf) extends Msg with Product with Serializable

    Permalink
  2. case class Close(socket: WebSocket) extends SocketCallback with Product with Serializable

    Permalink
  3. trait CloseOnException extends AnyRef

    Permalink

    Serves the same purpose of unfiltered.netty.ServerErrorResponse, which is to satisfy ExceptionHandler#onException, except that it is not specific to the HTTP protocol.

    Serves the same purpose of unfiltered.netty.ServerErrorResponse, which is to satisfy ExceptionHandler#onException, except that it is not specific to the HTTP protocol. It will simply log the Throwable and close the Channel

  4. case class Continuation(socket: WebSocket, fragment: Fragment) extends SocketCallback with Product with Serializable

    Permalink
  5. case class Error(socket: WebSocket, err: Throwable) extends SocketCallback with Product with Serializable

    Permalink
  6. case class Fragment(buf: ByteBuf, last: Boolean) extends Msg with Product with Serializable

    Permalink
  7. type Intent = PartialFunction[RequestBinding, SocketIntent]

    Permalink

    The transition from an http request handling to websocket request handling.

    The transition from an http request handling to websocket request handling. Note: This can not be an Async.Intent because RequestBinding is a Responder for HttpResponses

  8. case class Message(socket: WebSocket, msg: Msg) extends SocketCallback with Product with Serializable

    Permalink
  9. sealed trait Msg extends AnyRef

    Permalink
  10. case class Open(socket: WebSocket) extends SocketCallback with Product with Serializable

    Permalink
  11. type PassHandler = (ChannelHandlerContext, AnyRef) ⇒ Unit

    Permalink

    A pass handler type represents a means to forward a request upstream for unhandled patterns and protocol messages

  12. trait Plan extends ChannelInboundHandlerAdapter with ExceptionHandler

    Permalink

    Provides an extension point for netty ChannelHandlers that wish to support the WebSocket protocol

  13. trait SocketCallback extends AnyRef

    Permalink
  14. type SocketIntent = PartialFunction[SocketCallback, Unit]

    Permalink

    A SocketIntent is the result of a handler lifting a request into the WebSocket protocol.

    A SocketIntent is the result of a handler lifting a request into the WebSocket protocol. WebSockets may be responded to asynchronously, thus their handler will not need to return a value

  15. case class SocketPlan(intent: SocketIntent, pass: PassHandler, shaker: WebSocketServerHandshaker, exceptions: ExceptionHandler) extends ChannelInboundHandlerAdapter with Product with Serializable

    Permalink

    The result of defined Intent should result in a SocketPlan value.

    The result of defined Intent should result in a SocketPlan value. SocketPlans are handlers for message frames in the WebSocket protocol. If an unexpected message is received by a SocketPlan, the request handling will automatically be delegated the PassHandler. As part of the WebSocket protocol, server errors should be reported to the websocket before closing. This is handled for you.

  16. case class Text(txt: String) extends Msg with Product with Serializable

    Permalink
  17. case class WebSocket(channel: Channel) extends Product with Serializable

    Permalink

Value Members

  1. val DefaultPassHandler: PassHandler

    Permalink

    A default implementation of a Plan.PassHandler which returns a HTTP protocol forbidden response code to the channel before closing the channel

  2. val Pass: SocketIntent

    Permalink

    Equivalent of an HttpResponse's Pass function, a SocketIntent that does nothing

  3. val PassAlong: Intent

    Permalink
  4. object Planify

    Permalink

    A companion module for building web socket Plans.

    A companion module for building web socket Plans. These plans have default CloseOnException error handling baked in. To your own ExceptionHandler, Instantiate an instance of Planify yourself mixing a custom ExceptionHandler implementation

Inherited from AnyRef

Inherited from Any

Ungrouped