javax.ws.rs.sse

Interface SseEventInput

All Superinterfaces:

AutoCloseable, Closeable

public interface SseEventInput
extends Closeable

Inbound Server-Sent Events stream.

The input stream lets you serially read & consume SSE events as they arrive.

Author:

Marek Potociar (marek.potociar at oracle.com)

Method Summary

Modifier and Type	Method and Description
boolean	isClosed() Check if the chunked input has been closed.
InboundSseEvent	read() Read next SSE event from the response stream and convert it to a Java instance of InboundSseEvent type.

Methods inherited from interface java.io.Closeable

close

Method Detail

isClosed

boolean isClosed()

Check if the chunked input has been closed.

Returns:

true if this chunked input has been closed, false otherwise.

read

InboundSseEvent read()
              throws IllegalStateException

Read next SSE event from the response stream and convert it to a Java instance of InboundSseEvent type. The method returns null if the underlying entity input stream has been closed (either implicitly or explicitly by calling the Closeable.close() method).

Note: This operation is not thread-safe and has to be explicitly synchronized in case it is used from multiple threads.

Returns:

next streamed event or null if the underlying entity input stream has been closed while reading the next event data.

Throws:

IllegalStateException - in case this chunked input has been closed.