Class WebsocketSchedulingClient

java.lang.Object

io.fluxzero.sdk.common.websocket.AbstractWebsocketClient

io.fluxzero.sdk.scheduling.client.WebsocketSchedulingClient

All Implemented Interfaces:

WebsocketEndpoint, SchedulingClient, AutoCloseable

public class WebsocketSchedulingClient
extends AbstractWebsocketClient
implements SchedulingClient

WebSocket-based implementation of the SchedulingClient interface that communicates with the Fluxzero Runtime.

This client is responsible for scheduling, cancelling, and querying deferred messages (schedules) over a WebSocket connection. It acts as the transport layer for the MessageScheduler.

Usage is typically indirect via high-level APIs like Fluxzero.schedule(...) or the MessageScheduler. Direct interaction with this client is uncommon in most application code.

See Also:

• SchedulingClient
• MessageScheduler
• SerializedSchedule

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
WebsocketSchedulingClient(String endPointUrl, WebSocketClient client)	Constructs a scheduling client connected to the given endpoint URL.
WebsocketSchedulingClient(URI endpointUri, WebSocketClient client)	Constructs a scheduling client connected to the given endpoint URI.
WebsocketSchedulingClient(URI endpointUri, WebSocketClient client, boolean sendMetrics)	Constructs a scheduling client connected to the given endpoint URI with an option to enable or disable metrics tracking.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Map<String,Long>>	bindScheduleParents(List<String> parentIds)	Acquires opaque namespace-local lifetime bindings to existing parents.
CompletableFuture<Void>	cancelSchedule(String scheduleId, Guarantee guarantee)	Cancel a scheduled message using the provided delivery guarantee.
SerializedSchedule	getSchedule(String scheduleId)	Retrieves the serialized schedule associated with the given ID.
CompletableFuture<Void>	schedule(Guarantee guarantee, SerializedSchedule... schedules)	Schedule one or more serialized schedules with a specified Guarantee.
CompletableFuture<Void>	scheduleBoundToParents(Guarantee guarantee, Map<String,Long> parents, SerializedSchedule... schedules)	Stores schedules with previously acquired bindings, without rebinding recreated parents.

Methods inherited from class AbstractWebsocketClient

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

Methods inherited from class Object

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

Methods inherited from interface SchedulingClient

cancelSchedule, close, hasSchedule, schedule, scheduleWithParents

Constructor Details

WebsocketSchedulingClient

public WebsocketSchedulingClient(String endPointUrl,
 WebSocketClient client)

Constructs a scheduling client connected to the given endpoint URL.

Parameters:

endPointUrl - The endpoint URL of the Fluxzero Runtime scheduling gateway.

client - The Fluxzero WebSocketClient configuration to use.

WebsocketSchedulingClient

public WebsocketSchedulingClient(URI endpointUri,
 WebSocketClient client)

Constructs a scheduling client connected to the given endpoint URI.

Parameters:

endpointUri - The URI of the scheduling gateway.

client - The Fluxzero WebSocketClient configuration to use.

WebsocketSchedulingClient

public WebsocketSchedulingClient(URI endpointUri,
 WebSocketClient client,
 boolean sendMetrics)

Constructs a scheduling client connected to the given endpoint URI with an option to enable or disable metrics tracking.

Parameters:

endpointUri - The URI of the scheduling gateway.

client - The WebSocket client configuration.

sendMetrics - Whether to send metrics about schedule operations.

Method Details

schedule

public CompletableFuture<Void> schedule(Guarantee guarantee,
 SerializedSchedule... schedules)

Description copied from interface: SchedulingClient

Schedule one or more serialized schedules with a specified Guarantee.

Specified by:

schedule in interface SchedulingClient

Parameters:

guarantee - Delivery guarantee to apply (e.g., none, sent, stored).

schedules - One or more schedules to register.

Returns:

A future that completes when the selected delivery guarantee is reached.

bindScheduleParents

public CompletableFuture<Map<String,Long>> bindScheduleParents(List<String> parentIds)

Description copied from interface: SchedulingClient

Acquires opaque namespace-local lifetime bindings to existing parents.

Specified by:

bindScheduleParents in interface SchedulingClient

scheduleBoundToParents

public CompletableFuture<Void> scheduleBoundToParents(Guarantee guarantee,
 Map<String,Long> parents,
 SerializedSchedule... schedules)

Description copied from interface: SchedulingClient

Stores schedules with previously acquired bindings, without rebinding recreated parents.

Specified by:

scheduleBoundToParents in interface SchedulingClient

cancelSchedule

public CompletableFuture<Void> cancelSchedule(String scheduleId,
 Guarantee guarantee)

Description copied from interface: SchedulingClient

Cancel a scheduled message using the provided delivery guarantee.

Specified by:

cancelSchedule in interface SchedulingClient

Parameters:

scheduleId - The identifier of the schedule to cancel.

guarantee - Delivery guarantee for the cancellation request.

Returns:

A future that completes when the selected delivery guarantee is reached.

getSchedule

public SerializedSchedule getSchedule(String scheduleId)

Description copied from interface: SchedulingClient

Retrieves the serialized schedule associated with the given ID.

Specified by:

getSchedule in interface SchedulingClient

Parameters:

scheduleId - The ID of the schedule to retrieve.

Returns:

The matching SerializedSchedule, or null if none is found.