Package org.apache.juneau.rest.server.sse

Class SseResponseSupport

java.lang.Object

org.apache.juneau.rest.server.sse.SseResponseSupport

All Implemented Interfaces:

AutoCloseable

public class SseResponseSupport
extends Object
implements AutoCloseable

Fluent SSE response helper.

Constructor Summary

Constructors

Constructor	Description
SseResponseSupport(RestResponse response)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
SseResponseSupport	comment(String value)	Sends a heartbeat/comment line.
SseResponseSupport	flush()	Flushes pending output.
SseResponseSupport	heartbeat(Duration interval)	Starts periodic heartbeat comments.
SseResponseSupport	sendEvent(String name, Object data)	Sends an SSE event from name+data values.
SseResponseSupport	sendEvent(SseEvent event)	Sends an SSE event.
SseResponseSupport	sendFrom(SseSubscription subscription)	Drains a subscription until disconnect or interruption.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SseResponseSupport

public SseResponseSupport(RestResponse response)
                   throws IOException

Constructor.

Parameters:

response - The REST response. Must not be null.

Throws:

IOException - If the writer could not be created.

Method Details

heartbeat

public SseResponseSupport heartbeat(Duration interval)

Starts periodic heartbeat comments.

Parameters:

interval - The heartbeat interval.

Returns:

This object.

sendEvent

public SseResponseSupport sendEvent(SseEvent event)
                             throws IOException

Sends an SSE event.

Parameters:

event - The event.

Returns:

This object.

Throws:

IOException - If an I/O error occurred.

sendEvent

public SseResponseSupport sendEvent(String name,
 Object data)
                             throws IOException

Sends an SSE event from name+data values.

Parameters:

name - The event name. Can be null (dispatches as the default event type).

data - The event data. Can be null (no data lines emitted).

Returns:

This object.

Throws:

IOException - If an I/O error occurred.

comment

public SseResponseSupport comment(String value)
                           throws IOException

Sends a heartbeat/comment line.

Parameters:

value - The comment value. Can be null (treated as an empty comment).

Returns:

This object.

Throws:

IOException - If an I/O error occurred.

flush

public SseResponseSupport flush()
                         throws IOException

Flushes pending output.

Returns:

This object.

Throws:

IOException - If an I/O error occurred.

sendFrom

public SseResponseSupport sendFrom(SseSubscription subscription)
                            throws IOException

Drains a subscription until disconnect or interruption.

Parameters:

subscription - The subscription. Must not be null.

Returns:

This object.

Throws:

IOException - If an I/O error occurred.

close

public void close()

Specified by:

close in interface AutoCloseable