add comments

This commit is contained in:
Erik 2015-10-17 14:58:47 -04:00
parent 7382030dff
commit a5db43b834

View File

@ -55,7 +55,7 @@ public final class SocketIOClient: NSObject, SocketEngineClient {
var waitingData = [SocketPacket]() var waitingData = [SocketPacket]()
/** /**
Create a new SocketIOClient. opts can be omitted Type safe way to create a new SocketIOClient. opts can be omitted
*/ */
public init(var socketURL: String, opts: SocketOptionsDictionary? = nil) { public init(var socketURL: String, opts: SocketOptionsDictionary? = nil) {
if socketURL["https://"].matches().count != 0 { if socketURL["https://"].matches().count != 0 {
@ -107,6 +107,10 @@ public final class SocketIOClient: NSObject, SocketEngineClient {
super.init() super.init()
} }
/**
Not so type safe way to create a SocketIOClient, meant for Objective-C compatiblity.
If using Swift it's recommended to use `init(var socketURL: String, opts: SocketOptionsDictionary? = nil)`
*/
public convenience init(socketURL: String, opts: NSDictionary?) { public convenience init(socketURL: String, opts: NSDictionary?) {
self.init(socketURL: socketURL, self.init(socketURL: socketURL,
opts: SocketIOClientOptions.NSDictionaryToSocketOptionsDictionary(opts ?? [:])) opts: SocketIOClientOptions.NSDictionaryToSocketOptionsDictionary(opts ?? [:]))