unfiltered.netty.websockets

SocketPlan

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

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, SimpleChannelUpstreamHandler, ChannelUpstreamHandler, ChannelHandler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SocketPlan
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SimpleChannelUpstreamHandler
  7. ChannelUpstreamHandler
  8. ChannelHandler
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SocketPlan(intent: SocketIntent, pass: PassHandler, shaker: WebSocketServerHandshaker, exceptions: ExceptionHandler)

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 attempt: PartialFunction[SocketCallback, Unit]

  6. def channelBound(arg0: ChannelHandlerContext, arg1: ChannelStateEvent): Unit

    Definition Classes
    SimpleChannelUpstreamHandler
    Annotations
    @throws( classOf[java.lang.Exception] )
  7. def channelClosed(arg0: ChannelHandlerContext, arg1: ChannelStateEvent): Unit

    Definition Classes
    SimpleChannelUpstreamHandler
    Annotations
    @throws( classOf[java.lang.Exception] )
  8. def channelConnected(arg0: ChannelHandlerContext, arg1: ChannelStateEvent): Unit

    Definition Classes
    SimpleChannelUpstreamHandler
    Annotations
    @throws( classOf[java.lang.Exception] )
  9. def channelDisconnected(arg0: ChannelHandlerContext, arg1: ChannelStateEvent): Unit

    Definition Classes
    SimpleChannelUpstreamHandler
    Annotations
    @throws( classOf[java.lang.Exception] )
  10. def channelInterestChanged(arg0: ChannelHandlerContext, arg1: ChannelStateEvent): Unit

    Definition Classes
    SimpleChannelUpstreamHandler
    Annotations
    @throws( classOf[java.lang.Exception] )
  11. def channelOpen(arg0: ChannelHandlerContext, arg1: ChannelStateEvent): Unit

    Definition Classes
    SimpleChannelUpstreamHandler
    Annotations
    @throws( classOf[java.lang.Exception] )
  12. def channelUnbound(arg0: ChannelHandlerContext, arg1: ChannelStateEvent): Unit

    Definition Classes
    SimpleChannelUpstreamHandler
    Annotations
    @throws( classOf[java.lang.Exception] )
  13. def childChannelClosed(arg0: ChannelHandlerContext, arg1: ChildChannelStateEvent): Unit

    Definition Classes
    SimpleChannelUpstreamHandler
    Annotations
    @throws( classOf[java.lang.Exception] )
  14. def childChannelOpen(arg0: ChannelHandlerContext, arg1: ChildChannelStateEvent): Unit

    Definition Classes
    SimpleChannelUpstreamHandler
    Annotations
    @throws( classOf[java.lang.Exception] )
  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def exceptionCaught(ctx: ChannelHandlerContext, event: ExceptionEvent): Unit

    Definition Classes
    SocketPlan → SimpleChannelUpstreamHandler
  18. val exceptions: ExceptionHandler

  19. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def handleUpstream(arg0: ChannelHandlerContext, arg1: ChannelEvent): Unit

    Definition Classes
    SimpleChannelUpstreamHandler → ChannelUpstreamHandler
    Annotations
    @throws( classOf[java.lang.Exception] )
  22. val intent: SocketIntent

  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. def messageReceived(ctx: ChannelHandlerContext, event: MessageEvent): Unit

    Definition Classes
    SocketPlan → SimpleChannelUpstreamHandler
  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. val pass: PassHandler

  29. val shaker: WebSocketServerHandshaker

  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  31. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def writeComplete(arg0: ChannelHandlerContext, arg1: WriteCompletionEvent): Unit

    Definition Classes
    SimpleChannelUpstreamHandler
    Annotations
    @throws( classOf[java.lang.Exception] )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SimpleChannelUpstreamHandler

Inherited from ChannelUpstreamHandler

Inherited from ChannelHandler

Inherited from AnyRef

Inherited from Any

Ungrouped