play.api.mvc

WebSocket

case class WebSocket[In, Out](f: (RequestHeader) ⇒ Future[Either[Result, (Enumerator[In], Iteratee[Out, Unit]) ⇒ Unit]])(implicit inFormatter: FrameFormatter[In], outFormatter: FrameFormatter[Out]) extends Handler with Product with Serializable

A WebSocket handler.

In

the type of messages coming in

Out

the type of messages going out

f

the socket messages generator

Source
WebSocket.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Handler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WebSocket
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Handler
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebSocket(f: (RequestHeader) ⇒ Future[Either[Result, (Enumerator[In], Iteratee[Out, Unit]) ⇒ Unit]])(implicit inFormatter: FrameFormatter[In], outFormatter: FrameFormatter[Out])

    f

    the socket messages generator

Type Members

  1. type FramesIn = In

  2. type FramesOut = Out

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. def apply(): WebSocket[In, Out]

    Returns itself, for better support in the routes file.

    Returns itself, for better support in the routes file.

    returns

    itself

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  10. val f: (RequestHeader) ⇒ Future[Either[Result, (Enumerator[In], Iteratee[Out, Unit]) ⇒ Unit]]

    the socket messages generator

  11. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  13. implicit val inFormatter: FrameFormatter[In]

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. implicit val outFormatter: FrameFormatter[Out]

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

    Definition Classes
    AnyRef

  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Handler

Inherited from AnyRef

Inherited from Any

Ungrouped