• Home
• com.github.malliina
• util-play_2.11
• 1.9.0
• source code
• WebSocketBase.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

package com.mle.play.ws

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

/**
 * @author Michael
 */
trait WebSocketBase {
  type Message
  type Client <: SocketClient[Message]
  type AuthSuccess

  def clients: Seq[Client]

  def newClient(authResult: AuthSuccess, 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
   * @return true if the message was handled, false otherwise
   */
  def onMessage(msg: Message, client: Client): Boolean = false

  /**
   * Called when a client has been created. Note however that messages cannot yet be sent to the client.
   *
   * @param client the client channel, can be used to push messages to the client
   */
  def onConnect(client: Client): Unit

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

  def broadcast(message: Message): Unit
}