Class WebsocketEndpoint

java.lang.Object

io.fluxzero.testserver.websocket.WebsocketEndpoint

Direct Known Subclasses:

ConsumerEndpoint, EventSourcingEndpoint, KeyValueEndPoint, ProducerEndpoint, SchedulingEndpoint, SearchEndpoint

public abstract class WebsocketEndpoint
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	WebsocketEndpoint.ClientMessage
protected static class	WebsocketEndpoint.PingRegistration
protected static class	WebsocketEndpoint.SessionBacklog

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	ESTIMATED_RESULT_OVERHEAD_BYTES
protected static Duration	pingDelay
protected static Duration	pingTimeout
protected boolean	shutDown
protected final AtomicBoolean	shuttingDown
protected static Duration	webSocketSendTimeout

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebsocketEndpoint()
protected	WebsocketEndpoint(CommandIdempotencyStore commandIdempotencyStore)
protected	WebsocketEndpoint(Executor requestExecutor)
protected	WebsocketEndpoint(Executor requestExecutor, CommandIdempotencyStore commandIdempotencyStore)

Method Summary

Modifier and Type	Method	Description
protected void	abort(ServerWebsocketSession session, String reason)
protected Stream<Runnable>	createTasks(io.fluxzero.common.api.RequestBatch<?> batch, ServerWebsocketSession session)
protected Stream<Runnable>	createTasks(io.fluxzero.common.api.RequestBatch<?> batch, ServerWebsocketSession session, long requestReceivedTimestamp)
protected io.fluxzero.common.api.JsonType	deserializeRequest(ServerWebsocketSession session, byte[] bytes)
protected void	dispatchRequest(ServerWebsocketSession session, io.fluxzero.common.api.JsonType request)
protected void	dispatchRequest(ServerWebsocketSession session, io.fluxzero.common.api.JsonType request, long requestReceivedTimestamp)
protected void	doSendResult(ServerWebsocketSession session, io.fluxzero.common.api.RequestResult result)
protected int	estimateRequestResultBytes(io.fluxzero.common.api.RequestResult result)	Estimates one endpoint-specific request result for websocket batch sizing.
protected static int	estimateStringBytes(String value)
protected Optional<WebsocketEndpoint.SessionBacklog>	findAlternativeBacklog(ServerWebsocketSession closedSession)
protected String	getClientId(ServerWebsocketSession session)
protected String	getClientName(ServerWebsocketSession session)
protected String	getClientSdkVersion(ServerWebsocketSession session)
protected io.fluxzero.common.serialization.compression.CompressionAlgorithm	getCompressionAlgorithm(ServerWebsocketSession session)
protected String	getNamespace(ServerWebsocketSession session)
protected String	getNegotiatedSessionId(ServerWebsocketSession session)
protected Map<String, List<String>>	getRequestHeaders(ServerWebsocketSession session)
protected String	getRuntimeVersion()
protected io.fluxzero.common.websocket.WebSocketTransportFormat	getTransportFormat(ServerWebsocketSession session)
protected void	handleMessage(ServerWebsocketSession session, io.fluxzero.common.api.JsonType message)
protected void	handleMessage(ServerWebsocketSession session, io.fluxzero.common.api.JsonType message, long requestReceivedTimestamp)
protected boolean	isSessionActive(String sessionId)	Returns whether this endpoint still owns the session's request lifecycle.
protected ExecutorService[]	newRequestStripeExecutors(int stripes)
void	onClose(ServerWebsocketSession session, io.fluxzero.sdk.common.websocket.WebsocketCloseReason closeReason)
void	onError(ServerWebsocketSession session, Throwable e)
void	onMessage(byte[] bytes, ServerWebsocketSession session)
void	onOpen(ServerWebsocketSession session)
void	onPong(ByteBuffer message, ServerWebsocketSession session)
protected List<? extends io.fluxzero.common.websocket.WebSocketPayloadCodec>	payloadCodecs()	Returns compact payload codecs owned by this concrete endpoint protocol.
protected void	registerMetrics(Object event, ServerWebsocketSession session)
protected WebsocketEndpoint.PingRegistration	schedulePing(ServerWebsocketSession session)
protected void	sendPing(ServerWebsocketSession session)
protected void	sendResultBatch(ServerWebsocketSession session, List<io.fluxzero.common.api.RequestResult> results)
protected CompletableFuture<Void>	sendResultBatchAsync(ServerWebsocketSession session, List<io.fluxzero.common.api.RequestResult> results)
protected io.fluxzero.common.api.Metadata	sessionMetadata(ServerWebsocketSession session)
protected boolean	shouldHandleIdempotently(io.fluxzero.common.api.Command command)
protected void	shutDown()	Close all sessions on the websocket after an optional delay.
protected boolean	submitRequestTask(ServerWebsocketSession session, io.fluxzero.common.api.JsonType request, Runnable task)
protected io.fluxzero.common.websocket.WebSocketTransportCodec	transportCodec(ServerWebsocketSession session)

Methods inherited from class Object

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

Field Details

ESTIMATED_RESULT_OVERHEAD_BYTES

protected static final int ESTIMATED_RESULT_OVERHEAD_BYTES

See Also:

• Constant Field Values

webSocketSendTimeout

protected static Duration webSocketSendTimeout

pingTimeout

protected static Duration pingTimeout

pingDelay

protected static Duration pingDelay

shuttingDown

protected final AtomicBoolean shuttingDown

shutDown

protected volatile boolean shutDown

Constructor Details

WebsocketEndpoint

protected WebsocketEndpoint()

WebsocketEndpoint

protected WebsocketEndpoint(CommandIdempotencyStore commandIdempotencyStore)

WebsocketEndpoint

protected WebsocketEndpoint(Executor requestExecutor)

WebsocketEndpoint

protected WebsocketEndpoint(Executor requestExecutor,
 CommandIdempotencyStore commandIdempotencyStore)

Method Details

onOpen

public void onOpen(ServerWebsocketSession session)

deserializeRequest

protected io.fluxzero.common.api.JsonType deserializeRequest(ServerWebsocketSession session,
 byte[] bytes)
                                                      throws IOException

Throws:

IOException

onMessage

public void onMessage(byte[] bytes,
 ServerWebsocketSession session)

dispatchRequest

protected void dispatchRequest(ServerWebsocketSession session,
 io.fluxzero.common.api.JsonType request)

dispatchRequest

protected void dispatchRequest(ServerWebsocketSession session,
 io.fluxzero.common.api.JsonType request,
 long requestReceivedTimestamp)

shouldHandleIdempotently

protected boolean shouldHandleIdempotently(io.fluxzero.common.api.Command command)

submitRequestTask

protected boolean submitRequestTask(ServerWebsocketSession session,
 io.fluxzero.common.api.JsonType request,
 Runnable task)

isSessionActive

protected boolean isSessionActive(String sessionId)

Returns whether this endpoint still owns the session's request lifecycle.

handleMessage

protected void handleMessage(ServerWebsocketSession session,
 io.fluxzero.common.api.JsonType message)

handleMessage

protected void handleMessage(ServerWebsocketSession session,
 io.fluxzero.common.api.JsonType message,
 long requestReceivedTimestamp)

doSendResult

protected void doSendResult(ServerWebsocketSession session,
 io.fluxzero.common.api.RequestResult result)

createTasks

protected Stream<Runnable> createTasks(io.fluxzero.common.api.RequestBatch<?> batch,
 ServerWebsocketSession session)

createTasks

protected Stream<Runnable> createTasks(io.fluxzero.common.api.RequestBatch<?> batch,
 ServerWebsocketSession session,
 long requestReceivedTimestamp)

sendResultBatch

protected void sendResultBatch(ServerWebsocketSession session,
 List<io.fluxzero.common.api.RequestResult> results)

sendResultBatchAsync

protected CompletableFuture<Void> sendResultBatchAsync(ServerWebsocketSession session,
 List<io.fluxzero.common.api.RequestResult> results)

estimateRequestResultBytes

protected int estimateRequestResultBytes(io.fluxzero.common.api.RequestResult result)

Estimates one endpoint-specific request result for websocket batch sizing.

estimateStringBytes

protected static int estimateStringBytes(String value)

findAlternativeBacklog

protected Optional<WebsocketEndpoint.SessionBacklog> findAlternativeBacklog(ServerWebsocketSession closedSession)

schedulePing

protected WebsocketEndpoint.PingRegistration schedulePing(ServerWebsocketSession session)

sendPing

protected void sendPing(ServerWebsocketSession session)

onPong

public void onPong(ByteBuffer message,
 ServerWebsocketSession session)

abort

protected void abort(ServerWebsocketSession session,
 String reason)

onClose

public void onClose(ServerWebsocketSession session,
 io.fluxzero.sdk.common.websocket.WebsocketCloseReason closeReason)

onError

public void onError(ServerWebsocketSession session,
 Throwable e)

shutDown

protected void shutDown()

Close all sessions on the websocket after an optional delay. During the delay we don't handle new requests but will be able to send back results.

newRequestStripeExecutors

protected ExecutorService[] newRequestStripeExecutors(int stripes)

getCompressionAlgorithm

protected io.fluxzero.common.serialization.compression.CompressionAlgorithm getCompressionAlgorithm(ServerWebsocketSession session)

getTransportFormat

protected io.fluxzero.common.websocket.WebSocketTransportFormat getTransportFormat(ServerWebsocketSession session)

transportCodec

protected io.fluxzero.common.websocket.WebSocketTransportCodec transportCodec(ServerWebsocketSession session)

payloadCodecs

protected List<? extends io.fluxzero.common.websocket.WebSocketPayloadCodec> payloadCodecs()

Returns compact payload codecs owned by this concrete endpoint protocol.

getRequestHeaders

protected Map<String, List<String>> getRequestHeaders(ServerWebsocketSession session)

getNamespace

protected String getNamespace(ServerWebsocketSession session)

getClientId

protected String getClientId(ServerWebsocketSession session)

getClientName

protected String getClientName(ServerWebsocketSession session)

getClientSdkVersion

protected String getClientSdkVersion(ServerWebsocketSession session)

getRuntimeVersion

protected String getRuntimeVersion()

getNegotiatedSessionId

protected String getNegotiatedSessionId(ServerWebsocketSession session)

registerMetrics

protected void registerMetrics(Object event,
 ServerWebsocketSession session)

sessionMetadata

protected io.fluxzero.common.api.Metadata sessionMetadata(ServerWebsocketSession session)