Class WebsocketTrackingClient

java.lang.Object

io.fluxzero.sdk.common.websocket.AbstractWebsocketClient

io.fluxzero.sdk.tracking.client.WebsocketTrackingClient

All Implemented Interfaces:

WebsocketEndpoint, TrackingClient, AutoCloseable

public class WebsocketTrackingClient
extends AbstractWebsocketClient
implements TrackingClient

WebSocket-based implementation of the TrackingClient that connects to the Fluxzero Runtime.

All tracking-related operations—including reading messages, claiming segments, storing/resetting positions, and disconnecting trackers—are performed via a standardized WebSocket protocol with the Fluxzero Runtime.

This is the default production implementation used in deployed applications to track message streams such as commands, queries, events, and other custom message types.

Requires an active WebSocket connection to the Fluxzero Runtime’s tracking service.

See Also:

• WebSocketClient

Nested Class Summary

Nested classes/interfaces inherited from class AbstractWebsocketClient

AbstractWebsocketClient.ClientHandshakeConfigurator, AbstractWebsocketClient.ConnectionSetup, AbstractWebsocketClient.PingRegistration, AbstractWebsocketClient.PreparedRequest<R>, AbstractWebsocketClient.WebSocketRequest

Nested classes/interfaces inherited from interface WebsocketEndpoint

WebsocketEndpoint.ReceiveTiming

Field Summary

Fields inherited from class AbstractWebsocketClient

CLIENT_HANDSHAKE_CONFIGURATOR_USER_PROPERTY, CLIENT_SESSION_ID_USER_PROPERTY, CONNECTION_RETRY_LOG_INTERVAL, CONNECTION_TIMEOUT_FAILSAFE_GRACE, defaultObjectMapper, defaultWebsocketConnector, NEGOTIATED_SESSION_ID_USER_PROPERTY, RUNTIME_SESSION_ID_USER_PROPERTY, RUNTIME_VERSION_USER_PROPERTY, SELECTED_COMPRESSION_ALGORITHM_USER_PROPERTY, SELECTED_TRANSPORT_FORMAT_USER_PROPERTY

Constructor Summary

Constructors

Constructor	Description
WebsocketTrackingClient(String endPointUrl, WebSocketClient client, io.fluxzero.common.MessageType type, String topic)
WebsocketTrackingClient(URI endPointUri, WebSocketClient client, io.fluxzero.common.MessageType type, String topic, boolean sendMetrics)

Method Summary

Modifier and Type	Method	Description
protected io.fluxzero.common.api.Request	adaptRequestForSession(io.fluxzero.common.api.Request request, WebsocketSession session)	Adapts an outgoing request to the selected peer on every attempt, including reconnect replay.
CompletableFuture<io.fluxzero.common.api.tracking.ClaimSegmentResult>	claimSegment(String trackerId, Long lastIndex, ConsumerConfiguration config)	Requests a tracker segment using this client's message type and the consumer's filtering, waiting, and index-control settings; returns the asynchronous claim result.
void	close()	Closes any open resources associated with this client.
CompletableFuture<Void>	disconnectTerminatedTracker(String consumer, String trackerId, io.fluxzero.common.Guarantee guarantee)	Releases a terminated local tracker, including any abandoned asynchronous reads still completing.
CompletableFuture<Void>	disconnectTracker(String consumer, String trackerId, boolean sendFinalEmptyBatch, io.fluxzero.common.Guarantee guarantee)	Disconnects the specified tracker from its segment with the specified delivery guarantee.
io.fluxzero.common.api.tracking.Position	getPosition(String consumer)	Returns the current committed tracking position for the given consumer.
protected io.fluxzero.common.api.RequestResult	localResponseForSession(io.fluxzero.common.api.Request request, WebsocketSession session)	Returns a local response for a peer-specific no-op, or null when the request must be sent.
protected io.fluxzero.common.api.Metadata	metricsMetadata()
protected List<? extends io.fluxzero.common.websocket.WebSocketPayloadCodec>	payloadCodecs()	Returns compact payload codecs owned by this concrete protocol client.
CompletableFuture<io.fluxzero.common.api.tracking.MessageBatch>	read(String trackerId, Long lastIndex, ConsumerConfiguration configuration)	Asynchronously reads the next available MessageBatch for a given tracker.
List<io.fluxzero.common.api.SerializedMessage>	readFromIndex(long minIndex, int maxSize)	Fetches messages starting from the given index up to the provided max size.
List<io.fluxzero.common.api.SerializedMessage>	readFromIndex(long minIndex, int maxSize, long maxBytes)	Fetches messages directly from the message log while limiting both message count and complete serialized bytes.
CompletableFuture<Void>	resetPosition(String consumer, long lastIndex, io.fluxzero.common.Guarantee guarantee)	Resets the consumer's tracking position to a given index with a specific delivery guarantee.
CompletableFuture<Void>	storePosition(String consumer, int[] segment, long lastIndex, io.fluxzero.common.Guarantee guarantee)	Stores the last successfully processed position for a consumer with a specific delivery guarantee.
boolean	supportsConsumerFiltering()	Whether an established peer can filter consumer deliveries.
String	toString()

Methods inherited from class AbstractWebsocketClient

abort, canAwaitShutdownResults, captureReceiveTiming, close, connectToServer, connectToServer, createConnectionRetryConfiguration, createConnectionSetup, createConnectionSetup, getCloseHandshakeTimeout, getCompressionAlgorithm, getConnectionTimeoutFailsafeGrace, getNegotiatedSessionId, getRuntimeVersion, getTransportFormat, handleClose, handleError, handleMessage, handlePong, handleResult, handleResult, jfrResultType, logConnectionRetryStatus, logSuccessfulReconnect, maxRequestBatchSize, nextReconnectJitter, onClose, onError, onMessage, onMessage, onOpen, onPong, outstandingRequest, pendingResponses, prepareRequest, prepareRequest, prepareResults, resolveGuarantee, restoreResultContext, restoreResultContext, retryOutstandingRequests, retryOutstandingRequestsAsync, retryOutstandingRequestsDelay, schedulePing, send, send, sendAndWait, sendCommand, sendPing, sendPreparedRequests, sendToAllSessions, sessionsForCapabilities, startRequestBatchEvent, transportCodec, transportMetricPublicationTimeout, tryPublishMetrics

Methods inherited from class Object

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

Methods inherited from interface TrackingClient

disconnectTracker, getMessageType, getTopic, readAndWait, readRange, readRange, resetPosition, storePosition

Constructor Details

WebsocketTrackingClient

public WebsocketTrackingClient(String endPointUrl,
 WebSocketClient client,
 io.fluxzero.common.MessageType type,
 String topic)

WebsocketTrackingClient

public WebsocketTrackingClient(URI endPointUri,
 WebSocketClient client,
 io.fluxzero.common.MessageType type,
 String topic,
 boolean sendMetrics)

Method Details

payloadCodecs

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

Description copied from class: AbstractWebsocketClient

Returns compact payload codecs owned by this concrete protocol client.

Overrides:

payloadCodecs in class AbstractWebsocketClient

supportsConsumerFiltering

public boolean supportsConsumerFiltering()

Description copied from interface: TrackingClient

Whether an established peer can filter consumer deliveries. Custom clients conservatively default to false; websocket implementations may establish their first connection to discover this capability.

Specified by:

supportsConsumerFiltering in interface TrackingClient

adaptRequestForSession

protected io.fluxzero.common.api.Request adaptRequestForSession(io.fluxzero.common.api.Request request,
 WebsocketSession session)

Description copied from class: AbstractWebsocketClient

Adapts an outgoing request to the selected peer on every attempt, including reconnect replay.

Overrides:

adaptRequestForSession in class AbstractWebsocketClient

localResponseForSession

protected io.fluxzero.common.api.RequestResult localResponseForSession(io.fluxzero.common.api.Request request,
 WebsocketSession session)

Description copied from class: AbstractWebsocketClient

Returns a local response for a peer-specific no-op, or null when the request must be sent.

Overrides:

localResponseForSession in class AbstractWebsocketClient

read

public CompletableFuture<io.fluxzero.common.api.tracking.MessageBatch> read(String trackerId,
 Long lastIndex,
 ConsumerConfiguration configuration)

Description copied from interface: TrackingClient

Asynchronously reads the next available MessageBatch for a given tracker.

Specified by:

read in interface TrackingClient

Parameters:

trackerId - the unique ID for the tracker thread requesting messages

lastIndex - the last index successfully handled by this tracker

configuration - the full configuration for the consumer

Returns:

a CompletableFuture that completes with the next batch of messages

claimSegment

public CompletableFuture<io.fluxzero.common.api.tracking.ClaimSegmentResult> claimSegment(String trackerId,
 Long lastIndex,
 ConsumerConfiguration config)

Requests a tracker segment using this client's message type and the consumer's filtering, waiting, and index-control settings; returns the asynchronous claim result.

Specified by:

claimSegment in interface TrackingClient

Parameters:

trackerId - the unique identifier of the tracker attempting to claim a segment

lastIndex - the tracker's last successfully processed index

config - the full consumer configuration

Returns:

a CompletableFuture resolving to the result of the claim

readFromIndex

public List<io.fluxzero.common.api.SerializedMessage> readFromIndex(long minIndex,
 int maxSize)

Description copied from interface: TrackingClient

Fetches messages starting from the given index up to the provided max size.

This method bypasses consumer configurations and is primarily used for diagnostics or reprocessing.

Specified by:

readFromIndex in interface TrackingClient

Parameters:

minIndex - the starting index (inclusive)

maxSize - the maximum number of messages to retrieve

Returns:

a list of serialized messages starting at the given index

readFromIndex

public List<io.fluxzero.common.api.SerializedMessage> readFromIndex(long minIndex,
 int maxSize,
 long maxBytes)

Description copied from interface: TrackingClient

Fetches messages directly from the message log while limiting both message count and complete serialized bytes.

If the first available message is larger than maxBytes, it is still returned so consumers can make progress. A maxBytes value of 0 disables the byte limit.

Specified by:

readFromIndex in interface TrackingClient

Parameters:

minIndex - the starting index (inclusive)

maxSize - the maximum number of messages to retrieve

maxBytes - the maximum number of complete serialized message bytes to retrieve

Returns:

a list of serialized messages starting at the given index

storePosition

public CompletableFuture<Void> storePosition(String consumer,
 int[] segment,
 long lastIndex,
 io.fluxzero.common.Guarantee guarantee)

Description copied from interface: TrackingClient

Stores the last successfully processed position for a consumer with a specific delivery guarantee.

Specified by:

storePosition in interface TrackingClient

Parameters:

consumer - the name of the consumer

segment - the segment the tracker is processing

lastIndex - the last message index processed

guarantee - delivery guarantee (e.g., STORED, SENT)

Returns:

a future indicating completion

resetPosition

public CompletableFuture<Void> resetPosition(String consumer,
 long lastIndex,
 io.fluxzero.common.Guarantee guarantee)

Description copied from interface: TrackingClient

Resets the consumer's tracking position to a given index with a specific delivery guarantee.

Specified by:

resetPosition in interface TrackingClient

Parameters:

consumer - the name of the consumer

lastIndex - the new index to start from

guarantee - the delivery guarantee

Returns:

a future indicating completion

getPosition

public io.fluxzero.common.api.tracking.Position getPosition(String consumer)

Description copied from interface: TrackingClient

Returns the current committed tracking position for the given consumer.

Specified by:

getPosition in interface TrackingClient

Parameters:

consumer - the name of the consumer

Returns:

the last known committed position

disconnectTracker

public CompletableFuture<Void> disconnectTracker(String consumer,
 String trackerId,
 boolean sendFinalEmptyBatch,
 io.fluxzero.common.Guarantee guarantee)

Description copied from interface: TrackingClient

Disconnects the specified tracker from its segment with the specified delivery guarantee.

Specified by:

disconnectTracker in interface TrackingClient

Parameters:

consumer - the name of the consumer group

trackerId - the ID of the tracker thread being disconnected

sendFinalEmptyBatch - whether to send a final empty batch to commit state

guarantee - the delivery guarantee to use

Returns:

a future indicating disconnection

disconnectTerminatedTracker

public CompletableFuture<Void> disconnectTerminatedTracker(String consumer,
 String trackerId,
 io.fluxzero.common.Guarantee guarantee)

Description copied from interface: TrackingClient

Releases a terminated local tracker, including any abandoned asynchronous reads still completing. The caller must have finished processing and must not issue further reads with this tracker identity. Wrappers that can initiate follow-up reads should override this method to release after those reads as well. This does not change the semantics of a temporary TrackingClient.disconnectTracker(String, String, boolean).

Specified by:

disconnectTerminatedTracker in interface TrackingClient

metricsMetadata

protected io.fluxzero.common.api.Metadata metricsMetadata()

Overrides:

metricsMetadata in class AbstractWebsocketClient

close

public void close()

Description copied from interface: TrackingClient

Closes any open resources associated with this client.

Once closed, the client should no longer be used to fetch or commit tracking state.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface TrackingClient

Overrides:

close in class AbstractWebsocketClient

toString

public String toString()

Overrides:

toString in class AbstractWebsocketClient