javax.ws.rs.sse

Interface SseEventOutput

All Superinterfaces:

AutoCloseable, Closeable

public interface SseEventOutput
extends Closeable

Outbound Server-Sent Events stream. When returned from resource method, the underlying client connection is kept open and the application code is able to send events. A server-side instance implementing the interface corresponds exactly to a single client HTTP connection.

Since:

2.1

Author:

Marek Potociar (marek.potociar at oracle.com)

Method Summary

Modifier and Type	Method and Description
boolean	isClosed() Check if the stream has been closed already.
void	write(OutboundSseEvent event) Write a new outbound SSE event.

Methods inherited from interface java.io.Closeable

close

Method Detail

write

void write(OutboundSseEvent event)
    throws IOException

Write a new outbound SSE event.

Parameters:

event - an outbound SSE event instance to be written.

Throws:

IOException - if this response is closed or when encountered any problem during serializing or writing a chunk.

isClosed

boolean isClosed()

Check if the stream has been closed already. Please note that the client connection represented by this SseEventOutput can be closed by the client side when a client decides to close connection and disconnect from the server.

Returns:

true when closed, false otherwise.