Interface ServerSentEventServer

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DefaultServerSentEventServer

public interface ServerSentEventServer
extends AutoCloseable

A special HTTP server whose only purpose is to provide Server-Sent Event functionality.

A Soklet application which supports Server-Sent Events will be configured with both a Server and a ServerSentEventServer.

See https://www.soklet.com/docs/server-sent-events for detailed documentation.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ServerSentEventServer.RequestHandler	Request/response processing contract for ServerSentEventServer implementations.

Method Summary

Modifier and Type	Method	Description
Optional<? extends ServerSentEventBroadcaster>	acquireBroadcaster(ResourcePath resourcePath)	Given a ResourcePath that corresponds to a Resource Method annotated with ServerSentEventSource, acquire a ServerSentEventBroadcaster which is capable of "pushing" messages to all connected Server-Sent Event clients.
default void	close()	AutoCloseable-enabled synonym for stop().
void	initialize(SokletConfiguration sokletConfiguration, ServerSentEventServer.RequestHandler requestHandler)	The Soklet instance which manages this ServerSentEventServer will invoke this method exactly once at initialization time - this allows Soklet to "talk" to your ServerSentEventServer.
Boolean	isStarted()	Is this SSE server started (that is, able to handle requests from clients)?
void	start()	Starts the SSE server, which makes it able to accept requests from clients.
void	stop()	Stops the SSE server, which makes it unable to accept requests from clients.

Method Details

start

void start()

Starts the SSE server, which makes it able to accept requests from clients.

If the server is already started, no action is taken.

This method is designed for internal use by Soklet only and should not be invoked elsewhere.

stop

void stop()

Stops the SSE server, which makes it unable to accept requests from clients.

If the server is already stopped, no action is taken.

This method is designed for internal use by Soklet only and should not be invoked elsewhere.

isStarted

@Nonnull
Boolean isStarted()

Is this SSE server started (that is, able to handle requests from clients)?

Returns:

true if the server is started, false otherwise

close

default void close()
            throws Exception

AutoCloseable-enabled synonym for stop().

This method is designed for internal use by Soklet only and should not be invoked elsewhere.

Specified by:

close in interface AutoCloseable

Throws:

Exception - if an exception occurs while stopping the server

acquireBroadcaster

@Nonnull
Optional<? extends ServerSentEventBroadcaster> acquireBroadcaster(@Nullable
 ResourcePath resourcePath)

Given a ResourcePath that corresponds to a Resource Method annotated with ServerSentEventSource, acquire a ServerSentEventBroadcaster which is capable of "pushing" messages to all connected Server-Sent Event clients.

Soklet guarantees exactly one ServerSentEventBroadcaster instance exists per ResourcePath. Soklet is responsible for the creation and management of ServerSentEventBroadcaster instances.

See https://www.soklet.com/docs/server-sent-events for detailed documentation.

Parameters:

resourcePath - the ServerSentEventSource-annotated Resource Method for which to acquire a broadcaster

Returns:

a broadcaster for the given ResourcePath, or Optional.empty() if there is no broadcaster available

initialize

void initialize(@Nonnull
 SokletConfiguration sokletConfiguration,
 @Nonnull
 ServerSentEventServer.RequestHandler requestHandler)

The Soklet instance which manages this ServerSentEventServer will invoke this method exactly once at initialization time - this allows Soklet to "talk" to your ServerSentEventServer.

This method is designed for internal use by Soklet only and should not be invoked elsewhere.

Parameters:

sokletConfiguration - configuration for the Soklet instance that controls this server

requestHandler - a Soklet-internal request handler which takes a ServerSentEventServer-provided request as input and supplies a MarshaledResponse as output for the ServerSentEventServer to write back to the client