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

Class SseHeartbeat

java.lang.Object

org.apache.juneau.rest.server.sse.SseHeartbeat

All Implemented Interfaces:

AutoCloseable, Runnable

public class SseHeartbeat
extends Object
implements Runnable, AutoCloseable

Scheduled SSE heartbeat.

Constructor Summary

Constructors

Constructor	Description
SseHeartbeat(Writer writer)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
void	run()
static SseHeartbeat	start(ScheduledExecutorService scheduler, Writer writer, Duration interval)	Starts a heartbeat.

Methods inherited from class java.lang.Object

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

Constructor Details

SseHeartbeat

public SseHeartbeat(Writer writer)

Constructor.

Parameters:

writer - The writer. Must not be null.

Method Details

start

public static SseHeartbeat start(ScheduledExecutorService scheduler,
 Writer writer,
 Duration interval)

Starts a heartbeat.

Parameters:

scheduler - The scheduler. Must not be null.

writer - The writer. Must not be null.

interval - The heartbeat interval. Must not be null.

Returns:

The heartbeat handle.

run

public void run()

Specified by:

run in interface Runnable

close

public void close()

Specified by:

close in interface AutoCloseable