Class/Object

com.malliina.play.ws

DefaultJsonWebSocket

Related Docs: object DefaultJsonWebSocket | package ws

Permalink

abstract class DefaultJsonWebSocket extends JsonWebSockets with SyncSockets

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultJsonWebSocket
  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 DefaultJsonWebSocket(mat: Materializer)

    Permalink

Type Members

  1. type AuthSuccess = Username

    Permalink
    Definition Classes
    DefaultJsonWebSocketWebSocketBase
  2. type Client = ClientInfo[Message]

    Permalink
    Definition Classes
    DefaultJsonWebSocketWebSocketBase
  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 onConnectSync(client: Client): Unit

    Permalink
    Definition Classes
    SyncSockets
  3. abstract def onDisconnectSync(client: Client): Unit

    Permalink
    Definition Classes
    SyncSockets
  4. abstract def openSocketCall: Call

    Permalink

    Implement this like routes.YourController.openSocket().

    Implement this like routes.YourController.openSocket().

    Definition Classes
    WebSocketController

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. final def asInstanceOf[T0]: T0

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

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

    Permalink

    returns

    the currently connected clients

    Definition Classes
    SyncSocketsWebSocketBase
  7. def clientsSync: Seq[ClientInfo[JsValue]]

    Permalink
    Definition Classes
    DefaultJsonWebSocketSyncSockets
  8. def clone(): AnyRef

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    DefaultJsonWebSocketWebSocketBase
  18. final def notify(): Unit

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

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

    Permalink

    Called when a client has connected.

    Called when a client has connected.

    client

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

    Definition Classes
    DefaultJsonWebSocketSyncSocketsWebSocketBase
  21. 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
    DefaultJsonWebSocketSyncSocketsWebSocketBase
  22. 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
    WebSocketBase
  23. def onUnauthorized(req: RequestHeader): Result

    Permalink
    Definition Classes
    WebSocketController
  24. def openSocket: WebSocket

    Permalink
    Definition Classes
    JsonWebSockets
  25. val pinger: Subscription

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  28. def unicast(user: Username, message: Message): Boolean

    Permalink

    Sends message to each connection authenticated as user.

    Sends message to each connection authenticated as user.

    returns

    true if at least one user existed and the message was sent, false otherwise

  29. def unicastJson[T](user: Username, message: T)(implicit arg0: Writes[T]): Boolean

    Permalink
  30. val users: ItemMap[Client, Unit]

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

    Permalink
    Attributes
    protected
    Definition Classes
    WebSocketController
  37. 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