Package org.jboss.resteasy.plugins.providers.sse

Class SseEventOutputImpl

java.lang.Object

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

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

All Implemented Interfaces:

SseEventSink, AutoCloseable

public class SseEventOutputImpl
extends GenericType<OutboundSseEvent>
implements SseEventSink

Constructor Summary

Constructors

Constructor	Description
SseEventOutputImpl(MessageBodyWriter<OutboundSseEvent> writer)	Deprecated.
SseEventOutputImpl(MessageBodyWriter<OutboundSseEvent> writer, ResteasyProviderFactory providerFactory)

Method Summary

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

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

forInstance, getRawType, getType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SseEventOutputImpl

@Deprecated
public SseEventOutputImpl(MessageBodyWriter<OutboundSseEvent> writer)

Deprecated.

SseEventOutputImpl

public SseEventOutputImpl(MessageBodyWriter<OutboundSseEvent> writer,
                          ResteasyProviderFactory providerFactory)

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

close

@Deprecated
protected void close(boolean flushBeforeClose)

Deprecated.

clearContextData

public void clearContextData()

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

@Deprecated
protected CompletionStage<Void> writeEvent(OutboundSseEvent event)

Deprecated.

equals

public boolean equals(Object o)

Overrides:

equals in class GenericType<OutboundSseEvent>

hashCode

public int hashCode()

Overrides:

hashCode in class GenericType<OutboundSseEvent>