com.mle.play.ws.WebSocketBase.scala Maven / Gradle / Ivy

Go to download
package com.mle.play.ws

import play.api.mvc.RequestHeader
import play.api.libs.iteratee.Concurrent

/**
 * @author Michael
 */
trait WebSocketBase {
  type Message
  type Client

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

  def wsUrl(implicit request: RequestHeader): String

  /**
   * Called when the client sends a message to the server.
   *
   * @param msg the message
   * @param client the client that sent the message
   */
  def onMessage(msg: Message, client: Client) {}

  /**
   * Called when a client has connected.
   *
   * @param client the client channel, can be used to push messages to the client
   */
  def onConnect(client: Client)

  /**
   * Called when a client has disconnected.
   *
   * @param client the disconnected client channel
   */
  def onDisconnect(client: Client)
}