org.jboss.resteasy.plugins.providers.sse

Class SseEventOutputImpl

java.lang.Object

javax.ws.rs.core.GenericType<OutboundSseEvent>

org.jboss.resteasy.plugins.providers.sse.SseEventOutputImpl

All Implemented Interfaces:

AutoCloseable, SseEventSink

public class SseEventOutputImpl
extends GenericType<OutboundSseEvent>
implements SseEventSink

Constructor Summary

Constructors

Constructor and Description
SseEventOutputImpl(MessageBodyWriter<OutboundSseEvent> writer)

Method Summary

Modifier and Type	Method and Description
void	close() Close the SseEventSink instance and release all associated resources.
protected void	flushResponseToClient()
boolean	isClosed() Check if the stream has been closed already.
CompletionStage<?>	send(OutboundSseEvent event) Send an outbound Server-sent event to this sink.
protected void	writeEvent(OutboundSseEvent event)

Methods inherited from class javax.ws.rs.core.GenericType

equals, forInstance, getRawType, getType, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SseEventOutputImpl

public SseEventOutputImpl(MessageBodyWriter<OutboundSseEvent> writer)

Method Detail

close

public void close()

Description copied from interface: SseEventSink

Close the 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 SseEventSink.isClosed() would result in an IllegalStateException being thrown.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SseEventSink

flushResponseToClient

protected void flushResponseToClient()

isClosed

public boolean isClosed()

Description copied from interface: SseEventSink

Check if the stream has been closed already.

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.

Specified by:

isClosed in interface SseEventSink

Returns:

true when closed, false otherwise.

send

public CompletionStage<?> send(OutboundSseEvent event)

Description copied from interface: SseEventSink

Send an outbound Server-sent event to this sink.

Event will be serialized and sent to the client.

Specified by:

send in interface SseEventSink

Parameters:

event - event to be written.

Returns:

completion stage that completes when the event has been sent. If there is a problem during sending of an event, completion stage will be completed exceptionally.

writeEvent

protected void writeEvent(OutboundSseEvent event)
                   throws IOException

Throws:

IOException