one.nio.http

Interface EventSource<D>

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

EventSourceResponse

public interface EventSource<D>
extends java.io.Closeable

A source of server side emitted events

See Also:

HTML Standard: 9.2 Server-sent events, HttpClient.openEvents(Request, int)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EventSource.Event<D> A single Server Sent Event, received from peer.

Method Summary

Modifier and Type	Method and Description
EventSource.Event<D>	poll() Waits for the next SSE and returns an event.

Methods inherited from interface java.io.Closeable

close

Method Detail

poll

EventSource.Event<D> poll()
                   throws java.io.IOException,
                          HttpException

Waits for the next SSE and returns an event. The method can block for a long time ( determined by server ). It is essential to check for null and EventSource.Event.isEmpty() before processing

Returns:

the next event from the stream or null, if stream was closed by either party

Throws:

java.io.IOException - an I/O exception occurred

HttpException - an incorrect HTTP request received