play.libs

Class LegacyEventSource

java.lang.Object

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

play.libs.LegacyEventSource

Deprecated.

@Deprecated
public abstract class LegacyEventSource
extends Results.Chunks<java.lang.String>

This class is deprecated. Please use play.libs.EventSource with an Akka Source.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LegacyEventSource.Event Deprecated. 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
LegacyEventSource() Deprecated. Create a new LegacyEventSource socket

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyEventSource

public LegacyEventSource()

Deprecated.

Create a new LegacyEventSource socket

Method Detail

onReady

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.

send

public void send(LegacyEventSource.Event event)

Deprecated.

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()

Deprecated.

The socket is ready, you can start sending messages.

onDisconnected

public void onDisconnected(java.lang.Runnable callback)

Deprecated.

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

close

public void close()

Deprecated.

Close the channel

whenConnected

public static LegacyEventSource whenConnected(java.util.function.Consumer<LegacyEventSource> callback)

Deprecated.

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

Parameters:

callback - the callback used to implement onConnected

Returns:

a new LegacyEventSource

Throws:

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