Trait

com.mle.play.ws

SyncAuth

Related Doc: package ws

Permalink

trait SyncAuth extends WebSocketController

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SyncAuth
  2. WebSocketController
  3. Log
  4. WebSocketBase
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

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 authenticate(implicit req: RequestHeader): Option[AuthSuccess]

    Permalink
  2. abstract def clients: Seq[Client]

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

    Permalink
    Definition Classes
    WebSocketBase
  4. abstract def onConnect(client: Client): 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): 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().

    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 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
    SyncAuthWebSocketController
  6. def broadcast(message: Message): Unit

    Permalink
    Definition Classes
    WebSocketControllerWebSocketBase
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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. val log: Logger

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

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

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

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

    Permalink
    Definition Classes
    WebSocketController
  20. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    WebSocketController
  22. def toFuture[T](opt: Option[T]): Future[T]

    Permalink
  23. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def welcomeEnumerator(client: Client): Enumerator[Message]

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

    Permalink
    Definition Classes
    WebSocketController
  29. def ws(frameFormatter: FrameFormatter[Message]): WebSocket[Message, Message]

    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
  30. def ws2(frameFormatter: FrameFormatter[Message]): WebSocket[Message, Message]

    Permalink

    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.

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

    Permalink
    Definition Classes
    WebSocketControllerWebSocketBase

Inherited from WebSocketController

Inherited from Log

Inherited from WebSocketBase

Inherited from AnyRef

Inherited from Any

Ungrouped