[ECO-5458] Added public interfaces for map and counter subscriptions

Author: sacOO7

lib/src/main/java/io/ably/lib/objects/LiveObjects.java

@@ -1,6 +1,8 @@
 package io.ably.lib.objects;
 
 import io.ably.lib.objects.state.ObjectsStateChange;
+import io.ably.lib.objects.type.counter.LiveCounter;
+import io.ably.lib.objects.type.map.LiveMap;
 import io.ably.lib.types.Callback;
 import org.jetbrains.annotations.Blocking;
 import org.jetbrains.annotations.NonBlocking;

…ava/io/ably/lib/objects/LiveCounter.java …ib/objects/type/counter/LiveCounter.javalib/src/main/java/io/ably/lib/objects/LiveCounter.java renamed to lib/src/main/java/io/ably/lib/objects/type/counter/LiveCounter.java lib/src/main/java/io/ably/lib/objects/LiveCounter.java renamed to lib/src/main/java/io/ably/lib/objects/type/counter/LiveCounter.java

@@ -1,4 +1,4 @@
-package io.ably.lib.objects;
+package io.ably.lib.objects.type.counter;
 
 import io.ably.lib.types.Callback;
 import org.jetbrains.annotations.Blocking;

lib/src/main/java/io/ably/lib/objects/type/counter/LiveCounterChange.java

@@ -0,0 +1,21 @@
+package io.ably.lib.objects.type.counter;
+
+import io.ably.lib.objects.ObjectsSubscription;
+import org.jetbrains.annotations.NonBlocking;
+import org.jetbrains.annotations.NotNull;
+
+public interface LiveCounterChange {
+
+    @NonBlocking
+    @NotNull ObjectsSubscription subscribe(@NotNull Listener listener);
+
+    @NonBlocking
+    void unsubscribe(@NotNull Listener listener);
+
+    @NonBlocking
+    void unsubscribeAll();
+
+    interface Listener {
+        void onUpdated(@NotNull LiveCounterUpdate update);
+    }
+}

lib/src/main/java/io/ably/lib/objects/type/counter/LiveCounterUpdate.java

@@ -0,0 +1,20 @@
+package io.ably.lib.objects.type.counter;
+
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Spec: RTLC11, RTLC11a
+ */
+public class LiveCounterUpdate {
+    @NotNull
+    private final Long amount; // RTLC11b, RTLC11b1
+
+    public LiveCounterUpdate(@NotNull Long amount) {
+        this.amount = amount;
+    }
+
+    @NotNull
+    public Long getUpdate() {
+        return amount;
+    }
+}

…in/java/io/ably/lib/objects/LiveMap.java …o/ably/lib/objects/type/map/LiveMap.javalib/src/main/java/io/ably/lib/objects/LiveMap.java renamed to lib/src/main/java/io/ably/lib/objects/type/map/LiveMap.java lib/src/main/java/io/ably/lib/objects/LiveMap.java renamed to lib/src/main/java/io/ably/lib/objects/type/map/LiveMap.java

@@ -1,4 +1,4 @@
-package io.ably.lib.objects;
+package io.ably.lib.objects.type.map;
 
 import io.ably.lib.types.Callback;
 import org.jetbrains.annotations.Blocking;

lib/src/main/java/io/ably/lib/objects/type/map/LiveMapChange.java

@@ -0,0 +1,21 @@
+package io.ably.lib.objects.type.map;
+
+import io.ably.lib.objects.ObjectsSubscription;
+import org.jetbrains.annotations.NonBlocking;
+import org.jetbrains.annotations.NotNull;
+
+public interface LiveMapChange {
+
+    @NonBlocking
+    @NotNull ObjectsSubscription subscribe(@NotNull Listener listener);
+
+    @NonBlocking
+    void unsubscribe(@NotNull Listener listener);
+
+    @NonBlocking
+    void unsubscribeAll();
+
+    interface Listener {
+        void onUpdated(@NotNull LiveMapUpdate update);
+    }
+}

lib/src/main/java/io/ably/lib/objects/type/map/LiveMapUpdate.java

@@ -0,0 +1,39 @@
+package io.ably.lib.objects.type.map;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Map;
+
+/**
+ * Spec: RTLM18, RTLM18a
+ */
+public class LiveMapUpdate {
+
+    @NotNull
+    private final Map<String, Change> update;
+
+    /**
+     * Constructor for LiveMapUpdate
+     * @param update The map of updates
+     */
+    public LiveMapUpdate(@NotNull Map<String, Change> update) {
+        this.update = update;
+    }
+
+    /**
+     * Get the map of updates
+     * @return The update map
+     */
+    @NotNull
+    public Map<String, Change> getUpdate() {
+        return update;
+    }
+
+    /**
+     * Spec: RTLM18b
+     */
+    public enum Change {
+        UPDATED,
+        REMOVED
+    }
+}

live-objects/src/main/kotlin/io/ably/lib/objects/DefaultLiveObjects.kt

@@ -2,6 +2,8 @@ package io.ably.lib.objects
 
 import io.ably.lib.objects.state.ObjectsStateChange
 import io.ably.lib.objects.state.ObjectsStateEvent
+import io.ably.lib.objects.type.counter.LiveCounter
+import io.ably.lib.objects.type.map.LiveMap
 import io.ably.lib.realtime.ChannelState
 import io.ably.lib.types.Callback
 import io.ably.lib.types.ProtocolMessage
@@ -167,7 +169,7 @@ internal class DefaultLiveObjects(internal val channelName: String, internal val
             objectsManager.clearBufferedObjectOperations() // RTO4b5
             // defer the state change event until the next tick if we started a new sequence just now due to being in initialized state.
             // this allows any event listeners to process the start of the new sequence event that was emitted earlier during this event loop.
-            objectsManager.endSync(fromInitializedState) // RTO4b4
+            objectsManager.endSync(fromInitializedState) // RTO4b4, RTO4b2a
           }
         }
 

live-objects/src/main/kotlin/io/ably/lib/objects/ObjectsManager.kt

@@ -125,6 +125,7 @@ internal class ObjectsManager(private val liveObjects: DefaultLiveObjects): Obje
     }
 
     val receivedObjectIds = mutableSetOf<String>()
+    // RTO5c1a2 - List to collect updates for existing objects
     val existingObjectUpdates = mutableListOf<Pair<BaseLiveObject, Any>>()
 
     // RTO5c1
@@ -148,7 +149,7 @@ internal class ObjectsManager(private val liveObjects: DefaultLiveObjects): Obje
     // RTO5c2 - need to remove LiveObject instances from the ObjectsPool for which objectIds were not received during the sync sequence
     liveObjects.objectsPool.deleteExtraObjectIds(receivedObjectIds)
 
-    // call subscription callbacks for all updated existing objects
+    // RTO5c7 - call subscription callbacks for all updated existing objects
     existingObjectUpdates.forEach { (obj, update) ->
       obj.notifyUpdated(update)
     }

live-objects/src/main/kotlin/io/ably/lib/objects/type/livecounter/DefaultLiveCounter.kt

@@ -5,6 +5,7 @@ import io.ably.lib.objects.ObjectOperation
 import io.ably.lib.objects.ObjectState
 import io.ably.lib.objects.type.BaseLiveObject
 import io.ably.lib.objects.type.ObjectType
+import io.ably.lib.objects.type.counter.LiveCounter
 import io.ably.lib.types.Callback
 import java.util.concurrent.atomic.AtomicLong