// // SocketIOClient.swift // Socket.IO-Swift // // Created by Erik Little on 11/23/14. // // Permission is hereby granted, free of charge, to any person obtaining a copy // of this software and associated documentation files (the "Software"), to deal // in the Software without restriction, including without limitation the rights // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the Software is // furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE. import Foundation public class SocketIOClient: NSObject, SocketEngineClient { let reconnectAttempts:Int! private lazy var params = [String: AnyObject]() private var ackHandlers = ContiguousArray() private var anyHandler:((SocketAnyEvent) -> Void)? private var _closed = false private var _connected = false private var _connecting = false private var currentReconnectAttempt = 0 private var forcePolling = false private var forceWebsockets = false private var handlers = ContiguousArray() private var paramConnect = false private var _secure = false private var _sid:String? private var _reconnecting = false private var reconnectTimer:NSTimer? var currentAck = -1 var waitingData = ContiguousArray() public let socketURL:String public let handleQueue = dispatch_queue_create("handleQueue".cStringUsingEncoding(NSUTF8StringEncoding), DISPATCH_QUEUE_SERIAL) public let emitQueue = dispatch_queue_create("emitQueue".cStringUsingEncoding(NSUTF8StringEncoding), DISPATCH_QUEUE_SERIAL) public var closed:Bool { return self._closed } public var connected:Bool { return self._connected } public var connecting:Bool { return self._connecting } public var cookies:[NSHTTPCookie]? public var engine:SocketEngine? public var nsp = "/" public var reconnects = true public var reconnecting:Bool { return self._reconnecting } public var reconnectWait = 10 public var secure:Bool { return self._secure } public var sid:String? { return self._sid } /** Create a new SocketIOClient. opts can be omitted */ public init(var socketURL:String, opts:NSDictionary? = nil) { if socketURL["https://"].matches().count != 0 { self._secure = true } socketURL = socketURL["http://"] ~= "" socketURL = socketURL["https://"] ~= "" self.socketURL = socketURL // Set options if opts != nil { if let reconnects = opts!["reconnects"] as? Bool { self.reconnects = reconnects } if let reconnectAttempts = opts!["reconnectAttempts"] as? Int { self.reconnectAttempts = reconnectAttempts } else { self.reconnectAttempts = -1 } if let reconnectWait = opts!["reconnectWait"] as? Int { self.reconnectWait = abs(reconnectWait) } if var nsp = opts!["nsp"] as? String { if nsp != "/" && nsp.hasPrefix("/") { nsp.removeAtIndex(nsp.startIndex) } self.nsp = nsp } if let polling = opts!["forcePolling"] as? Bool { self.forcePolling = polling } if let ws = opts!["forceWebsockets"] as? Bool { self.forceWebsockets = ws } if let cookies = opts!["cookies"] as? [NSHTTPCookie] { self.cookies = cookies } } else { self.reconnectAttempts = -1 } super.init() } public convenience init(socketURL:String, options:NSDictionary?) { self.init(socketURL: socketURL, opts: options) } private func addEngine() { self.engine = SocketEngine(client: self, forcePolling: self.forcePolling, forceWebsockets: self.forceWebsockets, withCookies: self.cookies) } /** Closes the socket. Only reopen the same socket if you know what you're doing. Will turn off automatic reconnects. Pass true to fast if you're closing from a background task */ public func close(#fast:Bool) { self.reconnects = false self._connecting = false self._connected = false self._reconnecting = false self.engine?.close(fast: fast) } /** Connect to the server. */ public func connect() { if self.closed { println("Warning! This socket was previously closed. This might be dangerous!") self._closed = false } if self.connected { return } self.addEngine() self.engine?.open() } /** Connect to the server with params that will be passed on connection. */ public func connectWithParams(params:[String: AnyObject]) { if self.closed { println("Warning! This socket was previously closed. This might be dangerous!") self._closed = false } if self.connected { return } self.params = params self.paramConnect = true self.addEngine() self.engine?.open(opts: params) } func didConnect() { self._closed = false self._connected = true self._connecting = false self._reconnecting = false self.currentReconnectAttempt = 0 self.reconnectTimer?.invalidate() self.reconnectTimer = nil self._sid = self.engine?.sid // Don't handle as internal because something crazy could happen where // we disconnect before it's handled self.handleEvent("connect", data: nil, isInternalMessage: false) } /// Server wants us to die public func didForceClose(reason:String) { if self.closed { return } self._closed = true self._connected = false self.reconnects = false self._connecting = false self._reconnecting = false self.handleEvent("disconnect", data: [reason], isInternalMessage: true) } /** Send a message to the server */ public func emit(event:String, _ items:AnyObject...) { if !self.connected { return } dispatch_async(self.emitQueue) {[weak self] in self?._emit(event, items) return } } /** Same as emit, but meant for Objective-C */ public func emitObjc(event:String, withItems items:[AnyObject]) { if !self.connected { return } dispatch_async(self.emitQueue) {[weak self] in self?._emit(event, items) return } } /** Sends a message to the server, requesting an ack. Use the onAck method of SocketAckHandler to add an ack. */ public func emitWithAck(event:String, _ items:AnyObject...) -> SocketAckHandler { if !self.connected { return SocketAckHandler(event: "fail", socket: self) } self.currentAck++ let ackHandler = SocketAckHandler(event: event, ackNum: self.currentAck, socket: self) self.ackHandlers.append(ackHandler) dispatch_async(self.emitQueue) {[weak self, ack = self.currentAck] in self?._emit(event, items, ack: ack) return } return ackHandler } /** Same as emitWithAck, but for Objective-C */ public func emitWithAckObjc(event:String, withItems items:[AnyObject]) -> SocketAckHandler { if !self.connected { return SocketAckHandler(event: "fail", socket: self) } self.currentAck++ let ackHandler = SocketAckHandler(event: event, ackNum: self.currentAck, socket: self) self.ackHandlers.append(ackHandler) dispatch_async(self.emitQueue) {[weak self, ack = self.currentAck] in self?._emit(event, items, ack: ack) return } return ackHandler } private func _emit(event:String, _ args:[AnyObject], ack:Int? = nil) { if !self.connected { return } let packet = SocketPacket(type: nil, data: args, nsp: self.nsp, id: ack) var str:String SocketParser.parseForEmit(packet) str = packet.createMessageForEvent(event) if packet.type == SocketPacketType.BINARY_EVENT { self.engine?.send(str, withData: packet.binary) } else { self.engine?.send(str, withData: nil) } } // If the server wants to know that the client received data func emitAck(ack:Int, withData args:[AnyObject]) { dispatch_async(self.emitQueue) {[weak self] in if self == nil || !self!.connected { return } let packet = SocketPacket(type: nil, data: args, nsp: self!.nsp, id: ack) var str:String SocketParser.parseForEmit(packet) str = packet.createAck() if packet.type == SocketPacketType.BINARY_ACK { self?.engine?.send(str, withData: packet.binary) } else { self?.engine?.send(str, withData: nil) } } } // Called when the socket gets an ack for something it sent func handleAck(ack:Int, data:AnyObject?) { self.ackHandlers = self.ackHandlers.filter {handler in if handler.ackNum != ack { return true } else { if data is NSArray { handler.executeAck(data as? NSArray) } else if data != nil { handler.executeAck([data!]) } else { handler.executeAck(nil) } return false } } } /** Causes an event to be handled. Only use if you know what you're doing. */ public func handleEvent(event:String, data:[AnyObject]?, isInternalMessage:Bool = false, wantsAck ack:Int? = nil) { // println("Should do event: \(event) with data: \(data)") if !self.connected && !isInternalMessage { return } if self.anyHandler != nil { dispatch_async(dispatch_get_main_queue()) {[weak self] in self?.anyHandler?(SocketAnyEvent(event: event, items: data)) return } } for handler in self.handlers { if handler.event == event { if ack != nil { handler.executeCallback(data, withAck: ack!, withSocket: self) } else { handler.executeCallback(data) } } } } func joinNamespace() { if self.nsp != "/" { self.engine?.send("0/\(self.nsp)", withData: nil) } } /** Removes handler(s) */ public func off(event:String) { self.handlers = self.handlers.filter {$0.event == event ? false : true} } /** Adds a handler for an event. */ public func on(name:String, callback:NormalCallback) { let handler = SocketEventHandler(event: name, callback: callback) self.handlers.append(handler) } /** Adds a handler that will be called on every event. */ public func onAny(handler:(SocketAnyEvent) -> Void) { self.anyHandler = handler } /** Same as connect */ public func open() { self.connect() } public func parseSocketMessage(msg:String) { SocketParser.parseSocketMessage(msg, socket: self) } public func parseBinaryData(data:NSData) { SocketParser.parseBinaryData(data, socket: self) } // Something happened while polling public func pollingDidFail(err:String) { if !self.reconnecting { self._connected = false self.handleEvent("reconnect", data: [err], isInternalMessage: true) self.tryReconnect() } } func removeAck(ack:SocketAckHandler) { self.ackHandlers = self.ackHandlers.filter {$0 === ack ? false : true} } // We lost connection and should attempt to reestablish func tryReconnect() { if self.reconnectAttempts != -1 && self.currentReconnectAttempt + 1 > self.reconnectAttempts { self.didForceClose("Reconnect Failed") return } else if self.connected { self._connecting = false self._reconnecting = false return } if self.reconnectTimer == nil { self._reconnecting = true dispatch_async(dispatch_get_main_queue()) {[weak self] in if self == nil { return } self?.reconnectTimer = NSTimer.scheduledTimerWithTimeInterval(Double(self!.reconnectWait), target: self!, selector: "tryReconnect", userInfo: nil, repeats: true) return } } self.handleEvent("reconnectAttempt", data: [self.reconnectAttempts - self.currentReconnectAttempt], isInternalMessage: true) self.currentReconnectAttempt++ if self.paramConnect { self.connectWithParams(self.params) } else { self.connect() } } // Called when the socket is closed public func webSocketDidCloseWithCode(code:Int, reason:String) { self._connected = false self._connecting = false if self.closed || !self.reconnects { self.didForceClose("WebSocket closed") } else if !self.reconnecting { self.handleEvent("reconnect", data: [reason], isInternalMessage: true) self.tryReconnect() } } // Called when an error occurs. public func webSocketDidFailWithError(error:NSError) { self._connected = false self._connecting = false self.handleEvent("error", data: [error.localizedDescription], isInternalMessage: true) if self.closed || !self.reconnects { self.didForceClose("WebSocket closed with an error \(error)") } else if !self.reconnecting { self.handleEvent("reconnect", data: [error.localizedDescription], isInternalMessage: true) self.tryReconnect() } } }