play.libs

Class EventSource

java.lang.Object

play.libs.EventSource

public class EventSource
extends java.lang.Object

This class provides an easy way to use Server Sent Events (SSE) as a chunked encoding, using an Akka Source.

Please see the Server-Sent Events specification for details.

Example implementation of EventSource in a Controller:

{{{ //import akka.stream.javadsl.Source; //import play.mvc.*; //import play.libs.*; //import java.time.ZonedDateTime; //import java.time.format.*; //import scala.concurrent.duration.Duration; //import static java.util.concurrent.TimeUnit.*; //import static play.libs.EventSource.Event.event; //private final DateTimeFormatter df = DateTimeFormatter.ofPattern("HH mm ss");

public Result liveClock() { Source<String, ?> tickSource = Source.tick(Duration.Zero(), Duration.create(100, MILLISECONDS), "TICK"); Source<EventSource.Event, ?> eventSource = tickSource.map((tick) -> EventSource.Event.event(df.format(ZonedDateTime.now()))); return ok().chunked(eventSource.via(EventSource.flow())).as(Http.MimeTypes.EVENT_STREAM); } }}}

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
EventSource()

Method Summary

Modifier and Type	Method and Description
static akka.stream.javadsl.Flow<EventSource.Event,akka.util.ByteString,?>	flow()

Methods inherited from class java.lang.Object

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

Constructor Detail

EventSource

public EventSource()

Method Detail

flow

public static akka.stream.javadsl.Flow<EventSource.Event,akka.util.ByteString,?> flow()

Returns:

a flow of EventSource.Event to ByteString.