Package io.ably.lib.liveobjects.adapter

Interface AblyClientAdapter

All Known Implementing Classes:
Adapter
public interface AblyClientAdapter
Bridges the path-based LiveObjects implementation to the core Ably client, exposing the client configuration, connection and channel state it needs without coupling it to the concrete AblyRealtime type.

This is the adapter for the path-based io.ably.lib.object API and is intentionally kept independent of the legacy io.ably.lib.objects package.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull ChannelBase
    getChannel(@NotNull String channelName)
    Retrieves the channel instance for the specified channel name.
    @NotNull ClientOptions
    getClientOptions()
    Retrieves the client options configured for the Ably client.
    @NotNull Connection
    getConnection()
    Retrieves the connection instance for handling connection state and operations.
    long
    getTime()
    Retrieves the current time in milliseconds from the Ably server.

  • Method Details

    • getClientOptions

      @NotNull @NotNull ClientOptions getClientOptions()
      Retrieves the client options configured for the Ably client. Used to access client configuration parameters such as echoMessages setting that affect the behavior of Objects operations.
      Returns:
      the client options containing configuration parameters

    • getConnection

      @NotNull @NotNull Connection getConnection()
      Retrieves the connection instance for handling connection state and operations. Used to check connection status, obtain error information, and manage message transmission across the Ably connection.
      Returns:
      the connection instance

    • getTime

      @Blocking long getTime() throws AblyException
      Retrieves the current time in milliseconds from the Ably server. Spec: RTO16
      Throws:
      AblyException

    • getChannel

      @NotNull @NotNull ChannelBase getChannel(@NotNull @NotNull String channelName) throws AblyException
      Retrieves the channel instance for the specified channel name. If the channel does not exist, an AblyException is thrown.
      Parameters:
      channelName - the name of the channel to retrieve
      Returns:
      the ChannelBase instance for the specified channel
      Throws:
      AblyException - if the channel is not found or cannot be retrieved