Package io.ably.lib.objects

Interface LiveObjectsPlugin

public interface LiveObjectsPlugin
The LiveObjectsPlugin interface provides a mechanism for managing and interacting with live data objects in a real-time environment. It allows for the retrieval, disposal, and management of LiveObjects instances associated with specific channel names.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    dispose()
    Disposes of the plugin instance and all underlying resources.
    void
    dispose(@NotNull String channelName)
    Disposes of the LiveObjects instance associated with the specified channel name.
    @NotNull LiveObjects
    getInstance(@NotNull String channelName)
    Retrieves an instance of LiveObjects associated with the specified channel name.
    void
    handle(@NotNull ProtocolMessage message)
    Handles a protocol message.

  • Method Details

    • getInstance

      @NotNull @NotNull LiveObjects getInstance(@NotNull @NotNull String channelName)
      Retrieves an instance of LiveObjects associated with the specified channel name. This method ensures that a LiveObjects instance is available for the given channel, creating one if it does not already exist.
      Parameters:
      channelName - the name of the channel for which the LiveObjects instance is to be retrieved.
      Returns:
      the LiveObjects instance associated with the specified channel name.

    • handle

      void handle(@NotNull @NotNull ProtocolMessage message)
      Handles a protocol message. This method is invoked whenever a protocol message is received, allowing the implementation to process the message and take appropriate actions.
      Parameters:
      message - the protocol message to handle.

    • dispose

      void dispose(@NotNull @NotNull String channelName)
      Disposes of the LiveObjects instance associated with the specified channel name. This method removes the LiveObjects instance for the given channel, releasing any resources associated with it.
      Parameters:
      channelName - the name of the channel whose LiveObjects instance is to be removed.

    • dispose

      void dispose()
      Disposes of the plugin instance and all underlying resources.