Package io.fluxcapacitor.javaclient.common.websocket

Class AbstractWebsocketClient

java.lang.Object
io.fluxcapacitor.javaclient.common.websocket.AbstractWebsocketClient
All Implemented Interfaces:
AutoCloseable
Direct Known Subclasses:
WebSocketEventStoreClient, WebsocketGatewayClient, WebsocketKeyValueClient, WebsocketSchedulingClient, WebSocketSearchClient, WebsocketTrackingClient
public abstract class AbstractWebsocketClient extends Object implements AutoCloseable
Abstract base class for all WebSocket-based clients in the Flux Capacitor Java client.

This class provides robust connection management, message dispatching, result handling, batching, metrics publishing, and ping-based health checking. It underpins core components such as WebsocketGatewayClient, providing the shared infrastructure needed for durable, resilient WebSocket communication with the Flux platform.

Core Responsibilities

  • Establishing and maintaining WebSocket connections with automatic reconnection support
  • Managing message sending and batching via Request and RequestBatch
  • Receiving and processing incoming RequestResult and ResultBatch messages
  • Supporting command guarantees (e.g., SENT, STORED) with retries and backpressure handling
  • Sending periodic ping frames to detect connection drops
  • Integrating with the Flux metrics infrastructure for custom performance telemetry

Key Features

  • Session Pooling: Maintains multiple concurrent sessions to handle high-throughput scenarios
  • Request Backlogs: Each session has a backlog to buffer and batch outgoing requests
  • Ping Scheduling: Scheduled tasks detect broken sessions using WebSocket pings
  • Auto Retry: Failed requests are retried if the session is closed unexpectedly
  • Async Result Handling: Responses are handled on a separate thread pool to avoid blocking I/O
  • Metrics Publishing: Optional emission of message-related metrics based on configuration
See Also:

  • Field Details

    • defaultWebSocketContainer

      public static jakarta.websocket.WebSocketContainer defaultWebSocketContainer

    • defaultObjectMapper

      public static com.fasterxml.jackson.databind.ObjectMapper defaultObjectMapper

  • Constructor Details

    • AbstractWebsocketClient

      public AbstractWebsocketClient(URI endpointUri, WebSocketClient client, boolean allowMetrics)
      Creates a WebSocket client using the given endpoint URI, client implementation, and a flag to allow metrics. Uses a default WebSocket container, default object mapper, and a single WebSocket session.
      Parameters:
      endpointUri - the URI of the WebSocket endpoint to connect to
      client - the client implementation that provides configuration and gateway access
      allowMetrics - whether metrics should be published for each request

    • AbstractWebsocketClient

      public AbstractWebsocketClient(URI endpointUri, WebSocketClient client, boolean allowMetrics, int numberOfSessions)
      Creates a WebSocket client with multiple parallel sessions using default settings. This constructor allows you to specify the number of WebSocket sessions to use, which is useful for increasing throughput and isolating message streams.
      Parameters:
      endpointUri - the URI of the WebSocket endpoint to connect to
      client - the client implementation that provides configuration and gateway access
      allowMetrics - whether metrics should be published for each request
      numberOfSessions - the number of WebSocket sessions to maintain concurrently

    • AbstractWebsocketClient

      public AbstractWebsocketClient(jakarta.websocket.WebSocketContainer container, URI endpointUri, WebSocketClient client, boolean allowMetrics, Duration reconnectDelay, com.fasterxml.jackson.databind.ObjectMapper objectMapper, int numberOfSessions)
      Constructs a WebSocket client with fine-grained control over connection setup. This constructor allows you to specify a custom container, reconnect delay, object mapper, and session count. It is primarily used for advanced configuration or test scenarios.
      Parameters:
      container - the WebSocket container to use for establishing connections
      endpointUri - the WebSocket server endpoint
      client - the client providing config and access to the Flux platform
      allowMetrics - flag to enable or disable automatic metrics publishing
      reconnectDelay - the delay between reconnect attempts if the connection is lost
      objectMapper - the Jackson object mapper for (de)serializing requests and responses
      numberOfSessions - the number of WebSocket sessions to establish in parallel

  • Method Details

    • send

      protected <R extends RequestResult> CompletableFuture<R> send(Request request)

    • sendAndWait

      protected <R extends RequestResult> R sendAndWait(Request request)

    • sendCommand

      protected CompletableFuture<Void> sendCommand(Command command)

    • onMessage

      public void onMessage(byte[] bytes, jakarta.websocket.Session session)

    • handleResult

      protected void handleResult(RequestResult result, String batchId)

    • onOpen

      public void onOpen(jakarta.websocket.Session session)

    • schedulePing

      protected AbstractWebsocketClient.PingRegistration schedulePing(jakarta.websocket.Session session)

    • sendPing

      protected void sendPing(jakarta.websocket.Session session)

    • abort

      protected void abort(jakarta.websocket.Session session)

    • onPong

      public void onPong(jakarta.websocket.PongMessage message, jakarta.websocket.Session session)

    • onClose

      public void onClose(jakarta.websocket.Session session, jakarta.websocket.CloseReason closeReason)

    • retryOutstandingRequests

      protected void retryOutstandingRequests(String sessionId)

    • onError

      public void onError(jakarta.websocket.Session session, Throwable e)

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • close

      protected void close(boolean clearOutstandingRequests)

    • tryPublishMetrics

      protected void tryPublishMetrics(JsonType message, Metadata metadata)

    • metricsMetadata

      protected Metadata metricsMetadata()