Merge remote-tracking branch 'socketio/swift-2'

This commit is contained in:
Lukas Schmidt 2015-09-04 07:50:18 +02:00
commit 6e43e58988
12 changed files with 149 additions and 123 deletions

View File

@ -1,3 +1,5 @@
[![Build Status](https://travis-ci.org/socketio/socket.io-client-swift.svg?branch=swift-2)](https://travis-ci.org/socketio/socket.io-client-swift)
#Socket.IO-Client-Swift #Socket.IO-Client-Swift
Socket.IO-client for iOS/OS X. Socket.IO-client for iOS/OS X.
@ -119,6 +121,7 @@ Options
- `nsp: String` Default is `"/"`. Connects to a namespace. - `nsp: String` Default is `"/"`. Connects to a namespace.
- `cookies: [NSHTTPCookie]?` An array of NSHTTPCookies. Passed during the handshake. Default is nil. - `cookies: [NSHTTPCookie]?` An array of NSHTTPCookies. Passed during the handshake. Default is nil.
- `log: Bool` If `true` socket will log debug messages. Default is false. - `log: Bool` If `true` socket will log debug messages. Default is false.
- `logger: SocketLogger` If you wish to implement your own logger that conforms to SocketLogger you can pass it in here. Will use the default logging defined under the protocol otherwise.
- `sessionDelegate: NSURLSessionDelegate` Sets an NSURLSessionDelegate for the underlying engine. Useful if you need to handle self-signed certs. Default is nil. - `sessionDelegate: NSURLSessionDelegate` Sets an NSURLSessionDelegate for the underlying engine. Useful if you need to handle self-signed certs. Default is nil.
- `path: String` - If the server uses a custom path. ex: `"/swift"`. Default is `""` - `path: String` - If the server uses a custom path. ex: `"/swift"`. Default is `""`
- `extraHeaders: [String: String]?` - Adds custom headers to the initial request. Default is nil. - `extraHeaders: [String: String]?` - Adds custom headers to the initial request. Default is nil.

View File

@ -1,6 +1,6 @@
// //
// AbstractSocketTest.swift // AbstractSocketTest.swift
// Socket.IO-Client-Swift // AbstractSocketTest.socket.IO-Client-Swift
// //
// Created by Lukas Schmidt on 02.08.15. // Created by Lukas Schmidt on 02.08.15.
// //
@ -9,23 +9,25 @@
import XCTest import XCTest
class AbstractSocketTest: XCTestCase { class AbstractSocketTest: XCTestCase {
static let serverURL = "milkbartube.com:6979"
static let TEST_TIMEOUT = 8.0 static let TEST_TIMEOUT = 8.0
var socket:SocketIOClient! static var socket:SocketIOClient!
var testKind:TestKind? var testKind:TestKind?
override func tearDown() {
super.tearDown()
socket.close(fast: false)
}
func openConnection() { func openConnection() {
let expection = self.expectationWithDescription("connect") guard AbstractSocketTest.socket.status == SocketIOClientStatus.NotConnected else {return}
XCTAssertTrue(socket.status == SocketIOClientStatus.NotConnected)
socket.on("connect") {data, ack in weak var expection = self.expectationWithDescription("connect")
XCTAssertTrue(AbstractSocketTest.socket.status == SocketIOClientStatus.NotConnected)
AbstractSocketTest.socket.on("connect") {data, ack in
XCTAssertEqual(AbstractSocketTest.socket.status, SocketIOClientStatus.Connected)
if let expection = expection {
expection.fulfill() expection.fulfill()
} }
socket.connect() }
XCTAssertEqual(socket.status, SocketIOClientStatus.Connecting) AbstractSocketTest.socket.connect()
XCTAssertEqual(AbstractSocketTest.socket.status, SocketIOClientStatus.Connecting)
waitForExpectationsWithTimeout(AbstractSocketTest.TEST_TIMEOUT, handler: nil) waitForExpectationsWithTimeout(AbstractSocketTest.TEST_TIMEOUT, handler: nil)
} }
@ -34,8 +36,8 @@ class AbstractSocketTest: XCTestCase {
} }
func checkConnectionStatus() { func checkConnectionStatus() {
XCTAssertEqual(socket.status, SocketIOClientStatus.Connected) XCTAssertEqual(AbstractSocketTest.socket.status, SocketIOClientStatus.Connected)
XCTAssertFalse(socket.secure) XCTAssertFalse(AbstractSocketTest.socket.secure)
} }
func socketMultipleEmit(testName:String, emitData:Array<AnyObject>, callback:NormalCallback){ func socketMultipleEmit(testName:String, emitData:Array<AnyObject>, callback:NormalCallback){
@ -48,8 +50,8 @@ class AbstractSocketTest: XCTestCase {
} }
} }
socket.emit(finalTestname, withItems: emitData) AbstractSocketTest.socket.emit(finalTestname, withItems: emitData)
socket.on(finalTestname + "Return", callback: didGetEmit) AbstractSocketTest.socket.on(finalTestname + "Return", callback: didGetEmit)
waitForExpectationsWithTimeout(SocketEmitTest.TEST_TIMEOUT, handler: nil) waitForExpectationsWithTimeout(SocketEmitTest.TEST_TIMEOUT, handler: nil)
} }
@ -65,11 +67,11 @@ class AbstractSocketTest: XCTestCase {
} }
socket.on(finalTestname + "Return", callback: didGetEmit) AbstractSocketTest.socket.on(finalTestname + "Return", callback: didGetEmit)
if let emitData = emitData { if let emitData = emitData {
socket.emit(finalTestname, emitData) AbstractSocketTest.socket.emit(finalTestname, emitData)
} else { } else {
socket.emit(finalTestname) AbstractSocketTest.socket.emit(finalTestname)
} }
waitForExpectationsWithTimeout(SocketEmitTest.TEST_TIMEOUT, handler: nil) waitForExpectationsWithTimeout(SocketEmitTest.TEST_TIMEOUT, handler: nil)
@ -85,7 +87,7 @@ class AbstractSocketTest: XCTestCase {
} }
} }
socket.emitWithAck(finalTestname, withItems: Data)(timeoutAfter: 5, callback: didGetResult) AbstractSocketTest.socket.emitWithAck(finalTestname, withItems: Data)(timeoutAfter: 5, callback: didGetResult)
waitForExpectationsWithTimeout(SocketEmitTest.TEST_TIMEOUT, handler: nil) waitForExpectationsWithTimeout(SocketEmitTest.TEST_TIMEOUT, handler: nil)
} }
@ -100,9 +102,9 @@ class AbstractSocketTest: XCTestCase {
} }
var ack:OnAckCallback! var ack:OnAckCallback!
if let Data = Data { if let Data = Data {
ack = socket.emitWithAck(finalTestname, Data) ack = AbstractSocketTest.socket.emitWithAck(finalTestname, Data)
} else { } else {
ack = socket.emitWithAck(finalTestname) ack = AbstractSocketTest.socket.emitWithAck(finalTestname)
} }
ack(timeoutAfter: 20, callback: didGet) ack(timeoutAfter: 20, callback: didGet)

View File

@ -13,13 +13,16 @@ class SocketAcknowledgementTest: AbstractSocketTest {
override func setUp() { override func setUp() {
super.setUp() super.setUp()
testKind = TestKind.Acknowledgement testKind = TestKind.Acknowledgement
socket = SocketIOClient(socketURL: "milkbartube.com:6979", opts: [ if AbstractSocketTest.socket == nil {
AbstractSocketTest.socket = SocketIOClient(socketURL: "milkbartube.com:6979", opts: [
"reconnects": true, // default true "reconnects": true, // default true
"reconnectAttempts": -1, // default -1 "reconnectAttempts": -1, // default -1
"reconnectWait": 5, // default 10 "reconnectWait": 5, // default 10
"forcePolling": false, "forcePolling": false,
"forceWebsockets": false,// default false "forceWebsockets": false,// default false
"path": ""]) "path": ""])
}
openConnection() openConnection()
} }

View File

@ -13,7 +13,8 @@ class SocketEmitTest: AbstractSocketTest {
override func setUp() { override func setUp() {
super.setUp() super.setUp()
testKind = TestKind.Emit testKind = TestKind.Emit
socket = SocketIOClient(socketURL: "milkbartube.com:6979", opts: [ if AbstractSocketTest.socket == nil {
AbstractSocketTest.socket = SocketIOClient(socketURL: AbstractSocketTest.serverURL, opts: [
"reconnects": true, // default true "reconnects": true, // default true
"reconnectAttempts": -1, // default -1 "reconnectAttempts": -1, // default -1
"reconnectWait": 5, // default 10 "reconnectWait": 5, // default 10
@ -21,11 +22,12 @@ class SocketEmitTest: AbstractSocketTest {
"forceWebsockets": false,// default false "forceWebsockets": false,// default false
"path": ""] "path": ""]
) )
}
openConnection() openConnection()
} }
override func tearDown() { override func tearDown() {
socket.close(fast: false)
super.tearDown() super.tearDown()
} }

View File

@ -13,7 +13,8 @@ class SocketNamespaceAcknowledgementTest: AbstractSocketTest {
override func setUp() { override func setUp() {
super.setUp() super.setUp()
testKind = TestKind.Acknowledgement testKind = TestKind.Acknowledgement
socket = SocketIOClient(socketURL: "milkbartube.com:6979", opts: [ if AbstractSocketTest.socket == nil {
AbstractSocketTest.socket = SocketIOClient(socketURL: AbstractSocketTest.serverURL, opts: [
"reconnects": true, // default true "reconnects": true, // default true
"reconnectAttempts": -1, // default -1 "reconnectAttempts": -1, // default -1
"reconnectWait": 5, // default 10 "reconnectWait": 5, // default 10
@ -21,6 +22,8 @@ class SocketNamespaceAcknowledgementTest: AbstractSocketTest {
"forceWebsockets": false,// default false "forceWebsockets": false,// default false
"path": "", "path": "",
"nsp": "/swift"]) "nsp": "/swift"])
}
openConnection() openConnection()
} }

View File

@ -13,7 +13,8 @@ class SocketNamespaceEmitTest: AbstractSocketTest {
override func setUp() { override func setUp() {
super.setUp() super.setUp()
testKind = TestKind.Emit testKind = TestKind.Emit
socket = SocketIOClient(socketURL: "milkbartube.com:6979", opts: [ if AbstractSocketTest.socket == nil {
AbstractSocketTest.socket = SocketIOClient(socketURL: AbstractSocketTest.serverURL, opts: [
"reconnects": true, // default true "reconnects": true, // default true
"reconnectAttempts": -1, // default -1 "reconnectAttempts": -1, // default -1
"reconnectWait": 5, // default 10 "reconnectWait": 5, // default 10
@ -21,6 +22,8 @@ class SocketNamespaceEmitTest: AbstractSocketTest {
"forceWebsockets": false,// default false "forceWebsockets": false,// default false
"path": "", "path": "",
"nsp": "/swift"]) "nsp": "/swift"])
}
openConnection() openConnection()
} }

View File

@ -25,6 +25,8 @@
import Foundation import Foundation
public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient { public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
public let logType = "SocketEngine"
private typealias Probe = (msg: String, type: PacketType, data: [NSData]?) private typealias Probe = (msg: String, type: PacketType, data: [NSData]?)
private typealias ProbeWaitQueue = [Probe] private typealias ProbeWaitQueue = [Probe]
@ -56,8 +58,6 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
private var waitingForPost = false private var waitingForPost = false
private var websocketConnected = false private var websocketConnected = false
let logType = "SocketEngine"
private(set) var connected = false private(set) var connected = false
private(set) var polling = true private(set) var polling = true
private(set) var websocket = false private(set) var websocket = false
@ -68,7 +68,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
var socketPath = "" var socketPath = ""
var urlPolling: String? var urlPolling: String?
var urlWebSocket: String? var urlWebSocket: String?
var ws:WebSocket? var ws: WebSocket?
public enum PacketType: Int { public enum PacketType: Int {
case Open, Close, Ping, Pong, Message, Upgrade, Noop case Open, Close, Ping, Pong, Message, Upgrade, Noop
@ -98,11 +98,11 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
} }
deinit { deinit {
SocketLogger.log("Engine is being deinit", client: self) Logger.log("Engine is being deinit", client: self, altType: nil)
} }
public func close(fast fast: Bool) { public func close(fast fast: Bool) {
SocketLogger.log("Engine is being closed. Fast: %@", client: self, args: fast) Logger.log("Engine is being closed. Fast: %@", client: self, altType: nil, args: fast)
pingTimer?.invalidate() pingTimer?.invalidate()
closed = true closed = true
@ -199,8 +199,8 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
private func doFastUpgrade() { private func doFastUpgrade() {
if waitingForPoll { if waitingForPoll {
SocketLogger.err("Outstanding poll when switched to WebSockets," + Logger.err("Outstanding poll when switched to WebSockets," +
"we'll probably disconnect soon. You should report this.", client: self) "we'll probably disconnect soon. You should report this.", client: self, altType: nil)
} }
sendWebSocketMessage("", withType: PacketType.Upgrade, datas: nil) sendWebSocketMessage("", withType: PacketType.Upgrade, datas: nil)
@ -240,7 +240,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
req.cachePolicy = NSURLRequestCachePolicy.ReloadIgnoringLocalAndRemoteCacheData req.cachePolicy = NSURLRequestCachePolicy.ReloadIgnoringLocalAndRemoteCacheData
SocketLogger.log("Doing polling request", client: self) Logger.log("Doing polling request", client: self, altType: nil)
session.dataTaskWithRequest(req) {[weak self] data, res, err in session.dataTaskWithRequest(req) {[weak self] data, res, err in
if let this = self { if let this = self {
@ -248,12 +248,12 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
if this.polling { if this.polling {
this.handlePollingFailed(err?.localizedDescription ?? "Error") this.handlePollingFailed(err?.localizedDescription ?? "Error")
} else { } else {
SocketLogger.err(err?.localizedDescription ?? "Error", client: this) Logger.err(err?.localizedDescription ?? "Error", client: this, altType: nil)
} }
return return
} }
SocketLogger.log("Got polling response", client: this) Logger.log("Got polling response", client: this, altType: nil)
if let str = NSString(data: data!, encoding: NSUTF8StringEncoding) as? String { if let str = NSString(data: data!, encoding: NSUTF8StringEncoding) as? String {
dispatch_async(this.parseQueue) {[weak this] in dispatch_async(this.parseQueue) {[weak this] in
@ -272,7 +272,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
} }
private func flushProbeWait() { private func flushProbeWait() {
SocketLogger.log("Flushing probe wait", client: self) Logger.log("Flushing probe wait", client: self, altType: nil)
dispatch_async(emitQueue) {[weak self] in dispatch_async(emitQueue) {[weak self] in
if let this = self { if let this = self {
@ -325,7 +325,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
waitingForPost = true waitingForPost = true
SocketLogger.log("POSTing: %@", client: self, args: postStr) Logger.log("POSTing: %@", client: self, altType: nil, args: postStr)
session.dataTaskWithRequest(req) {[weak self] data, res, err in session.dataTaskWithRequest(req) {[weak self] data, res, err in
if let this = self { if let this = self {
@ -412,7 +412,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
} }
} }
} catch { } catch {
SocketLogger.err("Error parsing open packet", client: self) Logger.err("Error parsing open packet", client: self, altType: nil)
return return
} }
@ -440,11 +440,6 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
waitingForPoll = false waitingForPoll = false
waitingForPost = false waitingForPost = false
// If cancelled we were already closing
if client == nil || reason == "cancelled" {
return
}
if !closed { if !closed {
client?.didError(reason) client?.didError(reason)
client?.engineDidClose(reason) client?.engineDidClose(reason)
@ -453,14 +448,14 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
public func open(opts: [String: AnyObject]? = nil) { public func open(opts: [String: AnyObject]? = nil) {
if connected { if connected {
SocketLogger.err("Tried to open while connected", client: self) Logger.err("Tried to open while connected", client: self, altType: nil)
client?.didError("Tried to open while connected") client?.didError("Tried to open while connected")
return return
} }
SocketLogger.log("Starting engine", client: self) Logger.log("Starting engine", client: self, altType: nil)
SocketLogger.log("Handshaking", client: self) Logger.log("Handshaking", client: self, altType: nil)
closed = false closed = false
@ -517,7 +512,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
length += chr length += chr
} else { } else {
if length == "" || testLength(length, n: &n) { if length == "" || testLength(length, n: &n) {
SocketLogger.err("Parsing error: %@", client: self, args: str) Logger.err("Parsing error: %@", client: self, altType: nil, args: str)
handlePollingFailed("Error parsing XHR message") handlePollingFailed("Error parsing XHR message")
return return
} }
@ -525,7 +520,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
msg = String(strArray[i+1...i+n]) msg = String(strArray[i+1...i+n])
if let lengthInt = Int(length) where lengthInt != msg.characters.count { if let lengthInt = Int(length) where lengthInt != msg.characters.count {
SocketLogger.err("Parsing error: %@", client: self, args: str) Logger.err("Parsing error: %@", client: self, altType: nil, args: str)
return return
} }
@ -547,7 +542,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
} }
private func parseEngineMessage(var message: String, fromPolling: Bool) { private func parseEngineMessage(var message: String, fromPolling: Bool) {
SocketLogger.log("Got message: %@", client: self, args: message) Logger.log("Got message: %@", client: self, altType: nil, args: message)
if fromPolling { if fromPolling {
fixDoubleUTF8(&message) fixDoubleUTF8(&message)
@ -572,7 +567,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
case PacketType.Close: case PacketType.Close:
handleClose() handleClose()
default: default:
SocketLogger.log("Got unknown packet type", client: self) Logger.log("Got unknown packet type", client: self, altType: nil)
} }
} }
@ -607,7 +602,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
/// Only call on emitQueue /// Only call on emitQueue
private func sendPollMessage(var msg: String, withType type: PacketType, private func sendPollMessage(var msg: String, withType type: PacketType,
datas:[NSData]? = nil) { datas:[NSData]? = nil) {
SocketLogger.log("Sending poll: %@ as type: %@", client: self, args: msg, type.rawValue) Logger.log("Sending poll: %@ as type: %@", client: self, altType: nil, args: msg, type.rawValue)
doubleEncodeUTF8(&msg) doubleEncodeUTF8(&msg)
let strMsg = "\(type.rawValue)\(msg)" let strMsg = "\(type.rawValue)\(msg)"
@ -631,7 +626,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
/// Only call on emitQueue /// Only call on emitQueue
private func sendWebSocketMessage(str: String, withType type: PacketType, private func sendWebSocketMessage(str: String, withType type: PacketType,
datas:[NSData]? = nil) { datas:[NSData]? = nil) {
SocketLogger.log("Sending ws: %@ as type: %@", client: self, args: str, type.rawValue) Logger.log("Sending ws: %@ as type: %@", client: self, altType: nil, args: str, type.rawValue)
ws?.writeString("\(type.rawValue)\(str)") ws?.writeString("\(type.rawValue)\(str)")
@ -666,7 +661,7 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
private func upgradeTransport() { private func upgradeTransport() {
if websocketConnected { if websocketConnected {
SocketLogger.log("Upgrading transport to WebSockets", client: self) Logger.log("Upgrading transport to WebSockets", client: self, altType: nil)
fastUpgrade = true fastUpgrade = true
sendPollMessage("", withType: PacketType.Noop) sendPollMessage("", withType: PacketType.Noop)
@ -681,11 +676,11 @@ public final class SocketEngine: NSObject, WebSocketDelegate, SocketLogClient {
dispatch_async(emitQueue) {[weak self] in dispatch_async(emitQueue) {[weak self] in
if let this = self where this.connected { if let this = self where this.connected {
if this.websocket { if this.websocket {
SocketLogger.log("Writing ws: %@ has data: %@", client: this, Logger.log("Writing ws: %@ has data: %@", client: this, altType: nil,
args: msg, data == nil ? false : true) args: msg, data == nil ? false : true)
this.sendWebSocketMessage(msg, withType: type, datas: data) this.sendWebSocketMessage(msg, withType: type, datas: data)
} else { } else {
SocketLogger.log("Writing poll: %@ has data: %@", client: this, Logger.log("Writing poll: %@ has data: %@", client: this, altType: nil,
args: msg, data == nil ? false : true) args: msg, data == nil ? false : true)
this.sendPollMessage(msg, withType: type, datas: data) this.sendPollMessage(msg, withType: type, datas: data)
} }

View File

@ -32,13 +32,13 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
private var reconnectTimer: NSTimer? private var reconnectTimer: NSTimer?
let reconnectAttempts: Int! let reconnectAttempts: Int!
let logType = "SocketClient"
var ackHandlers = SocketAckManager() var ackHandlers = SocketAckManager()
var currentAck = -1 var currentAck = -1
var waitingData = [SocketPacket]() var waitingData = [SocketPacket]()
public let emitQueue = dispatch_queue_create("emitQueue", DISPATCH_QUEUE_SERIAL) public let emitQueue = dispatch_queue_create("emitQueue", DISPATCH_QUEUE_SERIAL)
public let handleQueue: dispatch_queue_t! public let handleQueue: dispatch_queue_t!
public let logType = "SocketClient"
public let socketURL: String public let socketURL: String
public private(set) var engine: SocketEngine? public private(set) var engine: SocketEngine?
@ -71,8 +71,12 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
self.connectParams = connectParams self.connectParams = connectParams
} }
if let logger = opts?["logger"] as? SocketLogger {
Logger = logger
}
if let log = opts?["log"] as? Bool { if let log = opts?["log"] as? Bool {
SocketLogger.log = log Logger.log = log
} }
if let nsp = opts?["nsp"] as? String { if let nsp = opts?["nsp"] as? String {
@ -103,12 +107,12 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
} }
deinit { deinit {
SocketLogger.log("Client is being deinit", client: self) Logger.log("Client is being deinit", client: self, altType: nil)
engine?.close(fast: true) engine?.close(fast: true)
} }
private func addEngine() { private func addEngine() {
SocketLogger.log("Adding engine", client: self) Logger.log("Adding engine", client: self, altType: nil)
engine = SocketEngine(client: self, opts: opts) engine = SocketEngine(client: self, opts: opts)
} }
@ -124,7 +128,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
Pass true to fast if you're closing from a background task Pass true to fast if you're closing from a background task
*/ */
public func close(fast fast: Bool) { public func close(fast fast: Bool) {
SocketLogger.log("Closing socket", client: self) Logger.log("Closing socket", client: self, altType: nil)
reconnects = false reconnects = false
status = SocketIOClientStatus.Closed status = SocketIOClientStatus.Closed
@ -147,7 +151,8 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
return return
} }
if status == SocketIOClientStatus.Closed { if status == SocketIOClientStatus.Closed {
SocketLogger.log("Warning! This socket was previously closed. This might be dangerous!", client: self) Logger.log("Warning! This socket was previously closed. This might be dangerous!",
client: self, altType: nil)
} }
status = SocketIOClientStatus.Connecting status = SocketIOClientStatus.Connecting
@ -191,7 +196,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
} }
func didConnect() { func didConnect() {
SocketLogger.log("Socket connected", client: self) Logger.log("Socket connected", client: self, altType: nil)
status = SocketIOClientStatus.Connected status = SocketIOClientStatus.Connected
currentReconnectAttempt = 0 currentReconnectAttempt = 0
clearReconnectTimer() clearReconnectTimer()
@ -206,7 +211,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
return return
} }
SocketLogger.log("Disconnected: %@", client: self, args: reason) Logger.log("Disconnected: %@", client: self, altType: nil, args: reason)
status = SocketIOClientStatus.Closed status = SocketIOClientStatus.Closed
@ -219,7 +224,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
/// error /// error
public func didError(reason: AnyObject) { public func didError(reason: AnyObject) {
SocketLogger.err("%@", client: self, args: reason) Logger.err("%@", client: self, altType: nil, args: reason)
handleEvent("error", data: reason as? [AnyObject] ?? [reason], handleEvent("error", data: reason as? [AnyObject] ?? [reason],
isInternalMessage: true) isInternalMessage: true)
@ -275,7 +280,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
let packet = SocketPacket.packetFromEmit(data, id: ack ?? -1, nsp: nsp, ack: false) let packet = SocketPacket.packetFromEmit(data, id: ack ?? -1, nsp: nsp, ack: false)
let str = packet.packetString let str = packet.packetString
SocketLogger.log("Emitting: %@", client: self, args: str) Logger.log("Emitting: %@", client: self, altType: nil, args: str)
if packet.type == SocketPacket.PacketType.BinaryEvent { if packet.type == SocketPacket.PacketType.BinaryEvent {
engine?.send(str, withData: packet.binary) engine?.send(str, withData: packet.binary)
@ -291,7 +296,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
let packet = SocketPacket.packetFromEmit(items, id: ack ?? -1, nsp: this.nsp, ack: true) let packet = SocketPacket.packetFromEmit(items, id: ack ?? -1, nsp: this.nsp, ack: true)
let str = packet.packetString let str = packet.packetString
SocketLogger.log("Emitting Ack: %@", client: this, args: str) Logger.log("Emitting Ack: %@", client: this, altType: nil, args: str)
if packet.type == SocketPacket.PacketType.BinaryAck { if packet.type == SocketPacket.PacketType.BinaryAck {
this.engine?.send(str, withData: packet.binary) this.engine?.send(str, withData: packet.binary)
@ -317,8 +322,8 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
// Called when the socket gets an ack for something it sent // Called when the socket gets an ack for something it sent
func handleAck(ack: Int, data: AnyObject?) { func handleAck(ack: Int, data: AnyObject?) {
SocketLogger.log("Handling ack: %@ with data: %@", client: self, Logger.log("Handling ack: %@ with data: %@", client: self,
args: ack, data ?? "") altType: nil, args: ack, data ?? "")
ackHandlers.executeAck(ack, ackHandlers.executeAck(ack,
items: (data as? [AnyObject]?) ?? (data != nil ? [data!] : nil)) items: (data as? [AnyObject]?) ?? (data != nil ? [data!] : nil))
@ -334,8 +339,8 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
} }
// println("Should do event: \(event) with data: \(data)") // println("Should do event: \(event) with data: \(data)")
SocketLogger.log("Handling event: %@ with data: %@", client: self, Logger.log("Handling event: %@ with data: %@", client: self,
args: event, data ?? "") altType: nil, args: event, data ?? "")
if anyHandler != nil { if anyHandler != nil {
dispatch_async(handleQueue) {[weak self] in dispatch_async(handleQueue) {[weak self] in
@ -370,7 +375,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
Joins nsp if it is not / Joins nsp if it is not /
*/ */
public func joinNamespace() { public func joinNamespace() {
SocketLogger.log("Joining namespace", client: self) Logger.log("Joining namespace", client: self, altType: nil)
if nsp != "/" { if nsp != "/" {
engine?.send("0\(nsp)", withData: nil) engine?.send("0\(nsp)", withData: nil)
@ -389,7 +394,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
Removes handler(s) Removes handler(s)
*/ */
public func off(event: String) { public func off(event: String) {
SocketLogger.log("Removing handler for event: %@", client: self, args: event) Logger.log("Removing handler for event: %@", client: self, altType: nil, args: event)
handlers = ContiguousArray(handlers.filter {!($0.event == event)}) handlers = ContiguousArray(handlers.filter {!($0.event == event)})
} }
@ -398,7 +403,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
Adds a handler for an event. Adds a handler for an event.
*/ */
public func on(event: String, callback: NormalCallback) { public func on(event: String, callback: NormalCallback) {
SocketLogger.log("Adding handler for event: %@", client: self, args: event) Logger.log("Adding handler for event: %@", client: self, altType: nil, args: event)
let handler = SocketEventHandler(event: event, callback: callback) let handler = SocketEventHandler(event: event, callback: callback)
handlers.append(handler) handlers.append(handler)
@ -408,7 +413,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
Adds a handler for an event. Adds a handler for an event.
*/ */
public func onObjectiveC(event: String, callback: NormalCallbackObjectiveC) { public func onObjectiveC(event: String, callback: NormalCallbackObjectiveC) {
SocketLogger.log("Adding handler for event: %@", client: self, args: event) Logger.log("Adding handler for event: %@", client: self, altType: nil, args: event)
let handler = SocketEventHandler(event: event, callback: callback) let handler = SocketEventHandler(event: event, callback: callback)
handlers.append(handler) handlers.append(handler)
@ -462,7 +467,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
private func tryReconnect() { private func tryReconnect() {
if reconnectTimer == nil { if reconnectTimer == nil {
SocketLogger.log("Starting reconnect", client: self) Logger.log("Starting reconnect", client: self, altType: nil)
status = SocketIOClientStatus.Reconnecting status = SocketIOClientStatus.Reconnecting
@ -490,7 +495,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient, SocketLogClient
return return
} }
SocketLogger.log("Trying to reconnect", client: self) Logger.log("Trying to reconnect", client: self, altType: nil)
handleEvent("reconnectAttempt", data: [reconnectAttempts - currentReconnectAttempt], handleEvent("reconnectAttempt", data: [reconnectAttempts - currentReconnectAttempt],
isInternalMessage: true) isInternalMessage: true)

View File

@ -47,5 +47,4 @@ import Foundation
} }
case NotConnected, Closed, Connecting, Connected, Reconnecting case NotConnected, Closed, Connecting, Connected, Reconnecting
} }

View File

@ -24,41 +24,48 @@
import Foundation import Foundation
protocol SocketLogClient { var Logger: SocketLogger = DefaultSocketLogger()
public protocol SocketLogClient {
/// The type of object being logged
var logType: String {get} var logType: String {get}
} }
final class SocketLogger { public protocol SocketLogger {
private static let printQueue = dispatch_queue_create("printQueue", DISPATCH_QUEUE_SERIAL) /// Whether to log or not
static var log = false var log: Bool {get set}
private static func toCVArgType(item: AnyObject) -> CVarArgType { /// Normal log messages
return String(item) func log(message: String, client: SocketLogClient, altType: String?, args: AnyObject...)
}
static func log(message: String, client: SocketLogClient, altType: String? = nil, args: AnyObject...) { /// Error Messages
func err(message: String, client: SocketLogClient, altType: String?, args: AnyObject...)
}
public extension SocketLogger {
func log(message: String, client: SocketLogClient, altType: String?, args: AnyObject...) {
if !log { if !log {
return return
} }
dispatch_async(printQueue) {[type = client.logType] in let newArgs = args.map {arg -> CVarArgType in String(arg)}
let newArgs = args.map(SocketLogger.toCVArgType)
let replaced = String(format: message, arguments: newArgs) let replaced = String(format: message, arguments: newArgs)
NSLog("%@: %@", altType ?? type, replaced) NSLog("%@: %@", altType ?? client.logType, replaced)
}
} }
static func err(message: String, client: SocketLogClient, altType: String? = nil, args: AnyObject...) { func err(message: String, client: SocketLogClient, altType: String?, args: AnyObject...) {
if !log { if !log {
return return
} }
dispatch_async(printQueue) {[type = client.logType] in let newArgs = args.map {arg -> CVarArgType in String(arg)}
let newArgs = args.map(SocketLogger.toCVArgType)
let replaced = String(format: message, arguments: newArgs) let replaced = String(format: message, arguments: newArgs)
NSLog("ERROR %@: %@", altType ?? type, replaced) NSLog("ERROR %@: %@", altType ?? client.logType, replaced)
}
} }
} }
struct DefaultSocketLogger: SocketLogger {
var log = false
}

View File

@ -177,7 +177,7 @@ class SocketParser {
return return
} }
SocketLogger.log("Parsing %@", client: socket, altType: "SocketParser", args: stringMessage) Logger.log("Parsing %@", client: socket, altType: "SocketParser", args: stringMessage)
let p: SocketPacket let p: SocketPacket
@ -188,7 +188,7 @@ class SocketParser {
return return
} }
SocketLogger.log("Decoded packet as: %@", client: socket, altType: "SocketParser", args: p.description) Logger.log("Decoded packet as: %@", client: socket, altType: "SocketParser", args: p.description)
switch p.type { switch p.type {
case SocketPacket.PacketType.Event: case SocketPacket.PacketType.Event:
@ -210,7 +210,7 @@ class SocketParser {
static func parseBinaryData(data: NSData, socket: SocketIOClient) { static func parseBinaryData(data: NSData, socket: SocketIOClient) {
if socket.waitingData.count == 0 { if socket.waitingData.count == 0 {
SocketLogger.err("Got data when not remaking packet", client: socket, altType: "SocketParser") Logger.err("Got data when not remaking packet", client: socket, altType: "SocketParser")
return return
} }

View File

@ -67,7 +67,7 @@ public class WebSocket : NSObject, NSStreamDelegate {
let headerWSKeyName = "Sec-WebSocket-Key" let headerWSKeyName = "Sec-WebSocket-Key"
let headerOriginName = "Origin" let headerOriginName = "Origin"
let headerWSAcceptName = "Sec-WebSocket-Accept" let headerWSAcceptName = "Sec-WebSocket-Accept"
let BUFFER_MAX = 2048 let BUFFER_MAX = 4096
let FinMask: UInt8 = 0x80 let FinMask: UInt8 = 0x80
let OpCodeMask: UInt8 = 0x0F let OpCodeMask: UInt8 = 0x0F
let RSVMask: UInt8 = 0x70 let RSVMask: UInt8 = 0x70
@ -133,13 +133,15 @@ public class WebSocket : NSObject, NSStreamDelegate {
if isCreated { if isCreated {
return return
} }
unowned let weakSelf = self
dispatch_async(queue,{ dispatch_async(queue,{
self.didDisconnect = false weakSelf.didDisconnect = false
}) })
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT,0), { dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT,0), {
self.isCreated = true weakSelf.isCreated = true
self.createHTTPRequest() weakSelf.createHTTPRequest()
self.isCreated = false weakSelf.isCreated = false
}) })
} }
@ -318,8 +320,8 @@ public class WebSocket : NSObject, NSStreamDelegate {
let length = inputStream!.read(buffer, maxLength: BUFFER_MAX) let length = inputStream!.read(buffer, maxLength: BUFFER_MAX)
if length > 0 { if length > 0 {
if !connected { if !connected {
connected = processHTTP(buffer, bufferLen: length) let status = processHTTP(buffer, bufferLen: length)
if !connected { if !status {
self.doDisconnect(self.errorWithDetail("Invalid HTTP upgrade", code: 1)) self.doDisconnect(self.errorWithDetail("Invalid HTTP upgrade", code: 1))
} }
} else { } else {
@ -368,12 +370,14 @@ public class WebSocket : NSObject, NSStreamDelegate {
} }
} }
if totalSize > 0 { if totalSize > 0 {
unowned let weakSelf = self
if validateResponse(buffer, bufferLen: totalSize) { if validateResponse(buffer, bufferLen: totalSize) {
dispatch_async(queue,{ dispatch_async(queue,{
if let connectBlock = self.onConnect { weakSelf.connected = true
if let connectBlock = weakSelf.onConnect {
connectBlock() connectBlock()
} }
self.delegate?.websocketDidConnect(self) weakSelf.delegate?.websocketDidConnect(self)
}) })
totalSize += 1 //skip the last \n totalSize += 1 //skip the last \n
let restSize = bufferLen - totalSize let restSize = bufferLen - totalSize
@ -511,7 +515,7 @@ public class WebSocket : NSObject, NSStreamDelegate {
data = NSData(bytes: UnsafePointer<UInt8>((buffer+offset)), length: Int(len)) data = NSData(bytes: UnsafePointer<UInt8>((buffer+offset)), length: Int(len))
} }
if receivedOpcode == OpCode.Pong.rawValue { if receivedOpcode == OpCode.Pong.rawValue {
dispatch_async(queue,{ dispatch_async(queue,{[unowned self] in
if let pongBlock = self.onPong { if let pongBlock = self.onPong {
pongBlock() pongBlock()
} }
@ -604,7 +608,7 @@ public class WebSocket : NSObject, NSStreamDelegate {
writeError(CloseCode.Encoding.rawValue) writeError(CloseCode.Encoding.rawValue)
return false return false
} }
dispatch_async(queue,{ dispatch_async(queue,{[unowned self] in
if let textBlock = self.onText { if let textBlock = self.onText {
textBlock(str! as String) textBlock(str! as String)
} }
@ -612,7 +616,7 @@ public class WebSocket : NSObject, NSStreamDelegate {
}) })
} else if response.code == .BinaryFrame { } else if response.code == .BinaryFrame {
let data = response.buffer! //local copy so it is perverse for writing let data = response.buffer! //local copy so it is perverse for writing
dispatch_async(queue,{ dispatch_async(queue,{[unowned self] in
if let dataBlock = self.onData { if let dataBlock = self.onData {
dataBlock(data) dataBlock(data)
} }
@ -719,7 +723,7 @@ public class WebSocket : NSObject, NSStreamDelegate {
///used to preform the disconnect delegate ///used to preform the disconnect delegate
private func doDisconnect(error: NSError?) { private func doDisconnect(error: NSError?) {
if !self.didDisconnect { if !self.didDisconnect {
dispatch_async(queue,{ dispatch_async(queue,{[unowned self] in
self.didDisconnect = true self.didDisconnect = true
if let disconnect = self.onDisconnect { if let disconnect = self.onDisconnect {
disconnect(error) disconnect(error)