Merge pull request #6 from ably/add-connected-protocolmessage-api

Add LiveObjects plugin API for receiving connection details

Author: lawrence-forooghian

Sources/_AblyPluginSupportPrivate/include/APConnectionDetails.h

@@ -0,0 +1,15 @@
+@import Foundation;
+
+NS_ASSUME_NONNULL_BEGIN
+
+NS_SWIFT_NAME(ConnectionDetailsProtocol)
+NS_SWIFT_SENDABLE
+/// The contents of a `CONNECTED` `ProtocolMessage`'s `connectionDetails`.
+@protocol APConnectionDetailsProtocol
+
+/// Wraps an `NSTimeInterval` containing the `objectsGCGracePeriod`, if any, in seconds.
+@property (nonatomic, readonly, nullable) NSNumber *objectsGCGracePeriod;
+
+@end
+
+NS_ASSUME_NONNULL_END

Sources/_AblyPluginSupportPrivate/include/APLiveObjectsPlugin.h

@@ -7,6 +7,7 @@
 @protocol APRealtimeChannel;
 @protocol APRealtimeClient;
 @protocol APPublicErrorInfo;
+@protocol APConnectionDetailsProtocol;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -83,6 +84,13 @@ NS_SWIFT_SENDABLE
                                     protocolMessageChannelSerial:(nullable NSString *)protocolMessageChannelSerial
                                                          channel:(id<APRealtimeChannel>)channel;
 
+/// Called whenever the client receives a `CONNECTED` `ProtocolMessage`, passing its `connectionDetails` (if any).
+///
+/// Parameters:
+/// - channel: The channel that should be informed about the connection details.
+- (void)nosync_onConnectedWithConnectionDetails:(nullable id<APConnectionDetailsProtocol>)connectionDetails
+                                        channel:(id<APRealtimeChannel>)channel;
+
 @end
 
 /// An `ObjectMessage`, as found in the `state` property of an `OBJECT` or `OBJECT_SYNC` `ProtocolMessage`.

Sources/_AblyPluginSupportPrivate/include/APPluginAPI.h

@@ -80,6 +80,9 @@ NS_SWIFT_SENDABLE
 - (void)nosync_fetchServerTimeForClient:(id<APRealtimeClient>)client
                              completion:(void (^ _Nullable)(NSDate *_Nullable serverTime, _Nullable id<APPublicErrorInfo> error))completion;
 
+/// The `connectionDetails` from the latest `CONNECTED` `ProtocolMessage` that the client received (`nil` if it did not contain a `connectionDetails`).
+- (nullable id<APConnectionDetailsProtocol>)nosync_latestConnectionDetailsForClient:(id<APRealtimeClient>)client;
+
 /// Logs a message to a logger.
 - (void)log:(NSString *)message
         withLevel:(APLogLevel)level