play.libs
Class Comet

java.lang.Object
  play.mvc.Results.Chunks<java.lang.String>
      play.libs.Comet

public abstract class Comet
extends Results.Chunks<java.lang.String>

A Chunked stream sending Comet messages.

Comet

public Comet(java.lang.String callbackMethod)

Create a new Comet socket

Parameters:

callbackMethod - The Javascript callback method to call on each message.

onReady

public void onReady(Results.Chunks.Out<java.lang.String> out)

Description copied from class: Results.Chunks

Called when the Chunked stream is ready.

Specified by:

onReady in class Results.Chunks<java.lang.String>

Parameters:

out - The out stream.

initialBuffer

protected java.lang.String initialBuffer()

Initial chunk of data to send for browser compatibility (default to send 5Kb of blank data).

sendMessage

public void sendMessage(java.lang.String message)

Send a message on this socket (will be received as String in the Javascript callback method).

sendMessage

public void sendMessage(org.codehaus.jackson.JsonNode message)

Send a Json message on this socket (will be received as Json in the Javascript callback method).

onConnected

public abstract void onConnected()

The socket is ready, you can start sending messages.

onDisconnected

public void onDisconnected(F.Callback0 callback)

Add a callback to be notified when the client has disconnected.

close

public void close()

Close the channel