play.libs

Class EventSource

java.lang.Object

play.mvc.Results.Chunks<java.lang.String>

play.libs.EventSource

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

Implementation of Server-Sent Events.

See Also:

Server-Sent Events specification

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventSource.Event Utility class to build events.

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

Results.Chunks.Out<A>

Constructor Summary

Constructors

Constructor and Description
EventSource() Create a new EventSource socket

Method Summary

Modifier and Type	Method and Description
void	close() Close the channel
abstract void	onConnected() The socket is ready, you can start sending messages.
void	onDisconnected(F.Callback0 callback) Add a callback to be notified when the client has disconnected.
void	onReady(Results.Chunks.Out<java.lang.String> out) Called when the Chunked stream is ready.
void	send(EventSource.Event event) Send an event.
static EventSource	whenConnected(F.Callback<EventSource> callback) Creates an EventSource.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventSource

public EventSource()

Create a new EventSource socket

Method Detail

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.

send

public void send(EventSource.Event event)

Send an event. On the client, a 'message' event listener can be setup to listen to this event.

Parameters:

event - Event content

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

whenConnected

public static EventSource whenConnected(F.Callback<EventSource> callback)

Creates an EventSource. The abstract onConnected method is implemented using the specified F.Callback<EventSource> and is invoked with EventSource.this.

Parameters:

callback - the callback used to implement onConnected

Returns:

a new EventSource

Throws:

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