public interface SseEventSink
extends java.lang.AutoCloseable
The instance of SseEventSink can be only acquired by injection of a resource method parameter:
@GET
@Path("eventStream")
@Produces(MediaType.SERVER_SENT_EVENTS)
public void eventStream(@Context SseEventSink eventSink) {
// ...
}
The injected instance is then considered as a return type, so the resource method doesn't return anything,
similarly as in server-side async processing.
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.
The injected instance is thread safe.
| Modifier and Type | Method and Description |
|---|---|
void |
close()
Close the
SseEventSink instance and release all associated resources. |
boolean |
isClosed()
Check if the stream has been closed already.
|
java.util.concurrent.CompletionStage<?> |
send(OutboundSseEvent event)
Send an outbound Server-sent event to this sink.
|
boolean isClosed()
Please note that the client connection represented by this SseServerSink can be closed by the
client side when a client decides to close connection and disconnect from the server.
true when closed, false otherwise.java.util.concurrent.CompletionStage<?> send(OutboundSseEvent event)
Event will be serialized and sent to the client.
event - event to be written.void close()
SseEventSink instance and release all associated resources.
Subsequent calls have no effect and are ignored. Once the SseEventSink is closed,
invoking any method other than this one and isClosed() would result in
an IllegalStateException being thrown.
close in interface java.lang.AutoCloseable