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>

Provides an easy way to use a Comet formatted output with Akka Streams. There are two methods that can be used to convert strings and JSON, Comet.string and Comet.json. These methods build on top of the base method, Comet.flow, which takes a Flow of akka.util.ByteString and organizes it into Comet format.

   public Result liveClock() {
        final DateTimeFormatter df = DateTimeFormatter.ofPattern("HH mm ss");
        final Source tickSource = Source.tick(Duration.Zero(), Duration.create(100, MILLISECONDS), "TICK");
        final Source eventSource = tickSource.map((tick) -> df.format(ZonedDateTime.now()));

        final Source<ByteString, NotUsed> flow = eventSource.via(Comet.string("parent.clockChanged"));
        return ok().chunked(flow).as(Http.MimeTypes.HTML);
   }
 

Nested Class Summary

Nested classes/interfaces inherited from class play.mvc.Results.Chunks

Results.Chunks.Out<A>

Constructor Summary

Constructors

Constructor and Description
Comet(java.lang.String callbackMethod) Deprecated. Please use Comet.string or Comet.json, since 2.5.x

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated.
static akka.stream.javadsl.Flow<akka.util.ByteString,akka.util.ByteString,akka.NotUsed>	flow(java.lang.String callbackName) Produces a flow of ByteString with a prepended block and a script wrapper.
protected java.lang.String	initialBuffer() Deprecated.
static akka.stream.javadsl.Flow<com.fasterxml.jackson.databind.JsonNode,akka.util.ByteString,akka.NotUsed>	json(java.lang.String callbackName) Produces a flow of ByteString using `Json.stringify` from a Flow of JsonNode.
abstract void	onConnected() Deprecated.
void	onDisconnected(java.lang.Runnable callback) Deprecated.
void	onReady(Results.Chunks.Out<java.lang.String> out) Deprecated.
void	sendMessage(com.fasterxml.jackson.databind.JsonNode message) Deprecated.
void	sendMessage(java.lang.String message) Deprecated.
static akka.stream.javadsl.Flow<java.lang.String,akka.util.ByteString,akka.NotUsed>	string(java.lang.String callbackName) Produces a Flow of escaped ByteString from a series of String elements.
static Comet	whenConnected(java.lang.String jsMethod, java.util.function.Consumer<Comet> callback) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Comet

@Deprecated
public Comet(java.lang.String callbackMethod)

Deprecated. Please use Comet.string or Comet.json, since 2.5.x

Create a new Comet socket.

Parameters:

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

Method Detail

string

public static akka.stream.javadsl.Flow<java.lang.String,akka.util.ByteString,akka.NotUsed> string(java.lang.String callbackName)

Produces a Flow of escaped ByteString from a series of String elements. Calls out to Comet.flow internally.

Parameters:

callbackName - the javascript callback method.

Returns:

a flow of ByteString elements.

json

public static akka.stream.javadsl.Flow<com.fasterxml.jackson.databind.JsonNode,akka.util.ByteString,akka.NotUsed> json(java.lang.String callbackName)

Produces a flow of ByteString using `Json.stringify` from a Flow of JsonNode. Calls out to Comet.flow internally.

Parameters:

callbackName - the javascript callback method.

Returns:

a flow of ByteString elements.

flow

public static akka.stream.javadsl.Flow<akka.util.ByteString,akka.util.ByteString,akka.NotUsed> flow(java.lang.String callbackName)

Produces a flow of ByteString with a prepended block and a script wrapper.

Parameters:

callbackName - the javascript callback method.

Returns:

a flow of ByteString elements.

onReady

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

Deprecated.

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

@Deprecated
protected java.lang.String initialBuffer()

Deprecated.

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

sendMessage

@Deprecated
public void sendMessage(java.lang.String message)

Deprecated.

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

sendMessage

@Deprecated
public void sendMessage(com.fasterxml.jackson.databind.JsonNode message)

Deprecated.

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

onConnected

@Deprecated
public abstract void onConnected()

Deprecated.

The socket is ready, you can start sending messages.

onDisconnected

@Deprecated
public void onDisconnected(java.lang.Runnable callback)

Deprecated.

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

close

@Deprecated
public void close()

Deprecated.

Close the channel

whenConnected

@Deprecated
public static Comet whenConnected(java.lang.String jsMethod,
                                              java.util.function.Consumer<Comet> callback)

Deprecated.

Creates a Comet. The abstract onConnected method is implemented using the specified Callback<Comet> and is invoked with Comet.this.

Parameters:

jsMethod - the Javascript method to call on each message

callback - the callback used to implement onConnected

Returns:

a new Comet

Throws:

java.lang.NullPointerException - if the specified callback is null