Class DefaultServerSentEventServer

java.lang.Object

com.soklet.core.impl.DefaultServerSentEventServer

All Implemented Interfaces:

ServerSentEventServer, AutoCloseable

@ThreadSafe
public class DefaultServerSentEventServer
extends Object
implements ServerSentEventServer

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultServerSentEventServer.Builder	Builder used to construct instances of DefaultServerSentEventServer.

Nested classes/interfaces inherited from interface com.soklet.core.ServerSentEventServer

ServerSentEventServer.RequestHandler

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.
Map<ResourcePathDeclaration,ResourceMethod>	getResourceMethodsByResourcePathDeclaration()
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.
static DefaultServerSentEventServer.Builder	withPort(Integer port)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.soklet.core.ServerSentEventServer

close

Method Details

withPort

@Nonnull
public static DefaultServerSentEventServer.Builder withPort(@Nonnull
 Integer port)

initialize

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

Description copied from interface: ServerSentEventServer

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.

Specified by:

initialize in interface ServerSentEventServer

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

start

public void start()

Description copied from interface: ServerSentEventServer

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.

Specified by:

start in interface ServerSentEventServer

stop

public void stop()

Description copied from interface: ServerSentEventServer

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.

Specified by:

stop in interface ServerSentEventServer

isStarted

@Nonnull
public Boolean isStarted()

Description copied from interface: ServerSentEventServer

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

Specified by:

isStarted in interface ServerSentEventServer

Returns:

true if the server is started, false otherwise

acquireBroadcaster

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

Description copied from interface: ServerSentEventServer

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.

Specified by:

acquireBroadcaster in interface ServerSentEventServer

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

getResourceMethodsByResourcePathDeclaration

@Nonnull
public Map<ResourcePathDeclaration,ResourceMethod> getResourceMethodsByResourcePathDeclaration()