diff --git a/README.md b/README.md index 11ad99f..3da17fa 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ Socket.IO-client for iOS/OS X. ##Example ```swift import SocketIO + let socket = SocketIOClient(socketURL: URL(string: "http://localhost:8080")!, config: [.log(true), .forcePolling(true)]) socket.on("connect") {data, ack in @@ -14,7 +15,7 @@ socket.on("connect") {data, ack in socket.on("currentAmount") {data, ack in if let cur = data[0] as? Double { - socket.emitWithAck("canUpdate", cur)(0) {data in + socket.emitWithAck("canUpdate", cur).timingOut(after: 0) {data in socket.emit("update", ["amount": cur + 2.50]) } @@ -38,9 +39,9 @@ SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{ [socket on:@"currentAmount" callback:^(NSArray* data, SocketAckEmitter* ack) { double cur = [[data objectAtIndex:0] floatValue]; - [socket emitWithAck:@"canUpdate" withItems:@[@(cur)]](0, ^(NSArray* data) { + [[socket emitWithAck:@"canUpdate" withItems:@[@(cur)]] timingOutAfter:0 callback:^(NSArray* data) { [socket emit:@"update" withItems:@[@{@"amount": @(cur + 2.50)}]]; - }); + }]; [ack with:@[@"Got your currentAmount, ", @"dude"]]; }]; @@ -182,8 +183,8 @@ Methods 3. `onAny(callback:((event: String, items: AnyObject?)) -> Void)` - Adds a handler for all events. It will be called on any received event. 4. `emit(_ event: String, _ items: AnyObject...)` - Sends a message. Can send multiple items. 5. `emit(_ event: String, withItems items: [AnyObject])` - `emit` for Objective-C -6. `emitWithAck(_ event: String, _ items: AnyObject...) -> (timeoutAfter: UInt64, callback: (NSArray?) -> Void) -> Void` - Sends a message that requests an acknowledgement from the server. Returns a function which you can use to add a handler. See example. Note: The message is not sent until you call the returned function. -7. `emitWithAck(_ event: String, withItems items: [AnyObject]) -> (UInt64, (NSArray?) -> Void) -> Void` - `emitWithAck` for Objective-C. Note: The message is not sent until you call the returned function. +6. `emitWithAck(_ event: String, _ items: AnyObject...) -> OnAckCallback` - Sends a message that requests an acknowledgement from the server. Returns an object which you can use to add a handler. See example. Note: The message is not sent until you call timingOut(after:) on the returned object. +7. `emitWithAck(_ event: String, withItems items: [AnyObject]) -> OnAckCallback` - `emitWithAck` for Objective-C. Note: The message is not sent until you call timingOutAfter on the returned object. 8. `connect()` - Establishes a connection to the server. A "connect" event is fired upon successful connection. 9. `connect(timeoutAfter timeoutAfter: Int, withTimeoutHandler handler: (() -> Void)?)` - Connect to the server. If it isn't connected after timeoutAfter seconds, the handler is called. 10. `disconnect()` - Closes the socket. Reopening a disconnected socket is not fully tested. diff --git a/SocketIO-MacTests/SocketObjectiveCTest.m b/SocketIO-MacTests/SocketObjectiveCTest.m index 978f99a..b3d99ab 100644 --- a/SocketIO-MacTests/SocketObjectiveCTest.m +++ b/SocketIO-MacTests/SocketObjectiveCTest.m @@ -35,9 +35,9 @@ } - (void)testEmitWithAckSyntax { - [self.socket emitWithAck:@"testAckEmit" with:@[@YES]](0, ^(NSArray* data) { + [[self.socket emitWithAck:@"testAckEmit" with:@[@YES]] timingOutAfter:0 callback:^(NSArray* data) { - }); + }]; } - (void)testOffSyntax { diff --git a/SocketIO-MacTests/SocketSideEffectTest.swift b/SocketIO-MacTests/SocketSideEffectTest.swift index 7a5a74f..9fede35 100644 --- a/SocketIO-MacTests/SocketSideEffectTest.swift +++ b/SocketIO-MacTests/SocketSideEffectTest.swift @@ -25,20 +25,20 @@ class SocketSideEffectTest: XCTestCase { } func testFirstAck() { - socket.emitWithAck("test")(0) {data in} + socket.emitWithAck("test").timingOut(after: 0) {data in} XCTAssertEqual(socket.currentAck, 0) } func testSecondAck() { - socket.emitWithAck("test")(0) {data in} - socket.emitWithAck("test")(0) {data in} + socket.emitWithAck("test").timingOut(after: 0) {data in} + socket.emitWithAck("test").timingOut(after: 0) {data in} XCTAssertEqual(socket.currentAck, 1) } func testHandleAck() { let expect = expectation(description: "handled ack") - socket.emitWithAck("test")(0) {data in + socket.emitWithAck("test").timingOut(after: 0) {data in XCTAssertEqual(data[0] as? String, "hello world") expect.fulfill() } @@ -49,7 +49,7 @@ class SocketSideEffectTest: XCTestCase { func testHandleAck2() { let expect = expectation(description: "handled ack2") - socket.emitWithAck("test")(0) {data in + socket.emitWithAck("test").timingOut(after: 0) {data in XCTAssertTrue(data.count == 2, "Wrong number of ack items") expect.fulfill() } diff --git a/Source/SocketAckEmitter.swift b/Source/SocketAckEmitter.swift index 511d497..180654e 100644 --- a/Source/SocketAckEmitter.swift +++ b/Source/SocketAckEmitter.swift @@ -45,3 +45,39 @@ public final class SocketAckEmitter : NSObject { socket.emitAck(ackNum, with: items) } } + +public final class OnAckCallback : NSObject { + private let ackNumber: Int + private let items: [Any] + private weak var socket: SocketIOClient? + + init(ackNumber: Int, items: [Any], socket: SocketIOClient) { + self.ackNumber = ackNumber + self.items = items + self.socket = socket + } + + deinit { + DefaultSocketLogger.Logger.log("OnAckCallback for \(ackNumber) being released", type: "OnAckCallback") + } + + public func timingOut(after seconds: Int, callback: @escaping AckCallback) { + guard let socket = self.socket else { return } + + socket.ackQueue.sync() { + socket.ackHandlers.addAck(ackNumber, callback: callback) + } + + + socket._emit(items, ack: ackNumber) + + guard seconds != 0 else { return } + + let time = DispatchTime.now() + Double(Int64(UInt64(seconds) * NSEC_PER_SEC)) / Double(NSEC_PER_SEC) + + socket.handleQueue.asyncAfter(deadline: time) { + socket.ackHandlers.timeoutAck(self.ackNumber, onQueue: socket.handleQueue) + } + } + +} diff --git a/Source/SocketIOClient.swift b/Source/SocketIOClient.swift index 0a51bd0..be41d24 100644 --- a/Source/SocketIOClient.swift +++ b/Source/SocketIOClient.swift @@ -46,21 +46,22 @@ public final class SocketIOClient : NSObject, SocketEngineClient, SocketParsable public var reconnects = true public var reconnectWait = 10 - private let ackQueue = DispatchQueue(label: "com.socketio.ackQueue", attributes: []) - private let emitQueue = DispatchQueue(label: "com.socketio.emitQueue", attributes: []) private let logType = "SocketIOClient" - private let parseQueue = DispatchQueue(label: "com.socketio.parseQueue", attributes: []) + private let parseQueue = DispatchQueue(label: "com.socketio.parseQueue") private var anyHandler: ((SocketAnyEvent) -> Void)? private var currentReconnectAttempt = 0 private var handlers = [SocketEventHandler]() - private var ackHandlers = SocketAckManager() private var reconnecting = false private(set) var currentAck = -1 private(set) var handleQueue = DispatchQueue.main private(set) var reconnectAttempts = -1 + + let ackQueue = DispatchQueue(label: "com.socketio.ackQueue") + let emitQueue = DispatchQueue(label: "com.socketio.emitQueue") + var ackHandlers = SocketAckManager() var waitingPackets = [SocketPacket]() public var sid: String? { @@ -163,24 +164,7 @@ public final class SocketIOClient : NSObject, SocketEngineClient, SocketParsable private func createOnAck(_ items: [Any]) -> OnAckCallback { currentAck += 1 - return {[weak self, ack = currentAck] timeout, callback in - guard let this = self else { return } - - this.ackQueue.sync() { - this.ackHandlers.addAck(ack, callback: callback) - } - - - this._emit(items, ack: ack) - - if timeout != 0 { - let time = DispatchTime.now() + Double(Int64(timeout * NSEC_PER_SEC)) / Double(NSEC_PER_SEC) - - this.handleQueue.asyncAfter(deadline: time) { - this.ackHandlers.timeoutAck(ack, onQueue: this.handleQueue) - } - } - } + return OnAckCallback(ackNumber: currentAck, items: items, socket: self) } func didConnect() { @@ -238,7 +222,7 @@ public final class SocketIOClient : NSObject, SocketEngineClient, SocketParsable return createOnAck([event] + items) } - private func _emit(_ data: [Any], ack: Int? = nil) { + func _emit(_ data: [Any], ack: Int? = nil) { emitQueue.async { guard self.status == .connected else { self.handleEvent("error", data: ["Tried emitting when not connected"], isInternalMessage: true) diff --git a/Source/SocketPacket.swift b/Source/SocketPacket.swift index 95b3218..d88ef4c 100644 --- a/Source/SocketPacket.swift +++ b/Source/SocketPacket.swift @@ -87,25 +87,18 @@ struct SocketPacket { } private func completeMessage(_ message: String) -> String { - let restOfMessage: String - if data.count == 0 { return message + "[]" } - do { - let jsonSend = try data.toJSON() - guard let jsonString = String(data: jsonSend, encoding: .utf8) else { return message + "[]" } - - restOfMessage = jsonString - } catch { + guard let jsonSend = try? data.toJSON(), let jsonString = String(data: jsonSend, encoding: .utf8) else { DefaultSocketLogger.Logger.error("Error creating JSON object in SocketPacket.completeMessage", - type: SocketPacket.logType) + type: SocketPacket.logType) - restOfMessage = "[]" + return message + "[]" } - return message + restOfMessage + return message + jsonString } private func createPacketString() -> String { @@ -133,11 +126,11 @@ struct SocketPacket { // binary data private func _fillInPlaceholders(_ object: Any) -> Any { switch object { - case let dict as [String: Any]: + case let dict as JSON: if dict["_placeholder"] as? Bool ?? false { return binary[dict["num"] as! Int] } else { - return dict.reduce([String: Any](), {cur, keyValue in + return dict.reduce(JSON(), {cur, keyValue in var cur = cur cur[keyValue.0] = _fillInPlaceholders(keyValue.1) @@ -181,7 +174,7 @@ extension SocketPacket { private extension SocketPacket { // Recursive function that looks for NSData in collections static func shred(_ data: Any, binary: inout [Data]) -> Any { - let placeholder = ["_placeholder": true, "num": binary.count] as [String : Any] + let placeholder = ["_placeholder": true, "num": binary.count] as JSON switch data { case let bin as Data: @@ -190,8 +183,8 @@ private extension SocketPacket { return placeholder case let arr as [Any]: return arr.map({shred($0, binary: &binary)}) - case let dict as [String: Any]: - return dict.reduce([String: Any](), {cur, keyValue in + case let dict as JSON: + return dict.reduce(JSON(), {cur, keyValue in var mutCur = cur mutCur[keyValue.0] = shred(keyValue.1, binary: &binary) diff --git a/Source/SocketTypes.swift b/Source/SocketTypes.swift index 42bf329..cc194a7 100644 --- a/Source/SocketTypes.swift +++ b/Source/SocketTypes.swift @@ -41,8 +41,8 @@ extension String : SocketData {} public typealias AckCallback = ([Any]) -> Void public typealias NormalCallback = ([Any], SocketAckEmitter) -> Void -public typealias OnAckCallback = (_ timeoutAfter: UInt64, _ callback: @escaping AckCallback) -> Void +typealias JSON = [String: Any] typealias Probe = (msg: String, type: SocketEnginePacketType, data: [Data]) typealias ProbeWaitQueue = [Probe]