com.mle.play.controllers

Streaming

Related Doc: package controllers

trait Streaming extends JsonWebSockets

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Streaming
  2. JsonWebSockets
  3. WebSocketController
  4. Log
  5. WebSocketBase
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type AuthSuccess = AuthResult

    Definition Classes
    StreamingWebSocketBase
  2. type Client = WebSocketClient

    Definition Classes
    StreamingWebSocketBase
  3. type Message = JsValue

    Definition Classes
    JsonWebSocketsWebSocketBase

Abstract Value Members

  1. abstract def authenticateAsync(req: RequestHeader): Future[AuthSuccess]

    What do we want? - Future[Either[AuthFailure, AuthSuccess]] - Future[Option[AuthSuccess]] - Future[AuthSuccess]

    What do we want? - Future[Either[AuthFailure, AuthSuccess]] - Future[Option[AuthSuccess]] - Future[AuthSuccess]

    IMO: The first one, then the others as convenience based on the first. (_.toOption, _.toOption.get)

    req

    req

    returns

    a successful authentication result, or fails with a NoSuchElementException if authentication fails

    Definition Classes
    WebSocketController
  2. abstract def jsonEvents: Observable[JsValue]

  3. abstract def openSocketCall: Call

    Implement this like routes.YourController.openSocket().

    Implement this like routes.YourController.openSocket().

    returns

    Definition Classes
    WebSocketController

Concrete 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. val SUBSCRIBE: String

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  6. def broadcast(message: Message): Unit

    Definition Classes
    WebSocketControllerWebSocketBase
  7. def clients: Seq[Client]

    Definition Classes
    StreamingWebSocketBase
  8. def clone(): AnyRef

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

    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  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. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. val log: Logger

    Attributes
    protected
    Definition Classes
    Log
  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def newClient(user: AuthSuccess, channel: Channel[Message])(implicit request: RequestHeader): Client

    Definition Classes
    StreamingWebSocketBase
  18. final def notify(): Unit

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

    Definition Classes
    AnyRef
  20. def onConnect(client: Client): Unit

    Called when a client has been created.

    Called when a client has been created. Note however that messages cannot yet be sent to the client.

    client

    the client channel, can be used to push messages to the client

    Definition Classes
    StreamingWebSocketBase
  21. def onDisconnect(client: Client): Unit

    Called when a client has disconnected.

    Called when a client has disconnected.

    client

    the disconnected client channel

    Definition Classes
    StreamingWebSocketBase
  22. def onMessage(msg: Message, client: Client): Boolean

    Called when the client sends a message to the server.

    Called when the client sends a message to the server.

    msg

    the message

    client

    the client that sent the message

    returns

    true if the message was handled, false otherwise

    Definition Classes
    StreamingWebSocketBase
  23. def onUnauthorized(req: RequestHeader): play.api.mvc.Results.Status

    Definition Classes
    WebSocketController
  24. def openSocket: WebSocket[Message, Message]

    Definition Classes
    JsonWebSockets
  25. def openSocket2: WebSocket[Message, Message]

    Definition Classes
    JsonWebSockets
  26. val pinger: Subscription

    Definition Classes
    JsonWebSockets
  27. val subscriptions: TrieMap[WebSocketClient, Subscription]

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

    Definition Classes
    AnyRef
  29. def toEnumerator(maybeMessage: Option[Message]): Enumerator[Message]

    Definition Classes
    WebSocketController
  30. def toString(): String

    Definition Classes
    AnyRef → Any
  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 welcomeEnumerator(client: Client): Enumerator[Message]

    Definition Classes
    WebSocketController
  35. def welcomeMessage(client: Client): Option[Message]

    Definition Classes
    WebSocketController
  36. def writeLog(client: Client, suffix: String): Unit

    Attributes
    protected
  37. def ws(frameFormatter: FrameFormatter[Message]): WebSocket[Message, Message]

    Opens a WebSocket connection.

    Opens a WebSocket connection.

    This is the controller for requests to ws://... or wss://... URIs.

    returns

    a websocket connection using messages of type Message

    Definition Classes
    WebSocketController
  38. def ws2(frameFormatter: FrameFormatter[Message]): WebSocket[Message, Message]

    Instead of returning an Unauthorized result upon authentication failures, this opens then immediately closes a connection connections, sends no messages and ignores any messages.

    Instead of returning an Unauthorized result upon authentication failures, this opens then immediately closes a connection connections, sends no messages and ignores any messages.

    The Java-WebSocket client library hangs if an Unauthorized result is returned after a websocket connection attempt.

    returns

    Definition Classes
    WebSocketController
  39. def wsUrl(implicit request: RequestHeader): String

    Definition Classes
    WebSocketControllerWebSocketBase

Inherited from JsonWebSockets

Inherited from WebSocketController

Inherited from Log

Inherited from WebSocketBase

Inherited from AnyRef

Inherited from Any

Ungrouped