Module SimpleHttpServer

Package dev.katsute.simplehttpserver.handler

Class SSEHandler

java.lang.Object

dev.katsute.simplehttpserver.handler.SSEHandler

All Implemented Interfaces:

HttpHandler, SimpleHttpHandler

public class SSEHandler
extends Object
implements SimpleHttpHandler

A Server sent events (SSE) handler sends events from the server to a client using an text/event-stream. Events are sent using push(String) or push(String, int, String).

Since:

5.0.0

Version:

5.0.0

Author:

Katsute

Constructor Summary

Constructors

Constructor	Description
SSEHandler()	Creates a SSE handler.

Method Summary

Modifier and Type	Method	Description
final void	handle(HttpExchange exchange)	Do not override this method, it will cause SimpleHttpHandler.handle(SimpleHttpExchange) to not work.
final void	handle(SimpleHttpExchange exchange)	Handles an exchange.
final void	push(String data)	Pushes an event to the stream.
final void	push(String data, int retry, String event)	Pushes an event to the stream
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SSEHandler

public SSEHandler()

Creates a SSE handler.

Since:

5.0.0

Method Details

handle

public final void handle(HttpExchange exchange)
                  throws IOException

Description copied from interface: SimpleHttpHandler

Do not override this method, it will cause SimpleHttpHandler.handle(SimpleHttpExchange) to not work. Use SimpleHttpHandler.handle(SimpleHttpExchange) instead.

Specified by:

handle in interface HttpHandler

Specified by:

handle in interface SimpleHttpHandler

Parameters:

exchange - the exchange containing the request from the client and used to send the response

Throws:

IOException - IO exception

See Also:

• SimpleHttpHandler.handle(SimpleHttpExchange)

handle

public final void handle(SimpleHttpExchange exchange)
                  throws IOException

Description copied from interface: SimpleHttpHandler

Handles an exchange.
Http handlers will not throw an exception in the main thread, you must use a try-catch to expose them. All requests must be closed with HttpExchange.close(), otherwise the handler will rerun the request multiple times.

Specified by:

handle in interface SimpleHttpHandler

Parameters:

exchange - http exchange

Throws:

IOException - IO exception

See Also:

• SimpleHttpExchange

push

public final void push(String data)

Pushes an event to the stream.

Parameters:

data - data to send

Since:

5.0.0

See Also:

• push(String, int, String)

push

public final void push(String data,
 int retry,
 String event)

Pushes an event to the stream

Parameters:

data - data to send

retry - how long to retry for

event - event type

Since:

5.0.0

See Also:

• push(String)

toString

public String toString()

Overrides:

toString in class Object