javax.ws.rs.sse

Interface SseBroadcaster

All Superinterfaces:

AutoCloseable

public interface SseBroadcaster
extends AutoCloseable

Server-Sent Events broadcasting facility.

TODO: more javadoc.

Since:

2.1

Author:

Marek Potociar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SseBroadcaster.Listener Listener interface that can be implemented to listen to events fired by SseBroadcaster object.

Method Summary

Modifier and Type	Method and Description
void	broadcast(OutboundSseEvent event) Broadcast an SSE event to all registered SseEventOutput instances.
void	close() Close all registered SseEventOutput instances.
boolean	register(SseBroadcaster.Listener listener) Register SseBroadcaster.Listener that will receive SseBroadcaster lifecycle events.
boolean	register(SseEventOutput output) Register SseEventOutput to this SseBroadcaster instance.

Method Detail

register

boolean register(SseBroadcaster.Listener listener)

Register SseBroadcaster.Listener that will receive SseBroadcaster lifecycle events.

This operation is potentially slow, especially if large number of listeners get registered in the broadcaster. The Broadcaster implementation is optimized to efficiently handle small amounts of concurrent listener registrations and removals and large amounts of registered listener notifications.

Parameters:

listener - listener to be registered.

Returns:

true if registered, false otherwise.

register

boolean register(SseEventOutput output)

Register SseEventOutput to this SseBroadcaster instance.

Parameters:

output - SseEventOutput to register.

Returns:

true if the instance was successfully registered, false otherwise.

broadcast

void broadcast(OutboundSseEvent event)

Broadcast an SSE event to all registered SseEventOutput instances.

Parameters:

event - SSE event to be broadcast.

close

void close()

Close all registered SseEventOutput instances.

Specified by:

close in interface AutoCloseable