Merge pull request #273 from ably/fix-ping-callback

Use ErrorInfo instead of internal ARTStatus in ping callback.
ably · Mar 4, 2016 · 9cb5b9d · 9cb5b9d
2 parents 0017aab + 2d32d3c
commit 9cb5b9d
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 14 deletions.
diff --git a/Source/ARTConnection.h b/Source/ARTConnection.h
@@ -29,7 +29,7 @@ ART_ASSUME_NONNULL_BEGIN
 
 - (void)connect;
 - (void)close;
-- (void)ping:(void (^)(ARTStatus *))cb;
+- (void)ping:(void (^)(ARTErrorInfo *__art_nullable))cb;
 
 ART_EMBED_INTERFACE_EVENT_EMITTER(ARTRealtimeConnectionState, ARTConnectionStateChange *)
 

diff --git a/Source/ARTRealtime.m b/Source/ARTRealtime.m
@@ -357,11 +357,12 @@ - (void)onHeartbeat {
     if(self.pingCb) {
         [self cancelPingTimer];
         if(self.connection.state != ARTRealtimeConnected) {
-            [self.logger warn:@"ARTRealtime received a ping when in state %@", [ARTRealtime ARTRealtimeStateToStr:self.connection.state]];
-            self.pingCb([ARTStatus state:ARTStateError]);
+            NSString *msg = [NSString stringWithFormat:@"ARTRealtime received a ping when in state %@", [ARTRealtime ARTRealtimeStateToStr:self.connection.state]];
+            [self.logger warn:@"%@", msg];
+            self.pingCb([ARTErrorInfo createWithCode:0 message:msg]);
         }
         else {
-            self.pingCb([ARTStatus state:ARTStateOk]);
+            self.pingCb(nil);
         }
         self.pingCb = nil;
     }
@@ -493,7 +494,7 @@ - (void)onCloseTimerFired {
 
 - (void)onPingTimerFired {
     if(self.pingCb) {
-        self.pingCb([ARTStatus state:ARTStateConnectionFailed]);
+        self.pingCb([ARTErrorInfo createWithCode:0 status:ARTStateConnectionFailed message:@"connection failed"]);
         self.pingCb = nil;
     }
 }

diff --git a/Source/ARTTypes.h b/Source/ARTTypes.h
@@ -86,11 +86,7 @@ NSString *generateNonce();
 
 // MARK: Callbacks definitions
 
-typedef void (^ARTRealtimeChannelStateCb)(ARTRealtimeChannelState, ARTStatus *);
-
-typedef void (^ARTRealtimeChannelPresenceCb)(ARTPresenceMessage *);
-
-typedef void (^ARTRealtimePingCb)(ARTStatus *);
+typedef void (^ARTRealtimePingCb)(ARTErrorInfo *__art_nullable);
 
 typedef void (^ARTStatusCallback)(ARTStatus *status);
 

diff --git a/Tests/ARTRealtimeConnectTest.m b/Tests/ARTRealtimeConnectTest.m
@@ -59,8 +59,8 @@ - (void)testConnectPing {
         [realtime.connection on:^(ARTConnectionStateChange *stateChange) {
             ARTRealtimeConnectionState state = stateChange.current;
             if (state == ARTRealtimeConnected) {
-                [realtime.connection ping:^(ARTStatus *status) {
-                    XCTAssertEqual(ARTStateOk, status.state);
+                [realtime.connection ping:^(ARTErrorInfo *error) {
+                    XCTAssertNil(error);
                     [expectation fulfill];
                 }];
             }
@@ -289,12 +289,12 @@ - (void)testConnectPingError {
             }
             if(state == ARTRealtimeClosed) {
                 hasClosed = true;
-                XCTAssertThrows([realtime.connection ping:^(ARTStatus *s) {}]);
+                XCTAssertThrows([realtime.connection ping:^(ARTErrorInfo *e) {}]);
                 [realtime onError:[ARTTestUtil newErrorProtocolMessage]];
             }
             if(state == ARTRealtimeFailed) {
                 XCTAssertTrue(hasClosed);
-                XCTAssertThrows([realtime.connection ping:^(ARTStatus *s) {}]);
+                XCTAssertThrows([realtime.connection ping:^(ARTErrorInfo *e) {}]);
                 [exp fulfill];
                 [realtime.connection off:listener];
             }