Added spec id commentary that was lacking.

ably · Jan 21, 2024 · d1691e6 · d1691e6
1 parent 68f4060
commit d1691e6
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/Source/ARTDefault.m b/Source/ARTDefault.m
@@ -3,7 +3,7 @@
 #import "ARTNSArray+ARTFunctional.h"
 #import "ARTClientInformation+Private.h"
 
-static NSString *const ARTDefault_apiVersion = @"2";
+static NSString *const ARTDefault_apiVersion = @"2"; // CSV2
 
 NSString *const ARTDefaultProduction = @"production";
 

diff --git a/Source/ARTRealtime.m b/Source/ARTRealtime.m
@@ -737,7 +737,7 @@ - (ARTEventListener *)performTransitionWithStateChange:(ARTConnectionStateChange
             _fallbacks = nil;
             _connectionLostAt = nil;
             self.options.recover = nil; // RTN16k
-            [self resendPendingMessagesWithResumed:stateChange.resumed];
+            [self resendPendingMessagesWithResumed:stateChange.resumed]; // RTN19a1
             [_connectedEventEmitter emit:nil with:nil];
             break;
         }
@@ -888,7 +888,7 @@ - (void)onConnected:(ARTProtocolMessage *)message {
             //as it may have been set by recover data (unless the recover failed).
             NSString *prevConnId = self.connection.id_nosync;
             BOOL connIdChanged = prevConnId && ![message.connectionId isEqualToString:prevConnId];
-            BOOL recoverFailure = !prevConnId && message.error;
+            BOOL recoverFailure = !prevConnId && message.error; // RTN16d
             BOOL resumed = !(connIdChanged || recoverFailure);
             if (!resumed) {
                 ARTLogDebug(self.logger, @"RT:%p msgSerial of connection \"%@\" has been reset", self, self.connection.id_nosync);
@@ -1257,7 +1257,7 @@ - (BOOL)isActive {
 
 - (void)sendImpl:(ARTProtocolMessage *)pm reuseMsgSerial:(BOOL)reuseMsgSerial sentCallback:(ARTCallback)sentCallback ackCallback:(ARTStatusCallback)ackCallback {
     if (pm.ackRequired) {
-        if (!reuseMsgSerial) {
+        if (!reuseMsgSerial) { // RTN19a2
             pm.msgSerial = [NSNumber numberWithLongLong:self.msgSerial];
         }
     }

diff --git a/Source/ARTRealtimeChannel.m b/Source/ARTRealtimeChannel.m
@@ -1043,7 +1043,7 @@ - (void)attachAfterChecks:(ARTCallback)callback {
     ARTProtocolMessage *attachMessage = [[ARTProtocolMessage alloc] init];
     attachMessage.action = ARTProtocolMessageAttach;
     attachMessage.channel = self.name;
-    attachMessage.channelSerial = self.serial;
+    attachMessage.channelSerial = self.serial; // RTL4c1
     attachMessage.params = self.options_nosync.params;
     attachMessage.flags = self.options_nosync.modes;
 

diff --git a/Source/ARTWebSocketTransport.m b/Source/ARTWebSocketTransport.m
@@ -161,7 +161,7 @@ - (NSURL *)setupWebSocket:(NSDictionary<NSString *, NSURLQueryItem *> *)params w
         }
     }
     else if (resumeKey != nil) {
-        [queryItems addValueAsURLQueryItem:resumeKey forKey:@"resume"];
+        [queryItems addValueAsURLQueryItem:resumeKey forKey:@"resume"]; // RTN15b1
     }
 
     [queryItems addValueAsURLQueryItem:[ARTDefault apiVersion] forKey:@"v"];

diff --git a/Source/PrivateHeaders/Ably/ARTRealtimeChannel+Private.h b/Source/PrivateHeaders/Ably/ARTRealtimeChannel+Private.h
@@ -37,7 +37,7 @@ NS_ASSUME_NONNULL_BEGIN
 @property (readonly, weak, nonatomic) ARTRealtimeInternal *realtime; // weak because realtime owns self
 @property (readonly, nonatomic) ARTRestChannelInternal *restChannel;
 @property (readwrite, nonatomic, nullable) NSString *attachSerial;
-@property (readwrite, nonatomic, nullable) NSString *serial;
+@property (readwrite, nonatomic, nullable) NSString *serial; // CP2b
 @property (readonly, nullable, getter=getClientId) NSString *clientId;
 @property (readonly, nonatomic) ARTEventEmitter<ARTEvent *, ARTChannelStateChange *> *internalEventEmitter;
 @property (readonly, nonatomic) ARTEventEmitter<ARTEvent *, ARTChannelStateChange *> *statesEventEmitter;