Class/Object

com.malliina.play.ws

WebSocketController

Related Docs: object WebSocketController | package ws

Permalink

abstract class WebSocketController extends WebSocketBase

Linear Supertypes
WebSocketBase, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocketController
  2. WebSocketBase
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WebSocketController(mat: Materializer, socketQueueSize: Int = 10000)

    Permalink

Type Members

  1. abstract type AuthSuccess

    Permalink
    Definition Classes
    WebSocketBase
  2. abstract type Client <: SocketClient[Message]

    Permalink
    Definition Classes
    WebSocketBase
  3. abstract type Message

    Permalink
    Definition Classes
    WebSocketBase

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

  2. abstract def clients: Future[Seq[Client]]

    Permalink

    returns

    the currently connected clients

    Definition Classes
    WebSocketBase
  3. abstract def newClient(authResult: AuthSuccess, channel: SourceQueue[Message], request: RequestHeader): Client

    Permalink
    Definition Classes
    WebSocketBase
  4. abstract 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
    WebSocketBase
  5. abstract 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
    WebSocketBase
  6. abstract def openSocketCall: Call

    Permalink

    Implement this like routes.YourController.openSocket().

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 clone(): AnyRef

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

    Permalink
  8. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  17. 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
  18. def onUnauthorized(req: RequestHeader): Result

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

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

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

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

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

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

    Permalink
  25. 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

  26. def wsBase(onFailure: (RequestHeader) ⇒ Either[Result, Flow[Message, Message, NotUsed]], transformer: MessageFlowTransformer[Message, Message]): WebSocket

    Permalink
    Attributes
    protected
  27. def wsUrl(request: RequestHeader): String

    Permalink
    Definition Classes
    WebSocketControllerWebSocketBase

Inherited from WebSocketBase

Inherited from AnyRef

Inherited from Any

Ungrouped