com.mle.play.ws

WebSocketController

trait WebSocketController extends WebSocketBase with Log

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

Type Members

  1. abstract type Client

    Definition Classes
    WebSocketBase

  2. abstract type Message

    Definition Classes
    WebSocketBase

Abstract Value Members

  1. abstract def authenticate(implicit request: RequestHeader): Option[String]

  2. abstract def newClient(user: String, channel: Channel[Message])(implicit request: RequestHeader): Client

    Definition Classes
    WebSocketBase

  3. abstract def onConnect(client: Client): Unit

    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
    WebSocketBase

  4. abstract def onDisconnect(client: Client): Unit

    Called when a client has disconnected.

    Called when a client has disconnected.

    client

    the disconnected client channel

    Definition Classes
    WebSocketBase

  5. abstract def wsUrl(implicit request: RequestHeader): String

    Definition Classes
    WebSocketBase

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

    Definition Classes
    Any

  7. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. val log: Logger

    Attributes
    protected
    Definition Classes
    Log

  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. def onMessage(msg: Message, client: Client): Unit

    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

    Definition Classes
    WebSocketBase

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

    Definition Classes
    AnyRef

  20. def toString(): String

    Definition Classes
    AnyRef → Any

  21. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. def welcomeMessage: Option[Message]

  25. def ws(implicit frameFormatter: FrameFormatter[Message]): WebSocket[Message]

    Opens a WebSocket connection.

    Opens a WebSocket connection.

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

    The implementation is problematic because a websocket connection appears to be opened even if authentication fails, if only for a very brief moment. I would prefer to return some erroneous HTTP status code when authentication fails but I don't know how to.

    returns

    a websocket connection using messages of type Message

Inherited from Log

Inherited from WebSocketBase

Inherited from AnyRef

Inherited from Any

Ungrouped