Class/Object

com.malliina.play.controllers

Streaming

Related Docs: object Streaming | package controllers

Permalink

abstract class Streaming extends JsonWebSockets with SyncSockets

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Streaming
  2. SyncSockets
  3. JsonWebSockets
  4. WebSocketController
  5. WebSocketBase
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Streaming(mat: Materializer)

    Permalink

Type Members

  1. type AuthSuccess = AuthedRequest

    Permalink
    Definition Classes
    StreamingWebSocketBase
  2. type Client = JsonSocketClient[Username]

    Permalink
    Definition Classes
    StreamingWebSocketBase
  3. type Message = JsValue

    Permalink
    Definition Classes
    JsonWebSocketsWebSocketBase

Abstract Value Members

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

    Permalink

    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]

    Permalink
  3. abstract def openSocketCall: Call

    Permalink

    Implement this like routes.YourController.openSocket().

    Implement this like routes.YourController.openSocket().

    Definition Classes
    WebSocketController
  4. abstract def subscriptions: ItemMap[Client, Subscription]

    Permalink

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

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def broadcast(message: Message): Future[Seq[QueueOfferResult]]

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

    Permalink

    returns

    the currently connected clients

    Definition Classes
    SyncSocketsWebSocketBase
  8. def clientsSync: Seq[Client]

    Permalink
    Definition Classes
    StreamingSyncSockets
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. implicit val ec: ExecutionContextExecutor

    Permalink
    Definition Classes
    WebSocketController
  11. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def newClient(user: AuthSuccess, channel: SourceQueue[Message], request: RequestHeader): Client

    Permalink
    Definition Classes
    StreamingWebSocketBase
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. def onConnect(client: Client): Future[Unit]

    Permalink

    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
    SyncSocketsWebSocketBase
  22. def onConnectSync(client: Client): Unit

    Permalink
    Definition Classes
    StreamingSyncSockets
  23. def onDisconnect(client: Client): Future[Unit]

    Permalink

    Called when a client has disconnected.

    Called when a client has disconnected.

    client

    the disconnected client channel

    Definition Classes
    SyncSocketsWebSocketBase
  24. def onDisconnectSync(client: Client): Unit

    Permalink
    Definition Classes
    StreamingSyncSockets
  25. def onMessage(msg: Message, client: Client): Boolean

    Permalink

    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
  26. def onUnauthorized(req: RequestHeader): Result

    Permalink
    Definition Classes
    WebSocketController
  27. def openSocket: WebSocket

    Permalink
    Definition Classes
    JsonWebSockets
  28. val pinger: Subscription

    Permalink
    Definition Classes
    JsonWebSockets
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def welcomeMessage(client: Client): Option[Message]

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

    Permalink
    Attributes
    protected
  36. def ws(transformer: MessageFlowTransformer[Message, Message]): WebSocket

    Permalink

    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
  37. def wsBase(onFailure: (RequestHeader) ⇒ Either[Result, Flow[Message, Message, NotUsed]], transformer: MessageFlowTransformer[Message, Message]): WebSocket

    Permalink
    Attributes
    protected
    Definition Classes
    WebSocketController
  38. def wsUrl(request: RequestHeader): String

    Permalink
    Definition Classes
    WebSocketControllerWebSocketBase

Inherited from SyncSockets

Inherited from JsonWebSockets

Inherited from WebSocketController

Inherited from WebSocketBase

Inherited from AnyRef

Inherited from Any

Ungrouped