Class

unfiltered.netty.websockets

SocketPlan

Related Doc: package websockets

Permalink

case class SocketPlan(intent: SocketIntent, pass: PassHandler, shaker: WebSocketServerHandshaker, exceptions: ExceptionHandler) extends ChannelInboundHandlerAdapter 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.

Source
plans.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, ChannelInboundHandlerAdapter, ChannelInboundHandler, ChannelHandlerAdapter, ChannelHandler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SocketPlan
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ChannelInboundHandlerAdapter
  7. ChannelInboundHandler
  8. ChannelHandlerAdapter
  9. ChannelHandler
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def attempt: (SocketCallback) ⇒ Option[Unit]

    Permalink

  6. def channelActive(arg0: ChannelHandlerContext): Unit

    Permalink
    Definition Classes
    ChannelInboundHandlerAdapter → ChannelInboundHandler
    Annotations
    @Skip() @throws( classOf[java.lang.Exception] )

  7. def channelInactive(arg0: ChannelHandlerContext): Unit

    Permalink
    Definition Classes
    ChannelInboundHandlerAdapter → ChannelInboundHandler
    Annotations
    @Skip() @throws( classOf[java.lang.Exception] )

  8. final def channelRead(ctx: ChannelHandlerContext, msg: AnyRef): Unit

    Permalink
    Definition Classes
    SocketPlan → ChannelInboundHandlerAdapter → ChannelInboundHandler

  9. final def channelReadComplete(ctx: ChannelHandlerContext): Unit

    Permalink
    Definition Classes
    SocketPlan → ChannelInboundHandlerAdapter → ChannelInboundHandler

  10. def channelRegistered(arg0: ChannelHandlerContext): Unit

    Permalink
    Definition Classes
    ChannelInboundHandlerAdapter → ChannelInboundHandler
    Annotations
    @Skip() @throws( classOf[java.lang.Exception] )

  11. def channelUnregistered(arg0: ChannelHandlerContext): Unit

    Permalink
    Definition Classes
    ChannelInboundHandlerAdapter → ChannelInboundHandler
    Annotations
    @Skip() @throws( classOf[java.lang.Exception] )

  12. def channelWritabilityChanged(arg0: ChannelHandlerContext): Unit

    Permalink
    Definition Classes
    ChannelInboundHandlerAdapter → ChannelInboundHandler
    Annotations
    @Skip() @throws( classOf[java.lang.Exception] )

  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  14. def ensureNotSharable(): Unit

    Permalink
    Attributes
    protected[io.netty.channel]
    Definition Classes
    ChannelHandlerAdapter

  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. def exceptionCaught(ctx: ChannelHandlerContext, throwable: Throwable): Unit

    Permalink
    Definition Classes
    SocketPlan → ChannelInboundHandlerAdapter → ChannelInboundHandler → ChannelHandlerAdapter → ChannelHandler

  17. val exceptions: ExceptionHandler

    Permalink

  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  20. def handlerAdded(arg0: ChannelHandlerContext): Unit

    Permalink
    Definition Classes
    ChannelHandlerAdapter → ChannelHandler
    Annotations
    @throws( classOf[java.lang.Exception] )

  21. def handlerRemoved(arg0: ChannelHandlerContext): Unit

    Permalink
    Definition Classes
    ChannelHandlerAdapter → ChannelHandler
    Annotations
    @throws( classOf[java.lang.Exception] )

  22. val intent: SocketIntent

    Permalink

  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  24. def isSharable(): Boolean

    Permalink
    Definition Classes
    ChannelHandlerAdapter

  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  28. val pass: PassHandler

    Permalink

  29. val shaker: WebSocketServerHandshaker

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  31. def userEventTriggered(arg0: ChannelHandlerContext, arg1: Any): Unit

    Permalink
    Definition Classes
    ChannelInboundHandlerAdapter → ChannelInboundHandler
    Annotations
    @Skip() @throws( classOf[java.lang.Exception] )

  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ChannelInboundHandlerAdapter

Inherited from ChannelInboundHandler

Inherited from ChannelHandlerAdapter

Inherited from ChannelHandler

Inherited from AnyRef

Inherited from Any

Ungrouped