diff --git a/Socket.IO-Client-Swift.podspec b/Socket.IO-Client-Swift.podspec index b16f359..adebe23 100644 --- a/Socket.IO-Client-Swift.podspec +++ b/Socket.IO-Client-Swift.podspec @@ -1,7 +1,7 @@ Pod::Spec.new do |s| s.name = "Socket.IO-Client-Swift" s.module_name = "SocketIO" - s.version = "13.4.0" + s.version = "14.0.0" s.summary = "Socket.IO-client for iOS and OS X" s.description = <<-DESC Socket.IO-client for iOS and OS X. @@ -18,13 +18,13 @@ Pod::Spec.new do |s| s.requires_arc = true s.source = { :git => "https://github.com/socketio/socket.io-client-swift.git", - :tag => 'v13.4.0', + :tag => 'v14.0.0', :submodules => true } s.swift_version = "4.2" s.pod_target_xcconfig = { - 'SWIFT_VERSION' => '4.0' + 'SWIFT_VERSION' => '4.2' } s.source_files = "Source/SocketIO/**/*.swift", "Source/SocketIO/*.swift" s.dependency "Starscream", "~> 3.0.6" diff --git a/docs/12to13.html b/docs/12to13.html index aca489a..3e4f3dd 100644 --- a/docs/12to13.html +++ b/docs/12to13.html @@ -283,8 +283,8 @@ and a connect event fired.

diff --git a/docs/Classes.html b/docs/Classes.html index 93b9d3a..4d22288 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -14,6 +14,7 @@ + @@ -192,39 +193,6 @@
-
- -
  • @@ -368,88 +336,6 @@ Example:

-
-
    -
  • -
    - - - - SSLSecurity - -
    -
    -
    -
    -
    -
    -

    A wrapper around Starscream’s SSLSecurity that provides a minimal Objective-C interface.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open class SSLSecurity : NSObject
    - -
    -
    -
    -
    -
  • -
-
-
-
    -
  • -
    - - - - SocketManager - -
    -
    -
    -
    -
    -
    -

    A manager for a socket.io connection.

    - -

    A SocketManager is responsible for multiplexing multiple namespaces through a single SocketEngineSpec.

    - -

    Example:

    -
    let manager = SocketManager(socketURL: URL(string:"http://localhost:8080/")!)
    -let defaultNamespaceSocket = manager.defaultSocket
    -let swiftSocket = manager.socket(forNamespace: "/swift")
    -
    -// defaultNamespaceSocket and swiftSocket both share a single connection to the server
    -
    - -

    Sockets created through the manager are retained by the manager. So at the very least, a single strong reference -to the manager must be maintained to keep sockets alive.

    - -

    To disconnect a socket and remove it from the manager, either call SocketIOClient.disconnect() on the socket, -or call one of the disconnectSocket methods on this class.

    - -

    NOTE: The manager is not thread/queue safe, all interaction with the manager should be done on the handleQueue

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open class SocketManager : NSObject, SocketManagerSpec, SocketParsable, SocketDataBufferable, ConfigSettable
    - -
    -
    -
    -
    -
  • -
-
  • @@ -518,14 +404,129 @@ or call one of the disconnectSocket methods on this class.

+
+ +
+
+
    +
  • +
    + + + + SocketManager + +
    +
    +
    +
    +
    +
    +

    A manager for a socket.io connection.

    + +

    A SocketManager is responsible for multiplexing multiple namespaces through a single SocketEngineSpec.

    + +

    Example:

    +
    let manager = SocketManager(socketURL: URL(string:"http://localhost:8080/")!)
    +let defaultNamespaceSocket = manager.defaultSocket
    +let swiftSocket = manager.socket(forNamespace: "/swift")
    +
    +// defaultNamespaceSocket and swiftSocket both share a single connection to the server
    +
    + +

    Sockets created through the manager are retained by the manager. So at the very least, a single strong reference +to the manager must be maintained to keep sockets alive.

    + +

    To disconnect a socket and remove it from the manager, either call SocketIOClient.disconnect() on the socket, +or call one of the disconnectSocket methods on this class.

    + +

    NOTE: The manager is not thread/queue safe, all interaction with the manager should be done on the handleQueue

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    open class SocketManager : NSObject, SocketManagerSpec, SocketParsable, SocketDataBufferable, ConfigSettable
    + +
    +
    +
    +
    +
  • +
+
+
+
    +
  • +
    + + + + SSLSecurity + +
    +
    +
    +
    +
    +
    +

    A wrapper around Starscream’s SSLSecurity that provides a minimal Objective-C interface.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    open class SSLSecurity : NSObject
    + +
    +
    +
    +
    +
  • +
+
diff --git a/docs/Classes/OnAckCallback.html b/docs/Classes/OnAckCallback.html index 6af5167..eb51f11 100644 --- a/docs/Classes/OnAckCallback.html +++ b/docs/Classes/OnAckCallback.html @@ -234,7 +234,8 @@ Example:

Declaration

Swift

-
public func timingOut(after seconds: Double, callback: @escaping AckCallback)
+
@objc
+public func timingOut(after seconds: Double, callback: @escaping AckCallback)
@@ -281,8 +282,8 @@ Example:

diff --git a/docs/Classes/SSLSecurity.html b/docs/Classes/SSLSecurity.html index 32af9c3..f4eaaef 100644 --- a/docs/Classes/SSLSecurity.html +++ b/docs/Classes/SSLSecurity.html @@ -267,7 +267,8 @@ pinning validation

Declaration

Swift

-
public convenience init(usePublicKeys: Bool = true)
+
@objc
+public convenience init(usePublicKeys: Bool = true)
@@ -427,8 +428,8 @@ validation

diff --git a/docs/Classes/SocketAckEmitter.html b/docs/Classes/SocketAckEmitter.html index 84f33c3..4a762b1 100644 --- a/docs/Classes/SocketAckEmitter.html +++ b/docs/Classes/SocketAckEmitter.html @@ -229,7 +229,8 @@

Declaration

Swift

-
public private(set) lazy var rawEmitView = SocketRawAckView(socket: socket, ackNum: ackNum)
+
@objc
+public private(set) lazy var rawEmitView: SocketRawAckView { get set }
@@ -267,7 +268,7 @@

Declaration

Swift

-
public var expected: Bool
+
public var expected: Bool { get }
@@ -423,7 +424,8 @@ will be emitted. The structure of the error data is [ackNum, items, theErr

Declaration

Swift

-
public func with(_ items: [Any])
+
@objc
+public func with(_ items: [Any])
@@ -457,8 +459,8 @@ will be emitted. The structure of the error data is [ackNum, items, theErr diff --git a/docs/Classes/SocketAnyEvent.html b/docs/Classes/SocketAnyEvent.html index d8e285d..a0d48c6 100644 --- a/docs/Classes/SocketAnyEvent.html +++ b/docs/Classes/SocketAnyEvent.html @@ -228,7 +228,8 @@

Declaration

Swift

-
public let event: String
+
@objc
+public let event: String
@@ -255,7 +256,8 @@

Declaration

Swift

-
public let items: [Any]?
+
@objc
+public let items: [Any]?
@@ -282,7 +284,7 @@

Declaration

Swift

-
override public var description: String
+
override public var description: String { get }
@@ -297,8 +299,8 @@ diff --git a/docs/Classes/SocketEngine.html b/docs/Classes/SocketEngine.html index 7108424..4d54155 100644 --- a/docs/Classes/SocketEngine.html +++ b/docs/Classes/SocketEngine.html @@ -229,7 +229,7 @@ See SocketEnginePollable<

Declaration

Swift

-
public let engineQueue = DispatchQueue(label: "com.socketio.engineHandleQueue")
+
public let engineQueue: DispatchQueue
@@ -256,7 +256,7 @@ See
SocketEnginePollable<

Declaration

Swift

-
public var connectParams: [String: Any]?
+
public var connectParams: [String : Any]? { get set }
@@ -283,7 +283,7 @@ See
SocketEnginePollable<

Declaration

Swift

-
public var extraHeaders: [String: String]?
+
public var extraHeaders: [String : String]?
@@ -312,7 +312,7 @@ See
SocketEnginePollable<

Declaration

Swift

-
public var postWait = [Post]()
+
public var postWait: [Post]
@@ -342,7 +342,7 @@ disconnect us.

Declaration

Swift

-
public var waitingForPoll = false
+
public var waitingForPoll: Bool
@@ -372,7 +372,7 @@ disconnect us.

Declaration

Swift

-
public var waitingForPost = false
+
public var waitingForPost: Bool
@@ -399,7 +399,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var closed = false
+
public private(set) var closed: Bool
@@ -426,7 +426,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var compress = false
+
public private(set) var compress: Bool
@@ -453,7 +453,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var connected = false
+
public private(set) var connected: Bool
@@ -509,7 +509,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var fastUpgrade = false
+
public private(set) var fastUpgrade: Bool
@@ -536,7 +536,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var forcePolling = false
+
public private(set) var forcePolling: Bool
@@ -563,7 +563,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var forceWebsockets = false
+
public private(set) var forceWebsockets: Bool
@@ -590,7 +590,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var invalidated = false
+
public private(set) var invalidated: Bool
@@ -617,7 +617,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var polling = true
+
public private(set) var polling: Bool
@@ -644,7 +644,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var probing = false
+
public private(set) var probing: Bool
@@ -698,7 +698,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var sid = ""
+
public private(set) var sid: String
@@ -725,7 +725,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var socketPath = "/engine.io/"
+
public private(set) var socketPath: String
@@ -752,7 +752,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var urlPolling = URL(string: "http://localhost/")!
+
public private(set) var urlPolling: URL
@@ -779,7 +779,7 @@ disconnect us.

Declaration

Swift

-
public private(set) var urlWebSocket = URL(string: "http://localhost/")!
+
public private(set) var urlWebSocket: URL
@@ -806,7 +806,8 @@ disconnect us.

Declaration

Swift

-
public private(set) var websocket = false
+
@available(*, deprecated, message: "No longer needed, if we're not polling, then we must be doing websockets")
+public private(set) var websocket: Bool
@@ -968,7 +969,7 @@ disconnect us.

Declaration

Swift

-
public required convenience init(client: SocketEngineClient, url: URL, options: [String: Any]?)
+
public required convenience init(client: SocketEngineClient, url: URL, options: [String : Any]?)
@@ -1438,8 +1439,8 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

diff --git a/docs/Classes/SocketIOClient.html b/docs/Classes/SocketIOClient.html index 88ca8e9..3291ad3 100644 --- a/docs/Classes/SocketIOClient.html +++ b/docs/Classes/SocketIOClient.html @@ -241,7 +241,8 @@

Declaration

Swift

-
public let nsp: String
+
@objc
+public let nsp: String
@@ -268,7 +269,8 @@

Declaration

Swift

-
public var sid: String
+
@objc
+public var sid: String { get }
@@ -322,7 +324,7 @@

Declaration

Swift

-
public private(set) var handlers = [SocketEventHandler]()
+
public private(set) var handlers: [SocketEventHandler]
@@ -349,7 +351,8 @@

Declaration

Swift

-
public private(set) weak var manager: SocketManagerSpec?
+
@objc
+public private(set) weak var manager: SocketManagerSpec?
@@ -382,7 +385,8 @@

Declaration

Swift

-
public private(set) lazy var rawEmitView = SocketRawView(socket: self)
+
@objc
+public private(set) lazy var rawEmitView: SocketRawView { get set }
@@ -409,7 +413,8 @@

Declaration

Swift

-
public private(set) var status = SocketIOStatus.notConnected
+
@objc
+public private(set) var status: SocketIOStatus { get set }
@@ -447,7 +452,8 @@

Declaration

Swift

-
public init(manager: SocketManagerSpec, nsp: String)
+
@objc
+public init(manager: SocketManagerSpec, nsp: String)
@@ -518,7 +524,8 @@

Declaration

Swift

-
open func connect()
+
@objc
+open func connect()
@@ -547,7 +554,8 @@

Declaration

Swift

-
open func connect(timeoutAfter: Double, withHandler handler: (() -> ())?)
+
@objc
+open func connect(timeoutAfter: Double, withHandler handler: (() -> ())?)
@@ -702,7 +710,8 @@ then this is only called when the client connects to that namespace.

Declaration

Swift

-
open func disconnect()
+
@objc
+open func disconnect()
@@ -802,7 +811,8 @@ will be emitted. The structure of the error data is [eventName, items, the

Declaration

Swift

-
open func emit(_ event: String, with items: [Any])
+
@objc
+open func emit(_ event: String, with items: [Any])
@@ -860,7 +870,8 @@ will be emitted. The structure of the error data is [eventName, items, the

Declaration

Swift

-
open func emit(_ event: String, with items: [Any], completion: (() -> ())? = nil)
+
@objc
+open func emit(_ event: String, with items: [Any], completion: (() -> ())? = nil)
@@ -1013,7 +1024,8 @@ Check that your server’s api will ack the event being sent.

Declaration

Swift

-
open func emitWithAck(_ event: String, with items: [Any]) -> OnAckCallback
+
@objc
+open func emitWithAck(_ event: String, with items: [Any]) -> OnAckCallback
@@ -1135,7 +1147,8 @@ Check that your server’s api will ack the event being sent.

Declaration

Swift

-
open func handleAck(_ ack: Int, data: [Any])
+
@objc
+open func handleAck(_ ack: Int, data: [Any])
@@ -1251,7 +1264,8 @@ Check that your server’s api will ack the event being sent.

Declaration

Swift

-
open func handleEvent(_ event: String, data: [Any], isInternalMessage: Bool, withAck ack: Int = -1)
+
@objc
+open func handleEvent(_ event: String, data: [Any], isInternalMessage: Bool, withAck ack: Int = -1)
@@ -1380,7 +1394,8 @@ socket.

Declaration

Swift

-
open func leaveNamespace()
+
@objc
+open func leaveNamespace()
@@ -1407,7 +1422,8 @@ socket.

Declaration

Swift

-
open func joinNamespace()
+
@objc
+open func joinNamespace()
@@ -1484,7 +1500,8 @@ socket.

Declaration

Swift

-
open func off(_ event: String)
+
@objc
+open func off(_ event: String)
@@ -1532,7 +1549,8 @@ socket.

Declaration

Swift

-
open func off(id: UUID)
+
@objc
+open func off(id: UUID)
@@ -1578,7 +1596,9 @@ socket.

Declaration

Swift

-
open func on(_ event: String, callback: @escaping NormalCallback) -> UUID
+
@discardableResult
+@objc
+open func on(_ event: String, callback: @escaping NormalCallback) -> UUID
@@ -1646,7 +1666,8 @@ socket.

Declaration

Swift

-
open func on(clientEvent event: SocketClientEvent, callback: @escaping NormalCallback) -> UUID
+
@discardableResult
+open func on(clientEvent event: SocketClientEvent, callback: @escaping NormalCallback) -> UUID
@@ -1708,7 +1729,8 @@ socket.

Declaration

Swift

-
open func once(clientEvent event: SocketClientEvent, callback: @escaping NormalCallback) -> UUID
+
@discardableResult
+open func once(clientEvent event: SocketClientEvent, callback: @escaping NormalCallback) -> UUID
@@ -1770,7 +1792,9 @@ socket.

Declaration

Swift

-
open func once(_ event: String, callback: @escaping NormalCallback) -> UUID
+
@discardableResult
+@objc
+open func once(_ event: String, callback: @escaping NormalCallback) -> UUID
@@ -1832,7 +1856,8 @@ socket.

Declaration

Swift

-
open func onAny(_ handler: @escaping (SocketAnyEvent) -> ())
+
@objc
+open func onAny(_ handler: @escaping (SocketAnyEvent) -> ())
@@ -1880,7 +1905,8 @@ socket.

Declaration

Swift

-
open func removeAllHandlers()
+
@objc
+open func removeAllHandlers()
@@ -1908,7 +1934,8 @@ Called when the manager detects a broken connection, or when a manual reconnect

Declaration

Swift

-
open func setReconnecting(reason: String)
+
@objc
+open func setReconnecting(reason: String)
@@ -1942,8 +1969,8 @@ Called when the manager detects a broken connection, or when a manual reconnect diff --git a/docs/Classes/SocketManager.html b/docs/Classes/SocketManager.html index 52acd4a..e86db9a 100644 --- a/docs/Classes/SocketManager.html +++ b/docs/Classes/SocketManager.html @@ -246,7 +246,7 @@ or call one of the disconnectSocket methods on this class.

Declaration

Swift

-
public var defaultSocket: SocketIOClient
+
public var defaultSocket: SocketIOClient { get }
@@ -305,7 +305,7 @@ init.

Declaration

Swift

-
public var config: SocketIOClientConfiguration
+
public var config: SocketIOClientConfiguration { get set }
@@ -359,7 +359,7 @@ init.

Declaration

Swift

-
public var forceNew = false
+
public var forceNew: Bool
@@ -389,7 +389,7 @@ called on.

Declaration

Swift

-
public var handleQueue = DispatchQueue.main
+
public var handleQueue: DispatchQueue
@@ -416,7 +416,7 @@ called on.

Declaration

Swift

-
public var nsps = [String: SocketIOClient]()
+
public var nsps: [String : SocketIOClient]
@@ -443,7 +443,7 @@ called on.

Declaration

Swift

-
public var reconnects = true
+
public var reconnects: Bool
@@ -463,14 +463,68 @@ called on.

-

The number of seconds to wait before attempting to reconnect.

+

The minimum number of seconds to wait before attempting to reconnect.

Declaration

Swift

-
public var reconnectWait = 10
+
public var reconnectWait: Int
+ +
+
+
+ + +
  • +
    + + + + reconnectWaitMax + +
    +
    +
    +
    +
    +
    +

    The maximum number of seconds to wait before attempting to reconnect.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var reconnectWaitMax: Int
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + randomizationFactor + +
    +
    +
    +
    +
    +
    +

    The randomization factor for calculating reconnect jitter.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public var randomizationFactor: Double
    @@ -497,7 +551,7 @@ called on.

    Declaration

    Swift

    -
    public private(set) var status: SocketIOStatus = .notConnected
    +
    public private(set) var status: SocketIOStatus { get set }
    @@ -529,7 +583,7 @@ So this should ideally be an array of one packet waiting for data.

    Declaration

    Swift

    -
    public var waitingPackets = [SocketPacket]()
    +
    public var waitingPackets: [SocketPacket]
    @@ -626,7 +680,8 @@ If using Swift it’s recommended to use init(socketURL: NSURL, option

    Declaration

    Swift

    -
    public convenience init(socketURL: URL, config: [String: Any]?)
    +
    @objc
    +public convenience init(socketURL: URL, config: [String : Any]?)
    @@ -1297,7 +1352,7 @@ releasing.

    Declaration

    Swift

    -
    open func engineDidWebsocketUpgrade(headers: [String: String])
    +
    open func engineDidWebsocketUpgrade(headers: [String : String])
    @@ -1468,7 +1523,8 @@ method.

    Declaration

    Swift

    -
    open func removeSocket(_ socket: SocketIOClient) -> SocketIOClient?
    +
    @discardableResult
    +open func removeSocket(_ socket: SocketIOClient) -> SocketIOClient?
    @@ -1591,8 +1647,8 @@ Or call -

    © 2018 Erik. All rights reserved. (Last updated: 2018-11-28)

    -

    Generated by jazzy ♪♫ v0.9.1, a Realm project.

    +

    © 2019 Erik. All rights reserved. (Last updated: 2019-01-16)

    +

    Generated by jazzy ♪♫ v0.9.4, a Realm project.

    diff --git a/docs/Classes/SocketRawAckView.html b/docs/Classes/SocketRawAckView.html index 4f9ca8a..c257b1a 100644 --- a/docs/Classes/SocketRawAckView.html +++ b/docs/Classes/SocketRawAckView.html @@ -274,7 +274,8 @@ will be emitted. The structure of the error data is [ackNum, items, theErr

    Declaration

    Swift

    -
    public func with(_ items: [Any])
    +
    @objc
    +public func with(_ items: [Any])
    @@ -308,8 +309,8 @@ will be emitted. The structure of the error data is [ackNum, items, theErr diff --git a/docs/Classes/SocketRawView.html b/docs/Classes/SocketRawView.html index 54c22a7..bd6fbac 100644 --- a/docs/Classes/SocketRawView.html +++ b/docs/Classes/SocketRawView.html @@ -286,7 +286,8 @@ will be emitted. The structure of the error data is [eventName, items, the

    Declaration

    Swift

    -
    public func emit(_ event: String, with items: [Any])
    +
    @objc
    +public func emit(_ event: String, with items: [Any])
    @@ -427,7 +428,8 @@ Check that your server’s api will ack the event being sent.

    Declaration

    Swift

    -
    public func emitWithAck(_ event: String, with items: [Any]) -> OnAckCallback
    +
    @objc
    +public func emitWithAck(_ event: String, with items: [Any]) -> OnAckCallback
    @@ -477,8 +479,8 @@ Check that your server’s api will ack the event being sent.

    diff --git a/docs/Enums.html b/docs/Enums.html index 89a0a8b..59fa13f 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -14,6 +14,7 @@ + @@ -192,38 +193,6 @@
    -
    -
      -
    • - -
      -
      -
      -
      -
      -

      Represents the type of engine.io packet types.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      @objc public enum SocketEnginePacketType : Int
      - -
      -
      -
      -
      -
    • -
    -
    • @@ -256,38 +225,6 @@
    -
    -
      -
    • -
      - - - - SocketClientEvent - -
      -
      -
      -
      -
      -
      -

      The set of events that are generated by the client.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public enum SocketClientEvent : String
      - -
      -
      -
      -
      -
    • -
    -
    • @@ -320,6 +257,38 @@
    +
    +
      +
    • +
      + + + + SocketClientEvent + +
      +
      +
      +
      +
      +
      +

      The set of events that are generated by the client.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public enum SocketClientEvent : String
      + +
      +
      +
      +
      +
    • +
    +
    • @@ -343,7 +312,41 @@

      Declaration

      Swift

      -
      public enum SocketIOStatus : Int, CustomStringConvertible
      +
      @objc
      +public enum SocketIOStatus : Int, CustomStringConvertible
      + +
      +
    +
    + +
  • + + +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Represents the type of engine.io packet types.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      +
      @objc
      +public enum SocketEnginePacketType : Int
      @@ -390,8 +393,8 @@
    diff --git a/docs/Enums/SocketAckStatus.html b/docs/Enums/SocketAckStatus.html index 440ba74..1ba0eb4 100644 --- a/docs/Enums/SocketAckStatus.html +++ b/docs/Enums/SocketAckStatus.html @@ -200,6 +200,13 @@
    +
    + + + +

    Cases

    +
    +
    diff --git a/docs/Enums/SocketClientEvent.html b/docs/Enums/SocketClientEvent.html index 01db543..1f420c7 100644 --- a/docs/Enums/SocketClientEvent.html +++ b/docs/Enums/SocketClientEvent.html @@ -200,6 +200,13 @@
    +
    + + + +

    Cases

    +
    +
    • @@ -234,10 +241,6 @@ data item: the namespace that was connected to.

    - - -
    -
    • @@ -271,10 +274,6 @@ data item: the namespace that was connected to.

    - - -
    -
    • @@ -308,10 +307,6 @@ data item: the namespace that was connected to.

    • -
    -
    -
    -
    • @@ -345,10 +340,6 @@ data item: the namespace that was connected to.

    • -
    -
    -
    -
    • @@ -382,10 +373,6 @@ data item: the namespace that was connected to.

    • -
    -
    -
    -
    • @@ -419,10 +406,6 @@ data item: the namespace that was connected to.

    • -
    -
    -
    -
    • @@ -456,10 +439,6 @@ data item: the namespace that was connected to.

    • -
    -
    -
    -
    • @@ -475,6 +454,9 @@ data item: the namespace that was connected to.

      Emitted every time there is a change in the client’s status.

      +

      The payload for data is [SocketIOClientStatus, Int]. Where the second item is the raw value. Use the second one +if you are working in Objective-C.

      +

      Usage:

      socket.on(clientEvent: .statusChange) {data, ack in
           // Some status changing logging
      @@ -493,10 +475,6 @@ data item: the namespace that was connected to.

    • -
    -
    -
    -
    • @@ -539,8 +517,8 @@ data item: the namespace that was connected to.

    diff --git a/docs/Enums/SocketEnginePacketType.html b/docs/Enums/SocketEnginePacketType.html index a239d4c..69abb5f 100644 --- a/docs/Enums/SocketEnginePacketType.html +++ b/docs/Enums/SocketEnginePacketType.html @@ -188,7 +188,8 @@

    SocketEnginePacketType

    -
    @objc public enum SocketEnginePacketType : Int
    +
    @objc
    +public enum SocketEnginePacketType : Int
    @@ -228,10 +229,6 @@ - - -
    -
    • @@ -259,10 +256,6 @@
    • -
    -
    -
    -
    • @@ -290,10 +283,6 @@
    • -
    -
    -
    -
    • @@ -321,10 +310,6 @@
    • -
    -
    -
    -
    • @@ -352,10 +337,6 @@
    • -
    -
    -
    -
    • @@ -383,10 +364,6 @@
    • -
    -
    -
    -
    diff --git a/docs/Enums/SocketIOClientOption.html b/docs/Enums/SocketIOClientOption.html index ac3a344..877c0f0 100644 --- a/docs/Enums/SocketIOClientOption.html +++ b/docs/Enums/SocketIOClientOption.html @@ -228,10 +228,6 @@ - - -
    -
    • @@ -252,17 +248,13 @@

      Declaration

      Swift

      -
      case connectParams([String: Any])
      +
      case connectParams([String : Any])
    - - -
    -
    • @@ -290,10 +282,6 @@
    • -
    -
    -
    -
    • @@ -314,17 +302,13 @@

      Declaration

      Swift

      -
      case extraHeaders([String: String])
      +
      case extraHeaders([String : String])
    - - -
    -
    • @@ -353,10 +337,6 @@ or when you want to be sure no state from previous engines is being carried over
    • -
    -
    -
    -
    • @@ -384,10 +364,6 @@ or when you want to be sure no state from previous engines is being carried over
    • -
    -
    -
    -
    • @@ -415,10 +391,6 @@ or when you want to be sure no state from previous engines is being carried over
    • -
    -
    -
    -
    • @@ -449,10 +421,6 @@ called on.

    • -
    -
    -
    -
    • @@ -480,10 +448,6 @@ called on.

    • -
    -
    -
    -
    • @@ -511,10 +475,6 @@ called on.

    • -
    -
    -
    -
    • @@ -542,10 +502,6 @@ called on.

    • -
    -
    -
    -
    • @@ -574,10 +530,6 @@ over when reconnects happen.

    • -
    -
    -
    -
    • @@ -605,10 +557,6 @@ over when reconnects happen.

    • -
    -
    -
    -
    • @@ -622,7 +570,7 @@ over when reconnects happen.

      -

      The number of seconds to wait before reconnect attempts.

      +

      The minimum number of seconds to wait before reconnect attempts.

      @@ -636,10 +584,60 @@ over when reconnects happen.

    • -
    -
    -
    -
      +
    • +
      + + + + reconnectWaitMax(_:) + +
      +
      +
      +
      +
      +
      +

      The maximum number of seconds to wait before reconnect attempts.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case reconnectWaitMax(Int)
      + +
      +
      +
      +
      +
    • +
    • + +
      +
      +
      +
      +
      +

      The randomization factor for calculating reconnect jitter.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case randomizationFactor(Double)
      + +
      +
      +
      +
      +
    • @@ -667,10 +665,6 @@ over when reconnects happen.

    • -
    -
    -
    -
    • @@ -698,10 +692,6 @@ over when reconnects happen.

    • -
    -
    -
    -
    • @@ -729,10 +719,6 @@ over when reconnects happen.

    • -
    -
    -
    -
    • @@ -791,7 +777,7 @@ over when reconnects happen.

      Declaration

      Swift

      -
      public var description: String
      +
      public var description: String { get }
      @@ -829,7 +815,7 @@ over when reconnects happen.

      Declaration

      Swift

      -
      public static func ==(lhs: SocketIOClientOption, rhs: SocketIOClientOption) -> Bool
      +
      public static func == (lhs: SocketIOClientOption, rhs: SocketIOClientOption) -> Bool
    @@ -879,8 +865,8 @@ over when reconnects happen.

    diff --git a/docs/Enums/SocketIOStatus.html b/docs/Enums/SocketIOStatus.html index bb4f941..972a3c0 100644 --- a/docs/Enums/SocketIOStatus.html +++ b/docs/Enums/SocketIOStatus.html @@ -188,7 +188,8 @@

    SocketIOStatus

    -
    public enum SocketIOStatus : Int, CustomStringConvertible
    +
    @objc
    +public enum SocketIOStatus : Int, CustomStringConvertible
    @@ -200,6 +201,13 @@
    +
    + + + +

    Cases

    +
    +
    • @@ -228,10 +236,6 @@
    - - -
    -
    • @@ -259,10 +263,6 @@
    • -
    -
    -
    -
    • @@ -290,10 +290,6 @@
    • -
    -
    -
    -
    • @@ -351,7 +347,7 @@

      Declaration

      Swift

      -
      public var active: Bool
      +
      public var active: Bool { get }
      @@ -381,7 +377,7 @@

      Declaration

      Swift

      -
      public var description: String
      +
      public var description: String { get }
    @@ -396,8 +392,8 @@ diff --git a/docs/Enums/SocketParsableError.html b/docs/Enums/SocketParsableError.html index 160b660..7d0c514 100644 --- a/docs/Enums/SocketParsableError.html +++ b/docs/Enums/SocketParsableError.html @@ -200,6 +200,13 @@
    +
    + + + +

    Cases

    +
    +
    • @@ -228,10 +235,6 @@
    - - -
    -
    • @@ -259,10 +262,6 @@
    • -
    -
    -
    -
    diff --git a/docs/Guides.html b/docs/Guides.html index 68e24d5..c462eb8 100644 --- a/docs/Guides.html +++ b/docs/Guides.html @@ -14,6 +14,7 @@ + @@ -198,8 +199,8 @@ diff --git a/docs/Protocols.html b/docs/Protocols.html index a0f19aa..6b916b7 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -14,6 +14,7 @@ + @@ -197,9 +198,9 @@
  • @@ -207,111 +208,15 @@
    -

    Specifies a SocketEngine.

    +

    Declares that a type can set configs from a SocketIOClientConfiguration.

    - See more + See more

    Declaration

    Swift

    -
    @objc public protocol SocketEngineSpec
    - -
    -
    -
    -
    -
  • - - -
    -
      -
    • -
      - - - - SocketEngineClient - -
      -
      -
      -
      -
      -
      -

      Declares that a type will be a delegate to an engine.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      @objc public protocol SocketEngineClient
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
      -
    • -
      - - - - SocketEnginePollable - -
      -
      -
      -
      -
      -
      -

      Protocol that is used to implement socket.io polling support

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public protocol SocketEnginePollable : SocketEngineSpec
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
      -
    • -
      - - - - SocketEngineWebsocket - -
      -
      -
      -
      -
      -
      -

      Protocol that is used to implement socket.io WebSocket support

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public protocol SocketEngineWebsocket : SocketEngineSpec
      +
      public protocol ConfigSettable
      @@ -357,9 +262,9 @@
    • @@ -367,15 +272,16 @@
      -

      Declares that a type can set configs from a SocketIOClientConfiguration.

      +

      Declares that a type will be a delegate to an engine.

      - See more + See more

      Declaration

      Swift

      -
      public protocol ConfigSettable
      +
      @objc
      +public protocol SocketEngineClient
      @@ -389,9 +295,9 @@
    • @@ -399,60 +305,129 @@
      -

      A marking protocol that says a type can be represented in a socket.io packet.

      +

      Protocol that is used to implement socket.io polling support

      -

      Example:

      -
      struct CustomData : SocketData {
      -   let name: String
      -   let age: Int
      +                        See more
      +                      
      +
      +

      Declaration

      +
      +

      Swift

      +
      public protocol SocketEnginePollable : SocketEngineSpec
      - func socketRepresentation() -> SocketData { - return ["name": name, "age": age] - } -} +
      +
      +
      +
      +
    • +
    +
    +
    +
      +
    • +
      + + + + SocketEngineSpec + +
      +
      +
      +
      +
      +
      +

      Specifies a SocketEngine.

      -socket.emit("myEvent", CustomData(name: "Erik", age: 24)) + See more +
      +
      +

      Declaration

      +
      +

      Swift

      +
      @objc
      +public protocol SocketEngineSpec
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
      +
    • +
      + + + + SocketEngineWebsocket + +
      +
      +
      +
      +
      +
      +

      Protocol that is used to implement socket.io WebSocket support

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public protocol SocketEngineWebsocket : SocketEngineSpec
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
      +
    • +
      + + + + SocketManagerSpec + +
      +
      +
      +
      +
      +
      +

      A manager for a socket.io connection.

      + +

      A SocketManagerSpec is responsible for multiplexing multiple namespaces through a single SocketEngineSpec.

      + +

      Example with SocketManager:

      +
      let manager = SocketManager(socketURL: URL(string:"http://localhost:8080/")!)
      +let defaultNamespaceSocket = manager.defaultSocket
      +let swiftSocket = manager.socket(forNamespace: "/swift")
      +
      +// defaultNamespaceSocket and swiftSocket both share a single connection to the server
       
      - See more +

      Sockets created through the manager are retained by the manager. So at the very least, a single strong reference +to the manager must be maintained to keep sockets alive.

      + +

      To disconnect a socket and remove it from the manager, either call SocketIOClient.disconnect() on the socket, +or call one of the disconnectSocket methods on this class.

      + + See more

      Declaration

      Swift

      -
      public protocol SocketData
      - -
      -
      -
      -
      -
    • -
    -
    -
    -
      -
    • -
      - - - - SocketLogger - -
      -
      -
      -
      -
      -
      -

      Represents a class will log client events.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public protocol SocketLogger : AnyObject
      +
      @objc
      +public protocol SocketManagerSpec : AnyObject, SocketEngineClient
      @@ -526,9 +501,9 @@
    • @@ -536,31 +511,60 @@
      -

      A manager for a socket.io connection.

      +

      Represents a class will log client events.

      -

      A SocketManagerSpec is responsible for multiplexing multiple namespaces through a single SocketEngineSpec.

      - -

      Example with SocketManager:

      -
      let manager = SocketManager(socketURL: URL(string:"http://localhost:8080/")!)
      -let defaultNamespaceSocket = manager.defaultSocket
      -let swiftSocket = manager.socket(forNamespace: "/swift")
      -
      -// defaultNamespaceSocket and swiftSocket both share a single connection to the server
      -
      - -

      Sockets created through the manager are retained by the manager. So at the very least, a single strong reference -to the manager must be maintained to keep sockets alive.

      - -

      To disconnect a socket and remove it from the manager, either call SocketIOClient.disconnect() on the socket, -or call one of the disconnectSocket methods on this class.

      - - See more + See more

      Declaration

      Swift

      -
      public protocol SocketManagerSpec : AnyObject, SocketEngineClient
      +
      public protocol SocketLogger : AnyObject
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
      +
    • +
      + + + + SocketData + +
      +
      +
      +
      +
      +
      +

      A marking protocol that says a type can be represented in a socket.io packet.

      + +

      Example:

      +
      struct CustomData : SocketData {
      +   let name: String
      +   let age: Int
      +
      +   func socketRepresentation() -> SocketData {
      +       return ["name": name, "age": age]
      +   }
      +}
      +
      +socket.emit("myEvent", CustomData(name: "Erik", age: 24))
      +
      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public protocol SocketData
      @@ -575,8 +579,8 @@ or call one of the disconnectSocket methods on this class.

    diff --git a/docs/Protocols/ConfigSettable.html b/docs/Protocols/ConfigSettable.html index 311cf77..d5eae0e 100644 --- a/docs/Protocols/ConfigSettable.html +++ b/docs/Protocols/ConfigSettable.html @@ -262,8 +262,8 @@ diff --git a/docs/Protocols/SocketData.html b/docs/Protocols/SocketData.html index 32b3ad5..630dd9d 100644 --- a/docs/Protocols/SocketData.html +++ b/docs/Protocols/SocketData.html @@ -264,8 +264,8 @@ diff --git a/docs/Protocols/SocketDataBufferable.html b/docs/Protocols/SocketDataBufferable.html index af0502e..18814e5 100644 --- a/docs/Protocols/SocketDataBufferable.html +++ b/docs/Protocols/SocketDataBufferable.html @@ -233,7 +233,7 @@ So this should ideally be an array of one packet waiting for data.

    Declaration

    Swift

    -
    var waitingPackets: [SocketPacket]
    +
    var waitingPackets: [SocketPacket] { get set }
    @@ -248,8 +248,8 @@ So this should ideally be an array of one packet waiting for data.

    diff --git a/docs/Protocols/SocketEngineClient.html b/docs/Protocols/SocketEngineClient.html index 02fa29f..f454831 100644 --- a/docs/Protocols/SocketEngineClient.html +++ b/docs/Protocols/SocketEngineClient.html @@ -188,7 +188,8 @@

    SocketEngineClient

    -
    @objc public protocol SocketEngineClient
    +
    @objc
    +public protocol SocketEngineClient
    @@ -512,7 +513,7 @@

    Declaration

    Swift

    -
    func engineDidWebsocketUpgrade(headers: [String: String])
    +
    func engineDidWebsocketUpgrade(headers: [String : String])
    @@ -546,8 +547,8 @@ diff --git a/docs/Protocols/SocketEnginePollable.html b/docs/Protocols/SocketEnginePollable.html index c030156..7494fc5 100644 --- a/docs/Protocols/SocketEnginePollable.html +++ b/docs/Protocols/SocketEnginePollable.html @@ -228,7 +228,7 @@

    Declaration

    Swift

    -
    var invalidated: Bool
    +
    var invalidated: Bool { get }
    @@ -257,7 +257,7 @@

    Declaration

    Swift

    -
    var postWait: [Post]
    +
    var postWait: [Post] { get set }
    @@ -284,7 +284,7 @@

    Declaration

    Swift

    -
    var session: URLSession?
    +
    var session: URLSession? { get }
    @@ -314,7 +314,7 @@ disconnect us.

    Declaration

    Swift

    -
    var waitingForPoll: Bool
    +
    var waitingForPoll: Bool { get set }
    @@ -344,7 +344,7 @@ disconnect us.

    Declaration

    Swift

    -
    var waitingForPost: Bool
    +
    var waitingForPost: Bool { get set }
    @@ -526,8 +526,8 @@ disconnect us.

    diff --git a/docs/Protocols/SocketEngineSpec.html b/docs/Protocols/SocketEngineSpec.html index fd8ace0..de20879 100644 --- a/docs/Protocols/SocketEngineSpec.html +++ b/docs/Protocols/SocketEngineSpec.html @@ -188,7 +188,8 @@

    SocketEngineSpec

    -
    @objc public protocol SocketEngineSpec
    +
    @objc
    +public protocol SocketEngineSpec
    @@ -228,7 +229,7 @@

    Declaration

    Swift

    -
    var client: SocketEngineClient?
    +
    var client: SocketEngineClient? { get set }
    @@ -255,7 +256,7 @@

    Declaration

    Swift

    -
    var closed: Bool
    +
    var closed: Bool { get }
    @@ -282,7 +283,7 @@

    Declaration

    Swift

    -
    var compress: Bool
    +
    var compress: Bool { get }
    @@ -309,7 +310,7 @@

    Declaration

    Swift

    -
    var connected: Bool
    +
    var connected: Bool { get }
    @@ -336,7 +337,7 @@

    Declaration

    Swift

    -
    var connectParams: [String: Any]?
    +
    var connectParams: [String : Any]? { get set }
    @@ -363,7 +364,7 @@

    Declaration

    Swift

    -
    var cookies: [HTTPCookie]?
    +
    var cookies: [HTTPCookie]? { get }
    @@ -390,7 +391,7 @@

    Declaration

    Swift

    -
    var engineQueue: DispatchQueue
    +
    var engineQueue: DispatchQueue { get }
    @@ -417,7 +418,7 @@

    Declaration

    Swift

    -
    var extraHeaders: [String: String]?
    +
    var extraHeaders: [String : String]? { get set }
    @@ -444,7 +445,7 @@

    Declaration

    Swift

    -
    var fastUpgrade: Bool
    +
    var fastUpgrade: Bool { get }
    @@ -471,7 +472,7 @@

    Declaration

    Swift

    -
    var forcePolling: Bool
    +
    var forcePolling: Bool { get }
    @@ -498,7 +499,7 @@

    Declaration

    Swift

    -
    var forceWebsockets: Bool
    +
    var forceWebsockets: Bool { get }
    @@ -525,7 +526,7 @@

    Declaration

    Swift

    -
    var polling: Bool
    +
    var polling: Bool { get }
    @@ -552,7 +553,7 @@

    Declaration

    Swift

    -
    var probing: Bool
    +
    var probing: Bool { get }
    @@ -579,7 +580,7 @@

    Declaration

    Swift

    -
    var sid: String
    +
    var sid: String { get }
    @@ -606,7 +607,7 @@

    Declaration

    Swift

    -
    var socketPath: String
    +
    var socketPath: String { get }
    @@ -633,7 +634,7 @@

    Declaration

    Swift

    -
    var urlPolling: URL
    +
    var urlPolling: URL { get }
    @@ -660,7 +661,7 @@

    Declaration

    Swift

    -
    var urlWebSocket: URL
    +
    var urlWebSocket: URL { get }
    @@ -687,7 +688,8 @@

    Declaration

    Swift

    -
    var websocket: Bool
    +
    @available(*, deprecated, message: "No longer needed, if we're not polling, then we must be doing websockets")
    +var websocket: Bool { get }
    @@ -714,7 +716,7 @@

    Declaration

    Swift

    -
    var ws: WebSocket?
    +
    var ws: WebSocket? { get }
    @@ -752,7 +754,7 @@

    Declaration

    Swift

    -
    init(client: SocketEngineClient, url: URL, options: [String: Any]?)
    +
    init(client: SocketEngineClient, url: URL, options: [String : Any]?)
    @@ -1155,8 +1157,8 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

    diff --git a/docs/Protocols/SocketEngineWebsocket.html b/docs/Protocols/SocketEngineWebsocket.html index c35b49e..21e47cc 100644 --- a/docs/Protocols/SocketEngineWebsocket.html +++ b/docs/Protocols/SocketEngineWebsocket.html @@ -240,7 +240,7 @@

    Declaration

    Swift

    -
    func sendWebSocketMessage(_ str: String,
    +
    func sendWebSocketMessage(_ str: String, withType type: SocketEnginePacketType, withData datas: [Data], completion: (() -> ())?)
    @@ -310,8 +310,8 @@ diff --git a/docs/Protocols/SocketIOClientSpec.html b/docs/Protocols/SocketIOClientSpec.html index 2fc3e3d..019e42e 100644 --- a/docs/Protocols/SocketIOClientSpec.html +++ b/docs/Protocols/SocketIOClientSpec.html @@ -228,7 +228,7 @@

    Declaration

    Swift

    -
    var anyHandler: ((SocketAnyEvent) -> ())?
    +
    var anyHandler: ((SocketAnyEvent) -> ())? { get }
    @@ -255,7 +255,7 @@

    Declaration

    Swift

    -
    var handlers: [SocketEventHandler]
    +
    var handlers: [SocketEventHandler] { get }
    @@ -282,7 +282,7 @@

    Declaration

    Swift

    -
    var manager: SocketManagerSpec?
    +
    var manager: SocketManagerSpec? { get }
    @@ -311,7 +311,7 @@

    Declaration

    Swift

    -
    var nsp: String
    +
    var nsp: String { get }
    @@ -344,7 +344,7 @@

    Declaration

    Swift

    -
    var rawEmitView: SocketRawView
    +
    var rawEmitView: SocketRawView { get }
    @@ -371,7 +371,7 @@

    Declaration

    Swift

    -
    var status: SocketIOStatus
    +
    var status: SocketIOStatus { get }
    @@ -1668,8 +1668,8 @@ Called when the manager detects a broken connection, or when a manual reconnect diff --git a/docs/Protocols/SocketLogger.html b/docs/Protocols/SocketLogger.html index 9deff36..9664682 100644 --- a/docs/Protocols/SocketLogger.html +++ b/docs/Protocols/SocketLogger.html @@ -228,7 +228,7 @@

    Declaration

    Swift

    -
    var log: Bool
    +
    var log: Bool { get set }
    @@ -410,8 +410,8 @@ diff --git a/docs/Protocols/SocketManagerSpec.html b/docs/Protocols/SocketManagerSpec.html index 7dffc50..9420052 100644 --- a/docs/Protocols/SocketManagerSpec.html +++ b/docs/Protocols/SocketManagerSpec.html @@ -188,7 +188,8 @@

    SocketManagerSpec

    -
    public protocol SocketManagerSpec : AnyObject, SocketEngineClient
    +
    @objc
    +public protocol SocketManagerSpec : AnyObject, SocketEngineClient
    @@ -244,7 +245,7 @@ or call one of the disconnectSocket methods on this class.

    Declaration

    Swift

    -
    var defaultSocket: SocketIOClient
    +
    var defaultSocket: SocketIOClient { get }
    @@ -271,7 +272,7 @@ or call one of the disconnectSocket methods on this class.

    Declaration

    Swift

    -
    var engine: SocketEngineSpec?
    +
    var engine: SocketEngineSpec? { get set }
    @@ -298,7 +299,7 @@ or call one of the disconnectSocket methods on this class.

    Declaration

    Swift

    -
    var forceNew: Bool
    +
    var forceNew: Bool { get set }
    @@ -326,7 +327,7 @@ called on.

    Declaration

    Swift

    -
    var handleQueue: DispatchQueue
    +
    var handleQueue: DispatchQueue { get set }
    @@ -353,7 +354,7 @@ called on.

    Declaration

    Swift

    -
    var nsps: [String: SocketIOClient]
    +
    var nsps: [String : SocketIOClient] { get set }
    @@ -380,7 +381,7 @@ called on.

    Declaration

    Swift

    -
    var reconnects: Bool
    +
    var reconnects: Bool { get set }
    @@ -400,14 +401,68 @@ called on.

    -

    The number of seconds to wait before attempting to reconnect.

    +

    The minimum number of seconds to wait before attempting to reconnect.

    Declaration

    Swift

    -
    var reconnectWait: Int
    +
    var reconnectWait: Int { get set }
    + +
    +
    +
    + + +
  • +
    + + + + reconnectWaitMax + +
    +
    +
    +
    +
    +
    +

    The maximum number of seconds to wait before attempting to reconnect.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var reconnectWaitMax: Int { get set }
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + randomizationFactor + +
    +
    +
    +
    +
    +
    +

    The randomization factor for calculating reconnect jitter.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    var randomizationFactor: Double { get set }
    @@ -434,7 +489,7 @@ called on.

    Declaration

    Swift

    -
    var socketURL: URL
    +
    var socketURL: URL { get }
    @@ -461,7 +516,7 @@ called on.

    Declaration

    Swift

    -
    var status: SocketIOStatus
    +
    var status: SocketIOStatus { get }
    @@ -825,7 +880,8 @@ After calling this method the socket should no longer be considered usable.

    Declaration

    Swift

    -
    func removeSocket(_ socket: SocketIOClient) -> SocketIOClient?
    +
    @discardableResult
    +func removeSocket(_ socket: SocketIOClient) -> SocketIOClient?
    @@ -919,8 +975,8 @@ Or call -

    © 2018 Erik. All rights reserved. (Last updated: 2018-11-28)

    -

    Generated by jazzy ♪♫ v0.9.1, a Realm project.

    +

    © 2019 Erik. All rights reserved. (Last updated: 2019-01-16)

    +

    Generated by jazzy ♪♫ v0.9.4, a Realm project.

    diff --git a/docs/Protocols/SocketParsable.html b/docs/Protocols/SocketParsable.html index 951d64f..f43149f 100644 --- a/docs/Protocols/SocketParsable.html +++ b/docs/Protocols/SocketParsable.html @@ -336,8 +336,8 @@ into the correct placeholder.

    diff --git a/docs/Structs.html b/docs/Structs.html index dd1afc2..650c98c 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -14,6 +14,7 @@ + @@ -294,8 +295,8 @@ diff --git a/docs/Structs/SocketEventHandler.html b/docs/Structs/SocketEventHandler.html index a0de2c1..e32bc51 100644 --- a/docs/Structs/SocketEventHandler.html +++ b/docs/Structs/SocketEventHandler.html @@ -378,8 +378,8 @@ diff --git a/docs/Structs/SocketIOClientConfiguration.html b/docs/Structs/SocketIOClientConfiguration.html index 213cfdb..62187fa 100644 --- a/docs/Structs/SocketIOClientConfiguration.html +++ b/docs/Structs/SocketIOClientConfiguration.html @@ -309,7 +309,7 @@

    Declaration

    Swift

    -
    public typealias SubSequence =  Array<SocketIOClientOption>.SubSequence
    +
    public typealias SubSequence = Array<SocketIOClientOption>.SubSequence
    @@ -347,7 +347,7 @@

    Declaration

    Swift

    -
    public var startIndex: Index
    +
    public var startIndex: Index { get }
    @@ -374,7 +374,7 @@

    Declaration

    Swift

    -
    public var endIndex: Index
    +
    public var endIndex: Index { get }
    @@ -401,7 +401,7 @@

    Declaration

    Swift

    -
    public var isEmpty: Bool
    +
    public var isEmpty: Bool { get }
    @@ -428,7 +428,7 @@

    Declaration

    Swift

    -
    public var count: Index.Stride
    +
    public var count: Index.Stride { get }
    @@ -455,7 +455,7 @@

    Declaration

    Swift

    -
    public var first: Element?
    +
    public var first: Element? { get }
    @@ -481,7 +481,7 @@

    Declaration

    Swift

    -
    public subscript(position: Index) -> Element
    +
    public subscript(position: Index) -> Element { get set }
    @@ -507,7 +507,7 @@

    Declaration

    Swift

    -
    public subscript(bounds: Range<Index>) -> SubSequence
    +
    public subscript(bounds: Range<Index>) -> SubSequence { get set }
    @@ -709,8 +709,8 @@ diff --git a/docs/Structs/SocketPacket.html b/docs/Structs/SocketPacket.html index 9eb78c2..bdfd405 100644 --- a/docs/Structs/SocketPacket.html +++ b/docs/Structs/SocketPacket.html @@ -366,7 +366,7 @@ event type packets.

    Declaration

    Swift

    -
    public var args: [Any]
    +
    public var args: [Any] { get }
    @@ -393,7 +393,7 @@ event type packets.

    Declaration

    Swift

    -
    public var description: String
    +
    public var description: String { get }
    @@ -420,7 +420,7 @@ event type packets.

    Declaration

    Swift

    -
    public var event: String
    +
    public var event: String { get }
    @@ -447,7 +447,7 @@ event type packets.

    Declaration

    Swift

    -
    public var packetString: String
    +
    public var packetString: String { get }
    @@ -486,7 +486,7 @@ event type packets.

    Declaration

    Swift

    -
    public enum PacketType: Int
    +
    public enum PacketType : Int
    @@ -501,8 +501,8 @@ event type packets.

    diff --git a/docs/Structs/SocketPacket/PacketType.html b/docs/Structs/SocketPacket/PacketType.html index b63f76c..13bf5fc 100644 --- a/docs/Structs/SocketPacket/PacketType.html +++ b/docs/Structs/SocketPacket/PacketType.html @@ -188,7 +188,7 @@

    PacketType

    -
    public enum PacketType: Int
    +
    public enum PacketType : Int
    @@ -200,6 +200,13 @@
    +
    + + + +

    Cases

    +
    +
    • @@ -228,10 +235,6 @@
  • - - -
    -
    • @@ -259,10 +262,6 @@
    • -
    -
    -
    -
    • @@ -290,10 +289,6 @@
    • -
    -
    -
    -
    • @@ -321,10 +316,6 @@
    • -
    -
    -
    -
    • @@ -352,10 +343,6 @@
    • -
    -
    -
    -
    • @@ -383,10 +370,6 @@
    • -
    -
    -
    -
    • @@ -445,7 +428,7 @@

      Declaration

      Swift

      -
      public var isBinary: Bool
      +
      public var isBinary: Bool { get }
      @@ -460,8 +443,8 @@
    diff --git a/docs/Typealiases.html b/docs/Typealiases.html index cf0b90d..b750030 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -14,6 +14,7 @@ + @@ -283,8 +284,8 @@ diff --git a/docs/faq.html b/docs/faq.html index c4ed1f9..c207b24 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -232,8 +232,8 @@ will be released, along with the socket, and its memory reclaimed.

    diff --git a/docs/index.html b/docs/index.html index 5686b01..cc0c304 100644 --- a/docs/index.html +++ b/docs/index.html @@ -248,7 +248,7 @@ SocketIOClient* socket = manager.defaultSocket;

    Checkout the FAQs for commonly asked questions.

    -

    Checkout the 12to13 guide for migrating to v13.

    +

    Checkout the 12to13 guide for migrating to v13+ from v12 below.

    Installation

    Requires Swift 4/Xcode 9.x

    @@ -259,7 +259,7 @@ SocketIOClient* socket = manager.defaultSocket;

    Swift Package Manager

    Add the project as a dependency to your Package.swift:

    -
    // swift-tools-version:4.0
    +
    // swift-tools-version:4.2
     
     import PackageDescription
     
    @@ -269,7 +269,7 @@ SocketIOClient* socket = manager.defaultSocket;
             .executable(name: "socket.io-test", targets: ["YourTargetName"])
         ],
         dependencies: [
    -        .package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMinor(from: "13.3.0"))
    +        .package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMinor(from: "14.0.0"))
         ],
         targets: [
             .target(name: "YourTargetName", dependencies: ["SocketIO"], path: "./Path/To/Your/Sources")
    @@ -281,7 +281,7 @@ SocketIOClient* socket = manager.defaultSocket;
     

    Carthage

    Add this line to your Cartfile:

    -
    github "socketio/socket.io-client-swift" ~> 13.3.0
    +
    github "socketio/socket.io-client-swift" ~> 14.0.0
     

    Run carthage update --platform ios,macosx.

    @@ -293,7 +293,7 @@ SocketIOClient* socket = manager.defaultSocket;
    use_frameworks!
     
     target 'YourApp' do
    -    pod 'Socket.IO-Client-Swift', '~> 13.3.0'
    +    pod 'Socket.IO-Client-Swift', '~> 14.0.0'
     end
     
    @@ -334,8 +334,8 @@ SocketIOClient* socket = manager.defaultSocket; diff --git a/docs/search.json b/docs/search.json index 00b2a8c..992eb97 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -{"Typealiases.html#/s:8SocketIO11AckCallbacka":{"name":"AckCallback","abstract":"

    A typealias for an ack callback.

    "},"Typealiases.html#/s:8SocketIO14NormalCallbacka":{"name":"NormalCallback","abstract":"

    A typealias for a normal callback.

    "},"Typealiases.html#/s:8SocketIO4Posta":{"name":"Post","abstract":"

    A typealias for a queued POST

    "},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO7connectyA2EmF":{"name":"connect","abstract":"

    Connect: 0

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO10disconnectyA2EmF":{"name":"disconnect","abstract":"

    Disconnect: 1

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO5eventyA2EmF":{"name":"event","abstract":"

    Event: 2

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO3ackyA2EmF":{"name":"ack","abstract":"

    Ack: 3

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO5erroryA2EmF":{"name":"error","abstract":"

    Error: 4

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO11binaryEventyA2EmF":{"name":"binaryEvent","abstract":"

    Binary Event: 5

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO9binaryAckyA2EmF":{"name":"binaryAck","abstract":"

    Binary Ack: 6

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO8isBinarySbvp":{"name":"isBinary","abstract":"

    Whether or not this type is binary

    ","parent_name":"PacketType"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV3nspSSvp":{"name":"nsp","abstract":"

    The namespace for this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV2idSivp":{"name":"id","abstract":"

    If > 0 then this packet is using acking.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV4typeAC0C4TypeOvp":{"name":"type","abstract":"

    The type of this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV6binarySay10Foundation4DataVGvp":{"name":"binary","abstract":"

    An array of binary data for this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV4dataSayypGvp":{"name":"data","abstract":"

    The data for this event.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV4argsSayypGvp":{"name":"args","abstract":"

    Returns the payload for this packet, minus the event name if this is an event or binaryEvent type packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV11descriptionSSvp":{"name":"description","abstract":"

    A string representation of this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV5eventSSvp":{"name":"event","abstract":"

    The event name for this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV12packetStringSSvp":{"name":"packetString","abstract":"

    A string representation of this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket/PacketType.html":{"name":"PacketType","abstract":"

    The type of packets.

    ","parent_name":"SocketPacket"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV7Elementa":{"name":"Element","abstract":"

    Type of element stored.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa":{"name":"Index","abstract":"

    Index type.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV8Iteratora":{"name":"Iterator","abstract":"

    Iterator type.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV11SubSequencea":{"name":"SubSequence","abstract":"

    SubSequence type.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV10startIndexSivp":{"name":"startIndex","abstract":"

    The start index of this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV8endIndexSivp":{"name":"endIndex","abstract":"

    The end index of this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV7isEmptySbvp":{"name":"isEmpty","abstract":"

    Whether this collection is empty.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5countSivp":{"name":"count","abstract":"

    The number of elements stored in this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5firstAA0aC6OptionOSgvp":{"name":"first","abstract":"

    The first element in this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:Sly7ElementQz5IndexQzcip":{"name":"subscript(_:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:Sly11SubSequenceQzSny5IndexQzGcip":{"name":"subscript(_:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV12arrayLiteralAcA0aC6OptionOd_tcfc":{"name":"init(arrayLiteral:)","abstract":"

    Creates a new SocketIOClientConfiguration from an array literal.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV12makeIterators08IndexingF0VySayAA0aC6OptionOGGyF":{"name":"makeIterator()","abstract":"

    Creates an iterator for this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5index5afterS2i_tF":{"name":"index(after:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV6insert_9replacingyAA0aC6OptionO_SbtF":{"name":"insert(_:replacing:)","abstract":"

    Special method that inserts element into the collection, replacing any other instances of element.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV5eventSSvp":{"name":"event","abstract":"

    The event for this handler.

    ","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV2id10Foundation4UUIDVvp":{"name":"id","abstract":"

    A unique identifier for this handler.

    ","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV8callbackyySayypG_AA0A10AckEmitterCtcvp":{"name":"callback","abstract":"

    The actual handler function.

    ","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV15executeCallback4with0G3Ack0gA0ySayypG_SiAA0A8IOClientCtF":{"name":"executeCallback(with:withAck:withSocket:)","abstract":"

    Causes this handler to be executed.

    ","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html":{"name":"SocketEventHandler","abstract":"

    A wrapper around a handler.

    "},"Structs/SocketIOClientConfiguration.html":{"name":"SocketIOClientConfiguration","abstract":"

    An array-like type that holds SocketIOClientOptions

    "},"Structs/SocketPacket.html":{"name":"SocketPacket","abstract":"

    A struct that represents a socket.io packet.

    "},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)defaultSocket":{"name":"defaultSocket","abstract":"

    Returns the socket associated with the default namespace (/).

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)engine":{"name":"engine","abstract":"

    The engine for this manager.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)forceNew":{"name":"forceNew","abstract":"

    If true then every time connect is called, a new engine will be created.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)handleQueue":{"name":"handleQueue","abstract":"

    The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)nsps":{"name":"nsps","abstract":"

    The sockets in this manager indexed by namespace.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnects":{"name":"reconnects","abstract":"

    If true, this manager will try and reconnect on any disconnects.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnectWait":{"name":"reconnectWait","abstract":"

    The number of seconds to wait before attempting to reconnect.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)socketURL":{"name":"socketURL","abstract":"

    The URL of the socket.io server.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)status":{"name":"status","abstract":"

    The status of this manager.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)connect":{"name":"connect()","abstract":"

    Connects the underlying transport.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)connectSocket:":{"name":"connectSocket(_:)","abstract":"

    Connects a socket through this manager’s engine.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)didDisconnectWithReason:":{"name":"didDisconnect(reason:)","abstract":"

    Called when the manager has disconnected from socket.io.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnect":{"name":"disconnect()","abstract":"

    Disconnects the manager and all associated sockets.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnectSocket:":{"name":"disconnectSocket(_:)","abstract":"

    Disconnects the given socket.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnectSocketForNamespace:":{"name":"disconnectSocket(forNamespace:)","abstract":"

    Disconnects the socket associated with forNamespace.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)emitAll:withItems:":{"name":"emitAll(_:withItems:)","abstract":"

    Sends an event to the server on all namespaces in this manager.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)reconnect":{"name":"reconnect()","abstract":"

    Tries to reconnect to the server.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)removeSocket:":{"name":"removeSocket(_:)","abstract":"

    Removes the socket from the manager’s control.","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)socketForNamespace:":{"name":"socket(forNamespace:)","abstract":"

    Returns a SocketIOClient for the given namespace. This socket shares a transport with the manager.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketDataBufferable.html#/s:8SocketIO0A14DataBufferableP14waitingPacketsSayAA0A6PacketVGvp":{"name":"waitingPackets","abstract":"

    A list of packets that are waiting for binary data.

    ","parent_name":"SocketDataBufferable"},"Protocols/SocketParsable.html#/s:8SocketIO0A8ParsableP15parseBinaryDatayAA0A6PacketVSg10Foundation0F0VF":{"name":"parseBinaryData(_:)","abstract":"

    Called when the engine has received some binary data that should be attached to a packet.

    ","parent_name":"SocketParsable"},"Protocols/SocketParsable.html#/s:8SocketIO0A8ParsableP05parseA7MessageyAA0A6PacketVSgSSF":{"name":"parseSocketMessage(_:)","abstract":"

    Called when the engine has received a string that should be parsed into a socket.io packet.

    ","parent_name":"SocketParsable"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP3logSbvp":{"name":"log","abstract":"

    Whether to log or not

    ","parent_name":"SocketLogger"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP3log_4typeySSyXK_SStF":{"name":"log(_:type:)","abstract":"

    Normal log messages

    ","parent_name":"SocketLogger"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP5error_4typeySSyXK_SStF":{"name":"error(_:type:)","abstract":"

    Error Messages

    ","parent_name":"SocketLogger"},"Protocols/SocketData.html#/s:8SocketIO0A4DataP20socketRepresentationAaB_pyKF":{"name":"socketRepresentation()","abstract":"

    A representation of self that can sent over socket.io.

    ","parent_name":"SocketData"},"Protocols/ConfigSettable.html#/s:8SocketIO14ConfigSettableP10setConfigsyyAA0A21IOClientConfigurationVF":{"name":"setConfigs(_:)","abstract":"

    Called when an ConfigSettable should set/update its configs from a given configuration.

    ","parent_name":"ConfigSettable"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP10anyHandleryAA0A8AnyEventCcSgvp":{"name":"anyHandler","abstract":"

    A handler that will be called on any event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP8handlersSayAA0A12EventHandlerVGvp":{"name":"handlers","abstract":"

    The array of handlers for this socket.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7managerAA0a7ManagerD0_pSgvp":{"name":"manager","abstract":"

    The manager for this socket.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3nspSSvp":{"name":"nsp","abstract":"

    The namespace that this socket is currently connected to.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP11rawEmitViewAA0a3RawG0Cvp":{"name":"rawEmitView","abstract":"

    A view into this socket where emits do not check for binary data.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP6statusAA0A8IOStatusOvp":{"name":"status","abstract":"

    The status of this client.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7connectyyF":{"name":"connect()","abstract":"

    Connect to the server. The same as calling connect(timeoutAfter:withHandler:) with a timeout of 0.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7connect12timeoutAfter11withHandlerySd_yycSgtF":{"name":"connect(timeoutAfter:withHandler:)","abstract":"

    Connect to the server. If we aren’t connected after timeoutAfter seconds, then withHandler is called.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP10didConnect11toNamespaceySS_tF":{"name":"didConnect(toNamespace:)","abstract":"

    Called when the client connects to a namespace. If the client was created with a namespace upfront,","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP13didDisconnect6reasonySS_tF":{"name":"didDisconnect(reason:)","abstract":"

    Called when the client has disconnected from socket.io.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP8didError6reasonySS_tF":{"name":"didError(reason:)","abstract":"

    Called when the client encounters an error.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP10disconnectyyF":{"name":"disconnect()","abstract":"

    Disconnects the socket.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP4emit__10completionySS_AA0A4Data_pdyycSgtF":{"name":"emit(_:_:completion:)","abstract":"

    Send an event to the server, with optional data items and optional write completion handler.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7emitAck_4withySi_SayypGtF":{"name":"emitAck(_:with:)","abstract":"

    Call when you wish to tell the server that you’ve received the event for ack.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF":{"name":"emitWithAck(_:_:)","abstract":"

    Sends a message to the server, requesting an ack.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP9handleAck_4dataySi_SayypGtF":{"name":"handleAck(_:data:)","abstract":"

    Called when socket.io has acked one of our emits. Causes the corresponding ack callback to be called.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP17handleClientEvent_4datayAA0afG0O_SayypGtF":{"name":"handleClientEvent(_:data:)","abstract":"

    Called on socket.io specific events.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP11handleEvent_4data17isInternalMessage7withAckySS_SayypGSbSitF":{"name":"handleEvent(_:data:isInternalMessage:withAck:)","abstract":"

    Called when we get an event from socket.io.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP12handlePacketyyAA0aF0VF":{"name":"handlePacket(_:)","abstract":"

    Causes a client to handle a socket.io packet. The namespace for the packet must match the namespace of the","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP14leaveNamespaceyyF":{"name":"leaveNamespace()","abstract":"

    Call when you wish to leave a namespace and disconnect this socket.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP13joinNamespaceyyF":{"name":"joinNamespace()","abstract":"

    Joins nsp.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3off11clientEventyAA0a6ClientG0O_tF":{"name":"off(clientEvent:)","abstract":"

    Removes handler(s) for a client event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3offyySSF":{"name":"off(_:)","abstract":"

    Removes handler(s) based on an event name.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3off2idy10Foundation4UUIDV_tF":{"name":"off(id:)","abstract":"

    Removes a handler with the specified UUID gotten from an on or once

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP2on_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF":{"name":"on(_:callback:)","abstract":"

    Adds a handler for an event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP2on11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"on(clientEvent:callback:)","abstract":"

    Adds a handler for a client event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP4once11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"once(clientEvent:callback:)","abstract":"

    Adds a single-use handler for a client event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP4once_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF":{"name":"once(_:callback:)","abstract":"

    Adds a single-use handler for an event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP5onAnyyyyAA0aF5EventCcF":{"name":"onAny(_:)","abstract":"

    Adds a handler that will be called on every event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP17removeAllHandlersyyF":{"name":"removeAllHandlers()","abstract":"

    Removes all handlers.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP15setReconnecting6reasonySS_tF":{"name":"setReconnecting(reason:)","abstract":"

    Puts the socket back into the connecting state.","parent_name":"SocketIOClientSpec"},"Protocols/SocketEngineWebsocket.html#/s:8SocketIO0A15EngineWebsocketP07sendWebA7Message_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF":{"name":"sendWebSocketMessage(_:withType:withData:completion:)","abstract":"

    Sends an engine.io message through the WebSocket transport.

    ","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP11invalidatedSbvp":{"name":"invalidated","abstract":"

    true If engine’s session has been invalidated.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP8postWaitSaySS3msg_yycSg10completiontGvp":{"name":"postWait","abstract":"

    A queue of engine.io messages waiting for POSTing

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP7sessionSo12NSURLSessionCSgvp":{"name":"session","abstract":"

    The URLSession that will be used for polling.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP14waitingForPollSbvp":{"name":"waitingForPoll","abstract":"

    true if there is an outstanding poll. Trying to poll before the first is done will cause socket.io to","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP14waitingForPostSbvp":{"name":"waitingForPost","abstract":"

    true if there is an outstanding post. Trying to post before the first is done will cause socket.io to","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP6doPollyyF":{"name":"doPoll()","abstract":"

    Call to send a long-polling request.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP15sendPollMessage_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF":{"name":"sendPollMessage(_:withType:withData:completion:)","abstract":"

    Sends an engine.io message through the polling transport.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP11stopPollingyyF":{"name":"stopPolling()","abstract":"

    Call to stop polling and invalidate the URLSession.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidErrorWithReason:":{"name":"engineDidError(reason:)","abstract":"

    Called when the engine errors.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidCloseWithReason:":{"name":"engineDidClose(reason:)","abstract":"

    Called when the engine closes.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidOpenWithReason:":{"name":"engineDidOpen(reason:)","abstract":"

    Called when the engine opens.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidReceivePong":{"name":"engineDidReceivePong()","abstract":"

    Called when the engine receives a pong message.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidSendPing":{"name":"engineDidSendPing()","abstract":"

    Called when the engine sends a ping to the server.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"

    Called when the engine has a message that must be parsed.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineBinaryData:":{"name":"parseEngineBinaryData(_:)","abstract":"

    Called when the engine receives binary data.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidWebsocketUpgradeWithHeaders:":{"name":"engineDidWebsocketUpgrade(headers:)","abstract":"

    Called when when upgrading the http connection to a websocket connection.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)client":{"name":"client","abstract":"

    The client for this engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)closed":{"name":"closed","abstract":"

    true if this engine is closed.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)compress":{"name":"compress","abstract":"

    If true the engine will attempt to use WebSocket compression.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)connected":{"name":"connected","abstract":"

    true if this engine is connected. Connected means that the initial poll connect has succeeded.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)connectParams":{"name":"connectParams","abstract":"

    The connect parameters sent during a connect.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)cookies":{"name":"cookies","abstract":"

    An array of HTTPCookies that are sent during the connection.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)engineQueue":{"name":"engineQueue","abstract":"

    The queue that all engine actions take place on.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)extraHeaders":{"name":"extraHeaders","abstract":"

    A dictionary of extra http headers that will be set during connection.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)fastUpgrade":{"name":"fastUpgrade","abstract":"

    When true, the engine is in the process of switching to WebSockets.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)forcePolling":{"name":"forcePolling","abstract":"

    When true, the engine will only use HTTP long-polling as a transport.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)forceWebsockets":{"name":"forceWebsockets","abstract":"

    When true, the engine will only use WebSockets as a transport.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)polling":{"name":"polling","abstract":"

    If true, the engine is currently in HTTP long-polling mode.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)probing":{"name":"probing","abstract":"

    If true, the engine is currently seeing whether it can upgrade to WebSockets.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)sid":{"name":"sid","abstract":"

    The session id for this engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)socketPath":{"name":"socketPath","abstract":"

    The path to engine.io.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)urlPolling":{"name":"urlPolling","abstract":"

    The url for polling.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)urlWebSocket":{"name":"urlWebSocket","abstract":"

    The url for WebSockets.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)websocket":{"name":"websocket","abstract":"

    If true, then the engine is currently in WebSockets mode.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)ws":{"name":"ws","abstract":"

    The WebSocket for this engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)initWithClient:url:options:":{"name":"init(client:url:options:)","abstract":"

    Creates a new engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)connect":{"name":"connect()","abstract":"

    Starts the connection to the server.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)didErrorWithReason:":{"name":"didError(reason:)","abstract":"

    Called when an error happens during execution. Causes a disconnection.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)disconnectWithReason:":{"name":"disconnect(reason:)","abstract":"

    Disconnects from the server.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)doFastUpgrade":{"name":"doFastUpgrade()","abstract":"

    Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)flushWaitingForPostToWebSocket":{"name":"flushWaitingForPostToWebSocket()","abstract":"

    Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)parseEngineData:":{"name":"parseEngineData(_:)","abstract":"

    Parses raw binary received from engine.io.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"

    Parses a raw engine.io packet.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)write:withType:withData:completion:":{"name":"write(_:withType:withData:completion:)","abstract":"

    Writes a message to engine.io, independent of transport.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html":{"name":"SocketEngineSpec","abstract":"

    Specifies a SocketEngine.

    "},"Protocols/SocketEngineClient.html":{"name":"SocketEngineClient","abstract":"

    Declares that a type will be a delegate to an engine.

    "},"Protocols/SocketEnginePollable.html":{"name":"SocketEnginePollable","abstract":"

    Protocol that is used to implement socket.io polling support

    "},"Protocols/SocketEngineWebsocket.html":{"name":"SocketEngineWebsocket","abstract":"

    Protocol that is used to implement socket.io WebSocket support

    "},"Protocols/SocketIOClientSpec.html":{"name":"SocketIOClientSpec","abstract":"

    Defines the interface for a SocketIOClient.

    "},"Protocols/ConfigSettable.html":{"name":"ConfigSettable","abstract":"

    Declares that a type can set configs from a SocketIOClientConfiguration.

    "},"Protocols/SocketData.html":{"name":"SocketData","abstract":"

    A marking protocol that says a type can be represented in a socket.io packet.

    "},"Protocols/SocketLogger.html":{"name":"SocketLogger","abstract":"

    Represents a class will log client events.

    "},"Protocols/SocketParsable.html":{"name":"SocketParsable","abstract":"

    Defines that a type will be able to parse socket.io-protocol messages.

    "},"Protocols/SocketDataBufferable.html":{"name":"SocketDataBufferable","abstract":"

    Says that a type will be able to buffer binary data before all data for an event has come in.

    "},"Protocols/SocketManagerSpec.html":{"name":"SocketManagerSpec","abstract":"

    A manager for a socket.io connection.

    "},"Enums/SocketParsableError.html#/s:8SocketIO0A13ParsableErrorO16invalidDataArrayyA2CmF":{"name":"invalidDataArray","abstract":"

    Thrown when a packet received has an invalid data array, or is missing the data array.

    ","parent_name":"SocketParsableError"},"Enums/SocketParsableError.html#/s:8SocketIO0A13ParsableErrorO13invalidPacketyA2CmF":{"name":"invalidPacket","abstract":"

    Thrown when an malformed packet is received.

    ","parent_name":"SocketParsableError"},"Enums/SocketParsableError.html#/s:8SocketIO0A13ParsableErrorO17invalidPacketTypeyA2CmF":{"name":"invalidPacketType","abstract":"

    Thrown when the parser receives an unknown packet type.

    ","parent_name":"SocketParsableError"},"Enums/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusNotConnected":{"name":"notConnected","abstract":"

    The client/manager has never been connected. Or the client has been reset.

    ","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusDisconnected":{"name":"disconnected","abstract":"

    The client/manager was once connected, but not anymore.

    ","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusConnecting":{"name":"connecting","abstract":"

    The client/manager is in the process of connecting.

    ","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusConnected":{"name":"connected","abstract":"

    The client/manager is currently connected.

    ","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/s:8SocketIO0A8IOStatusO6activeSbvp":{"name":"active","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SocketIOStatus"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8compressyA2CmF":{"name":"compress","abstract":"

    If given, the WebSocket transport will attempt to use compression.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO13connectParamsyACSDySSypGcACmF":{"name":"connectParams(_:)","abstract":"

    A dictionary of GET parameters that will be included in the connect url.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO7cookiesyACSaySo12NSHTTPCookieCGcACmF":{"name":"cookies(_:)","abstract":"

    An array of cookies that will be sent during the initial connection.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO12extraHeadersyACSDyS2SGcACmF":{"name":"extraHeaders(_:)","abstract":"

    Any extra HTTP headers that should be sent during the initial connection.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8forceNewyACSbcACmF":{"name":"forceNew(_:)","abstract":"

    If passed true, will cause the client to always create a new engine. Useful for debugging,","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO12forcePollingyACSbcACmF":{"name":"forcePolling(_:)","abstract":"

    If passed true, the only transport that will be used will be HTTP long-polling.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO15forceWebsocketsyACSbcACmF":{"name":"forceWebsockets(_:)","abstract":"

    If passed true, the only transport that will be used will be WebSockets.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO11handleQueueyACSo17OS_dispatch_queueCcACmF":{"name":"handleQueue(_:)","abstract":"

    The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO3logyACSbcACmF":{"name":"log(_:)","abstract":"

    If passed true, the client will log debug information. This should be turned off in production code.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO6loggeryAcA0A6Logger_pcACmF":{"name":"logger(_:)","abstract":"

    Used to pass in a custom logger.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO4pathyACSScACmF":{"name":"path(_:)","abstract":"

    A custom path to socket.io. Only use this if the socket.io server is configured to look for this path.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO10reconnectsyACSbcACmF":{"name":"reconnects(_:)","abstract":"

    If passed false, the client will not reconnect when it loses connection. Useful if you want full control","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO17reconnectAttemptsyACSicACmF":{"name":"reconnectAttempts(_:)","abstract":"

    The number of times to try and reconnect before giving up. Pass -1 to never give up.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO13reconnectWaityACSicACmF":{"name":"reconnectWait(_:)","abstract":"

    The number of seconds to wait before reconnect attempts.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO6secureyACSbcACmF":{"name":"secure(_:)","abstract":"

    Set true if your server is using secure transports.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8securityyAcA11SSLSecurityCcACmF":{"name":"security(_:)","abstract":"

    Allows you to set which certs are valid. Useful for SSL pinning.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO10selfSignedyACSbcACmF":{"name":"selfSigned(_:)","abstract":"

    If you’re using a self-signed set. Only use for development.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO15sessionDelegateyACSo012NSURLSessionF0_pcACmF":{"name":"sessionDelegate(_:)","abstract":"

    Sets an NSURLSessionDelegate for the underlying engine. Useful if you need to handle self-signed certs.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO11descriptionSSvp":{"name":"description","abstract":"

    The description of this option.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compares whether two options are the same.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO7connectyA2CmF":{"name":"connect","abstract":"

    Emitted when the client connects. This is also called on a successful reconnection. A connect event gets one","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO10disconnectyA2CmF":{"name":"disconnect","abstract":"

    Emitted when the socket has disconnected and will not attempt to try to reconnect.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO5erroryA2CmF":{"name":"error","abstract":"

    Emitted when an error occurs.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO4pingyA2CmF":{"name":"ping","abstract":"

    Emitted whenever the engine sends a ping.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO4pongyA2CmF":{"name":"pong","abstract":"

    Emitted whenever the engine gets a pong.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO9reconnectyA2CmF":{"name":"reconnect","abstract":"

    Emitted when the client begins the reconnection process.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO16reconnectAttemptyA2CmF":{"name":"reconnectAttempt","abstract":"

    Emitted each time the client tries to reconnect to the server.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO12statusChangeyA2CmF":{"name":"statusChange","abstract":"

    Emitted every time there is a change in the client’s status.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO16websocketUpgradeyA2CmF":{"name":"websocketUpgrade","abstract":"

    Emitted when when upgrading the http connection to a websocket connection.

    ","parent_name":"SocketClientEvent"},"Enums/SocketAckStatus.html#/s:8SocketIO0A9AckStatusO02noC0yA2CmF":{"name":"noAck","abstract":"

    The ack timed out.

    ","parent_name":"SocketAckStatus"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeOpen":{"name":"open","abstract":"

    Open message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeClose":{"name":"close","abstract":"

    Close message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypePing":{"name":"ping","abstract":"

    Ping message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypePong":{"name":"pong","abstract":"

    Pong message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeMessage":{"name":"message","abstract":"

    Regular message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeUpgrade":{"name":"upgrade","abstract":"

    Upgrade message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeNoop":{"name":"noop","abstract":"

    NOOP.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html":{"name":"SocketEnginePacketType","abstract":"

    Represents the type of engine.io packet types.

    "},"Enums/SocketAckStatus.html":{"name":"SocketAckStatus","abstract":"

    The status of an ack.

    "},"Enums/SocketClientEvent.html":{"name":"SocketClientEvent","abstract":"

    The set of events that are generated by the client.

    "},"Enums/SocketIOClientOption.html":{"name":"SocketIOClientOption","abstract":"

    The options for a client.

    "},"Enums/SocketIOStatus.html":{"name":"SocketIOStatus","abstract":"

    Represents state of a manager or client.

    "},"Enums/SocketParsableError.html":{"name":"SocketParsableError","abstract":"

    Errors that can be thrown during parsing.

    "},"Classes/SocketRawAckView.html#/s:8SocketIO0A10RawAckViewC4withyyAA0A4Data_pd_tF":{"name":"with(_:)","abstract":"

    Call to ack receiving this event.

    ","parent_name":"SocketRawAckView"},"Classes/SocketRawAckView.html#/c:@M@SocketIO@objc(cs)SocketRawAckView(im)with:":{"name":"with(_:)","abstract":"

    Call to ack receiving this event.

    ","parent_name":"SocketRawAckView"},"Classes/SocketRawView.html#/s:8SocketIO0A7RawViewC4emityySS_AA0A4Data_pdtF":{"name":"emit(_:_:)","abstract":"

    Send an event to the server, with optional data items.

    ","parent_name":"SocketRawView"},"Classes/SocketRawView.html#/c:@M@SocketIO@objc(cs)SocketRawView(im)emit:with:":{"name":"emit(_:with:)","abstract":"

    Same as emit, but meant for Objective-C

    ","parent_name":"SocketRawView"},"Classes/SocketRawView.html#/s:8SocketIO0A7RawViewC11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF":{"name":"emitWithAck(_:_:)","abstract":"

    Sends a message to the server, requesting an ack.

    ","parent_name":"SocketRawView"},"Classes/SocketRawView.html#/c:@M@SocketIO@objc(cs)SocketRawView(im)emitWithAck:with:":{"name":"emitWithAck(_:with:)","abstract":"

    Same as emitWithAck, but for Objective-C

    ","parent_name":"SocketRawView"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)defaultSocket":{"name":"defaultSocket","abstract":"

    The socket associated with the default namespace (/).

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)socketURL":{"name":"socketURL","abstract":"

    The URL of the socket.io server.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC6configAA0A21IOClientConfigurationVvp":{"name":"config","abstract":"

    The configuration for this client.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)engine":{"name":"engine","abstract":"

    The engine for this manager.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)forceNew":{"name":"forceNew","abstract":"

    If true then every time connect is called, a new engine will be created.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)handleQueue":{"name":"handleQueue","abstract":"

    The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)nsps":{"name":"nsps","abstract":"

    The sockets in this manager indexed by namespace.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)reconnects":{"name":"reconnects","abstract":"

    If true, this client will try and reconnect on any disconnects.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)reconnectWait":{"name":"reconnectWait","abstract":"

    The number of seconds to wait before attempting to reconnect.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)status":{"name":"status","abstract":"

    The status of this manager.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC14waitingPacketsSayAA0A6PacketVGvp":{"name":"waitingPackets","abstract":"

    A list of packets that are waiting for binary data.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC9socketURL6configAC10Foundation0E0V_AA0A21IOClientConfigurationVtcfc":{"name":"init(socketURL:config:)","abstract":"

    Type safe way to create a new SocketIOClient. opts can be omitted.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)initWithSocketURL:config:":{"name":"init(socketURL:config:)","abstract":"

    Not so type safe way to create a SocketIOClient, meant for Objective-C compatiblity.","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)connect":{"name":"connect()","abstract":"

    Connects the underlying transport and the default namespace socket.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)connectSocket:":{"name":"connectSocket(_:)","abstract":"

    Connects a socket through this manager’s engine.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)didDisconnectWithReason:":{"name":"didDisconnect(reason:)","abstract":"

    Called when the manager has disconnected from socket.io.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnect":{"name":"disconnect()","abstract":"

    Disconnects the manager and all associated sockets.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnectSocket:":{"name":"disconnectSocket(_:)","abstract":"

    Disconnects the given socket.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnectSocketForNamespace:":{"name":"disconnectSocket(forNamespace:)","abstract":"

    Disconnects the socket associated with forNamespace.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC7emitAll11clientEvent4datayAA0a6ClientG0O_SayypGtF":{"name":"emitAll(clientEvent:data:)","abstract":"

    Sends a client event to all sockets in nsps

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC7emitAllyySS_AA0A4Data_pdtF":{"name":"emitAll(_:_:)","abstract":"

    Sends an event to the server on all namespaces in this manager.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)emitAll:withItems:":{"name":"emitAll(_:withItems:)","abstract":"

    Sends an event to the server on all namespaces in this manager.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidCloseWithReason:":{"name":"engineDidClose(reason:)","abstract":"

    Called when the engine closes.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidErrorWithReason:":{"name":"engineDidError(reason:)","abstract":"

    Called when the engine errors.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidOpenWithReason:":{"name":"engineDidOpen(reason:)","abstract":"

    Called when the engine opens.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidReceivePong":{"name":"engineDidReceivePong()","abstract":"

    Called when the engine receives a pong message.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidSendPing":{"name":"engineDidSendPing()","abstract":"

    Called when the sends a ping to the server.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidWebsocketUpgradeWithHeaders:":{"name":"engineDidWebsocketUpgrade(headers:)","abstract":"

    Called when when upgrading the http connection to a websocket connection.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"

    Called when the engine has a message that must be parsed.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineBinaryData:":{"name":"parseEngineBinaryData(_:)","abstract":"

    Called when the engine receives binary data.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)reconnect":{"name":"reconnect()","abstract":"

    Tries to reconnect to the server.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)removeSocket:":{"name":"removeSocket(_:)","abstract":"

    Removes the socket from the manager’s control. One of the disconnect methods should be called before calling this","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC10setConfigsyyAA0A21IOClientConfigurationVF":{"name":"setConfigs(_:)","abstract":"

    Sets manager specific configs.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)socketForNamespace:":{"name":"socket(forNamespace:)","abstract":"

    Returns a SocketIOClient for the given namespace. This socket shares a transport with the manager.

    ","parent_name":"SocketManager"},"Classes/SSLSecurity.html#/s:8SocketIO11SSLSecurityC8security10StarscreamABCvp":{"name":"security","abstract":"

    The internal Starscream SSLSecurity.

    ","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/c:@M@SocketIO@objc(cs)SSLSecurity(im)initWithUsePublicKeys:":{"name":"init(usePublicKeys:)","abstract":"

    Creates a new SSLSecurity that specifies whether to use publicKeys or certificates should be used for SSL","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:8SocketIO11SSLSecurityC5certs13usePublicKeysACSay10Starscream7SSLCertCG_Sbtcfc":{"name":"init(certs:usePublicKeys:)","abstract":"

    Designated init

    ","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:8SocketIO11SSLSecurityC7isValid_6domainSbSo11SecTrustRefa_SSSgtF":{"name":"isValid(_:domain:)","abstract":"

    Returns whether or not the given trust is valid.

    ","parent_name":"SSLSecurity"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)nsp":{"name":"nsp","abstract":"

    The namespace that this socket is currently connected to.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)sid":{"name":"sid","abstract":"

    The session id of this client.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10anyHandleryAA0A8AnyEventCcSgvp":{"name":"anyHandler","abstract":"

    A handler that will be called on any event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC8handlersSayAA0A12EventHandlerVGvp":{"name":"handlers","abstract":"

    The array of handlers for this socket.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)manager":{"name":"manager","abstract":"

    The manager for this socket.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)rawEmitView":{"name":"rawEmitView","abstract":"

    A view into this socket where emits do not check for binary data.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)status":{"name":"status","abstract":"

    The status of this client.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)initWithManager:nsp:":{"name":"init(manager:nsp:)","abstract":"

    Type safe way to create a new SocketIOClient. opts can be omitted.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)connect":{"name":"connect()","abstract":"

    Connect to the server. The same as calling connect(timeoutAfter:withHandler:) with a timeout of 0.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)connectWithTimeoutAfter:withHandler:":{"name":"connect(timeoutAfter:withHandler:)","abstract":"

    Connect to the server. If we aren’t connected after timeoutAfter seconds, then withHandler is called.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10didConnect11toNamespaceySS_tF":{"name":"didConnect(toNamespace:)","abstract":"

    Called when the client connects to a namespace. If the client was created with a namespace upfront,","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC13didDisconnect6reasonySS_tF":{"name":"didDisconnect(reason:)","abstract":"

    Called when the client has disconnected from socket.io.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)disconnect":{"name":"disconnect()","abstract":"

    Disconnects the socket.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC4emit__10completionySS_AA0A4Data_pdyycSgtF":{"name":"emit(_:_:completion:)","abstract":"

    Send an event to the server, with optional data items and optional write completion handler.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)emit:with:":{"name":"emit(_:with:)","abstract":"

    Same as emit, but meant for Objective-C

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)emit:with:completion:":{"name":"emit(_:with:completion:)","abstract":"

    Same as emit, but meant for Objective-C

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC11emitWithAckyAA02OnF8CallbackCSS_AA0A4Data_pdtF":{"name":"emitWithAck(_:_:)","abstract":"

    Sends a message to the server, requesting an ack.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)emitWithAck:with:":{"name":"emitWithAck(_:with:)","abstract":"

    Same as emitWithAck, but for Objective-C

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC7emitAck_4withySi_SayypGtF":{"name":"emitAck(_:with:)","abstract":"

    Call when you wish to tell the server that you’ve received the event for ack.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)handleAck:data:":{"name":"handleAck(_:data:)","abstract":"

    Called when socket.io has acked one of our emits. Causes the corresponding ack callback to be called.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC17handleClientEvent_4datayAA0aeF0O_SayypGtF":{"name":"handleClientEvent(_:data:)","abstract":"

    Called on socket.io specific events.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)handleEvent:data:isInternalMessage:withAck:":{"name":"handleEvent(_:data:isInternalMessage:withAck:)","abstract":"

    Called when we get an event from socket.io.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC12handlePacketyyAA0aE0VF":{"name":"handlePacket(_:)","abstract":"

    Causes a client to handle a socket.io packet. The namespace for the packet must match the namespace of the","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)leaveNamespace":{"name":"leaveNamespace()","abstract":"

    Call when you wish to leave a namespace and disconnect this socket.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)joinNamespace":{"name":"joinNamespace()","abstract":"

    Joins nsp.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC3off11clientEventyAA0a6ClientF0O_tF":{"name":"off(clientEvent:)","abstract":"

    Removes handler(s) for a client event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)off:":{"name":"off(_:)","abstract":"

    Removes handler(s) based on an event name.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)offWithId:":{"name":"off(id:)","abstract":"

    Removes a handler with the specified UUID gotten from an on or once

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)on:callback:":{"name":"on(_:callback:)","abstract":"

    Adds a handler for an event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC2on11clientEvent8callback10Foundation4UUIDVAA0a6ClientF0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"on(clientEvent:callback:)","abstract":"

    Adds a handler for a client event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC4once11clientEvent8callback10Foundation4UUIDVAA0a6ClientF0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"once(clientEvent:callback:)","abstract":"

    Adds a single-use handler for a client event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)once:callback:":{"name":"once(_:callback:)","abstract":"

    Adds a single-use handler for an event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)onAny:":{"name":"onAny(_:)","abstract":"

    Adds a handler that will be called on every event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)removeAllHandlers":{"name":"removeAllHandlers()","abstract":"

    Removes all handlers.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)setReconnectingWithReason:":{"name":"setReconnecting(reason:)","abstract":"

    Puts the socket back into the connecting state.","parent_name":"SocketIOClient"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)event":{"name":"event","abstract":"

    The event name.

    ","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)items":{"name":"items","abstract":"

    The data items for this event.

    ","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)description":{"name":"description","abstract":"

    The description of this event.

    ","parent_name":"SocketAnyEvent"},"Classes/OnAckCallback.html#/c:@M@SocketIO@objc(cs)OnAckCallback(im)timingOutAfter:callback:":{"name":"timingOut(after:callback:)","abstract":"

    Completes an emitWithAck. If this isn’t called, the emit never happens.

    ","parent_name":"OnAckCallback"},"Classes/SocketAckEmitter.html#/c:@M@SocketIO@objc(cs)SocketAckEmitter(py)rawEmitView":{"name":"rawEmitView","abstract":"

    A view into this emitter where emits do not check for binary data.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC8expectedSbvp":{"name":"expected","abstract":"

    If true, this handler is expecting to be acked. Call with(_: SocketData...) to ack.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC6socket6ackNumAcA0A8IOClientC_Sitcfc":{"name":"init(socket:ackNum:)","abstract":"

    Creates a new SocketAckEmitter.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC4withyyAA0A4Data_pd_tF":{"name":"with(_:)","abstract":"

    Call to ack receiving this event.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/c:@M@SocketIO@objc(cs)SocketAckEmitter(im)with:":{"name":"with(_:)","abstract":"

    Call to ack receiving this event.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)engineQueue":{"name":"engineQueue","abstract":"

    The queue that all engine actions take place on.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)connectParams":{"name":"connectParams","abstract":"

    The connect parameters sent during a connect.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)extraHeaders":{"name":"extraHeaders","abstract":"

    A dictionary of extra http headers that will be set during connection.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC8postWaitSaySS3msg_yycSg10completiontGvp":{"name":"postWait","abstract":"

    A queue of engine.io messages waiting for POSTing

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC14waitingForPollSbvp":{"name":"waitingForPoll","abstract":"

    true if there is an outstanding poll. Trying to poll before the first is done will cause socket.io to","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC14waitingForPostSbvp":{"name":"waitingForPost","abstract":"

    true if there is an outstanding post. Trying to post before the first is done will cause socket.io to","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)closed":{"name":"closed","abstract":"

    true if this engine is closed.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)compress":{"name":"compress","abstract":"

    If true the engine will attempt to use WebSocket compression.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)connected":{"name":"connected","abstract":"

    true if this engine is connected. Connected means that the initial poll connect has succeeded.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)cookies":{"name":"cookies","abstract":"

    An array of HTTPCookies that are sent during the connection.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)fastUpgrade":{"name":"fastUpgrade","abstract":"

    When true, the engine is in the process of switching to WebSockets.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)forcePolling":{"name":"forcePolling","abstract":"

    When true, the engine will only use HTTP long-polling as a transport.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)forceWebsockets":{"name":"forceWebsockets","abstract":"

    When true, the engine will only use WebSockets as a transport.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC11invalidatedSbvp":{"name":"invalidated","abstract":"

    true If engine’s session has been invalidated.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)polling":{"name":"polling","abstract":"

    If true, the engine is currently in HTTP long-polling mode.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)probing":{"name":"probing","abstract":"

    If true, the engine is currently seeing whether it can upgrade to WebSockets.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC7sessionSo12NSURLSessionCSgvp":{"name":"session","abstract":"

    The URLSession that will be used for polling.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)sid":{"name":"sid","abstract":"

    The session id for this engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)socketPath":{"name":"socketPath","abstract":"

    The path to engine.io.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)urlPolling":{"name":"urlPolling","abstract":"

    The url for polling.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)urlWebSocket":{"name":"urlWebSocket","abstract":"

    The url for WebSockets.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)websocket":{"name":"websocket","abstract":"

    If true, then the engine is currently in WebSockets mode.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)ws":{"name":"ws","abstract":"

    The WebSocket for this engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)client":{"name":"client","abstract":"

    The client for this engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC6client3url6configAcA0aC6Client_p_10Foundation3URLVAA0A21IOClientConfigurationVtcfc":{"name":"init(client:url:config:)","abstract":"

    Creates a new engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)initWithClient:url:options:":{"name":"init(client:url:options:)","abstract":"

    Creates a new engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)connect":{"name":"connect()","abstract":"

    Starts the connection to the server.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)didErrorWithReason:":{"name":"didError(reason:)","abstract":"

    Called when an error happens during execution. Causes a disconnection.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)disconnectWithReason:":{"name":"disconnect(reason:)","abstract":"

    Disconnects from the server.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)doFastUpgrade":{"name":"doFastUpgrade()","abstract":"

    Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)flushWaitingForPostToWebSocket":{"name":"flushWaitingForPostToWebSocket()","abstract":"

    Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineData:":{"name":"parseEngineData(_:)","abstract":"

    Parses raw binary received from engine.io.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"

    Parses a raw engine.io packet.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC10setConfigsyyAA0A21IOClientConfigurationVF":{"name":"setConfigs(_:)","abstract":"

    Called when the engine should set/update its configs from a given configuration.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)write:withType:withData:completion:":{"name":"write(_:withType:withData:completion:)","abstract":"

    Writes a message to engine.io, independent of transport.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC10URLSession7session25didBecomeInvalidWithErrorySo12NSURLSessionC_So7NSErrorCSgtF":{"name":"URLSession(session:didBecomeInvalidWithError:)","abstract":"

    Delegate called when the session becomes invalid.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html":{"name":"SocketEngine","abstract":"

    The class that handles the engine.io protocol and transports."},"Classes/SocketAckEmitter.html":{"name":"SocketAckEmitter","abstract":"

    A class that represents a waiting ack call.

    "},"Classes/OnAckCallback.html":{"name":"OnAckCallback","abstract":"

    A class that represents an emit that will request an ack that has not yet been sent."},"Classes/SocketAnyEvent.html":{"name":"SocketAnyEvent","abstract":"

    Represents some event that was received.

    "},"Classes/SocketIOClient.html":{"name":"SocketIOClient","abstract":"

    Represents a socket.io-client.

    "},"Classes/SSLSecurity.html":{"name":"SSLSecurity","abstract":"

    A wrapper around Starscream’s SSLSecurity that provides a minimal Objective-C interface.

    "},"Classes/SocketManager.html":{"name":"SocketManager","abstract":"

    A manager for a socket.io connection.

    "},"Classes/SocketRawView.html":{"name":"SocketRawView","abstract":"

    Class that gives a backwards compatible way to cause an emit not to recursively check for Data objects.

    "},"Classes/SocketRawAckView.html":{"name":"SocketRawAckView","abstract":"

    Class that gives a backwards compatible way to cause an emit not to recursively check for Data objects.

    "},"faq.html":{"name":"FAQ"},"12to13.html":{"name":"12to13"},"Guides.html":{"name":"Guides","abstract":"

    The following guides are available globally.

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file +{"Typealiases.html#/s:8SocketIO11AckCallbacka":{"name":"AckCallback","abstract":"

    A typealias for an ack callback.

    "},"Typealiases.html#/s:8SocketIO14NormalCallbacka":{"name":"NormalCallback","abstract":"

    A typealias for a normal callback.

    "},"Typealiases.html#/s:8SocketIO4Posta":{"name":"Post","abstract":"

    A typealias for a queued POST

    "},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO7connectyA2EmF":{"name":"connect","abstract":"

    Connect: 0

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO10disconnectyA2EmF":{"name":"disconnect","abstract":"

    Disconnect: 1

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO5eventyA2EmF":{"name":"event","abstract":"

    Event: 2

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO3ackyA2EmF":{"name":"ack","abstract":"

    Ack: 3

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO5erroryA2EmF":{"name":"error","abstract":"

    Error: 4

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO11binaryEventyA2EmF":{"name":"binaryEvent","abstract":"

    Binary Event: 5

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO9binaryAckyA2EmF":{"name":"binaryAck","abstract":"

    Binary Ack: 6

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO8isBinarySbvp":{"name":"isBinary","abstract":"

    Whether or not this type is binary

    ","parent_name":"PacketType"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV3nspSSvp":{"name":"nsp","abstract":"

    The namespace for this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV2idSivp":{"name":"id","abstract":"

    If > 0 then this packet is using acking.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV4typeAC0C4TypeOvp":{"name":"type","abstract":"

    The type of this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV6binarySay10Foundation4DataVGvp":{"name":"binary","abstract":"

    An array of binary data for this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV4dataSayypGvp":{"name":"data","abstract":"

    The data for this event.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV4argsSayypGvp":{"name":"args","abstract":"

    Returns the payload for this packet, minus the event name if this is an event or binaryEvent type packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV11descriptionSSvp":{"name":"description","abstract":"

    A string representation of this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV5eventSSvp":{"name":"event","abstract":"

    The event name for this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV12packetStringSSvp":{"name":"packetString","abstract":"

    A string representation of this packet.

    ","parent_name":"SocketPacket"},"Structs/SocketPacket/PacketType.html":{"name":"PacketType","abstract":"

    The type of packets.

    ","parent_name":"SocketPacket"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV7Elementa":{"name":"Element","abstract":"

    Type of element stored.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa":{"name":"Index","abstract":"

    Index type.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV8Iteratora":{"name":"Iterator","abstract":"

    Iterator type.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV11SubSequencea":{"name":"SubSequence","abstract":"

    SubSequence type.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV10startIndexSivp":{"name":"startIndex","abstract":"

    The start index of this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV8endIndexSivp":{"name":"endIndex","abstract":"

    The end index of this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV7isEmptySbvp":{"name":"isEmpty","abstract":"

    Whether this collection is empty.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5countSivp":{"name":"count","abstract":"

    The number of elements stored in this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5firstAA0aC6OptionOSgvp":{"name":"first","abstract":"

    The first element in this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:Sly7ElementQz5IndexQzcip":{"name":"subscript(_:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:Sly11SubSequenceQzSny5IndexQzGcip":{"name":"subscript(_:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV12arrayLiteralAcA0aC6OptionOd_tcfc":{"name":"init(arrayLiteral:)","abstract":"

    Creates a new SocketIOClientConfiguration from an array literal.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV12makeIterators08IndexingF0VySayAA0aC6OptionOGGyF":{"name":"makeIterator()","abstract":"

    Creates an iterator for this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5index5afterS2i_tF":{"name":"index(after:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV6insert_9replacingyAA0aC6OptionO_SbtF":{"name":"insert(_:replacing:)","abstract":"

    Special method that inserts element into the collection, replacing any other instances of element.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV5eventSSvp":{"name":"event","abstract":"

    The event for this handler.

    ","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV2id10Foundation4UUIDVvp":{"name":"id","abstract":"

    A unique identifier for this handler.

    ","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV8callbackyySayypG_AA0A10AckEmitterCtcvp":{"name":"callback","abstract":"

    The actual handler function.

    ","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV15executeCallback4with0G3Ack0gA0ySayypG_SiAA0A8IOClientCtF":{"name":"executeCallback(with:withAck:withSocket:)","abstract":"

    Causes this handler to be executed.

    ","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html":{"name":"SocketEventHandler","abstract":"

    A wrapper around a handler.

    "},"Structs/SocketIOClientConfiguration.html":{"name":"SocketIOClientConfiguration","abstract":"

    An array-like type that holds SocketIOClientOptions

    "},"Structs/SocketPacket.html":{"name":"SocketPacket","abstract":"

    A struct that represents a socket.io packet.

    "},"Protocols/SocketData.html#/s:8SocketIO0A4DataP20socketRepresentationAaB_pyKF":{"name":"socketRepresentation()","abstract":"

    A representation of self that can sent over socket.io.

    ","parent_name":"SocketData"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP3logSbvp":{"name":"log","abstract":"

    Whether to log or not

    ","parent_name":"SocketLogger"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP3log_4typeySSyXK_SStF":{"name":"log(_:type:)","abstract":"

    Normal log messages

    ","parent_name":"SocketLogger"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP5error_4typeySSyXK_SStF":{"name":"error(_:type:)","abstract":"

    Error Messages

    ","parent_name":"SocketLogger"},"Protocols/SocketDataBufferable.html#/s:8SocketIO0A14DataBufferableP14waitingPacketsSayAA0A6PacketVGvp":{"name":"waitingPackets","abstract":"

    A list of packets that are waiting for binary data.

    ","parent_name":"SocketDataBufferable"},"Protocols/SocketParsable.html#/s:8SocketIO0A8ParsableP15parseBinaryDatayAA0A6PacketVSg10Foundation0F0VF":{"name":"parseBinaryData(_:)","abstract":"

    Called when the engine has received some binary data that should be attached to a packet.

    ","parent_name":"SocketParsable"},"Protocols/SocketParsable.html#/s:8SocketIO0A8ParsableP05parseA7MessageyAA0A6PacketVSgSSF":{"name":"parseSocketMessage(_:)","abstract":"

    Called when the engine has received a string that should be parsed into a socket.io packet.

    ","parent_name":"SocketParsable"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)defaultSocket":{"name":"defaultSocket","abstract":"

    Returns the socket associated with the default namespace (/).

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)engine":{"name":"engine","abstract":"

    The engine for this manager.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)forceNew":{"name":"forceNew","abstract":"

    If true then every time connect is called, a new engine will be created.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)handleQueue":{"name":"handleQueue","abstract":"

    The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)nsps":{"name":"nsps","abstract":"

    The sockets in this manager indexed by namespace.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnects":{"name":"reconnects","abstract":"

    If true, this manager will try and reconnect on any disconnects.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnectWait":{"name":"reconnectWait","abstract":"

    The minimum number of seconds to wait before attempting to reconnect.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnectWaitMax":{"name":"reconnectWaitMax","abstract":"

    The maximum number of seconds to wait before attempting to reconnect.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)randomizationFactor":{"name":"randomizationFactor","abstract":"

    The randomization factor for calculating reconnect jitter.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)socketURL":{"name":"socketURL","abstract":"

    The URL of the socket.io server.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)status":{"name":"status","abstract":"

    The status of this manager.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)connect":{"name":"connect()","abstract":"

    Connects the underlying transport.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)connectSocket:":{"name":"connectSocket(_:)","abstract":"

    Connects a socket through this manager’s engine.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)didDisconnectWithReason:":{"name":"didDisconnect(reason:)","abstract":"

    Called when the manager has disconnected from socket.io.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnect":{"name":"disconnect()","abstract":"

    Disconnects the manager and all associated sockets.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnectSocket:":{"name":"disconnectSocket(_:)","abstract":"

    Disconnects the given socket.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnectSocketForNamespace:":{"name":"disconnectSocket(forNamespace:)","abstract":"

    Disconnects the socket associated with forNamespace.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)emitAll:withItems:":{"name":"emitAll(_:withItems:)","abstract":"

    Sends an event to the server on all namespaces in this manager.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)reconnect":{"name":"reconnect()","abstract":"

    Tries to reconnect to the server.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)removeSocket:":{"name":"removeSocket(_:)","abstract":"

    Removes the socket from the manager’s control.","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)socketForNamespace:":{"name":"socket(forNamespace:)","abstract":"

    Returns a SocketIOClient for the given namespace. This socket shares a transport with the manager.

    ","parent_name":"SocketManagerSpec"},"Protocols/SocketEngineWebsocket.html#/s:8SocketIO0A15EngineWebsocketP07sendWebA7Message_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF":{"name":"sendWebSocketMessage(_:withType:withData:completion:)","abstract":"

    Sends an engine.io message through the WebSocket transport.

    ","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)client":{"name":"client","abstract":"

    The client for this engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)closed":{"name":"closed","abstract":"

    true if this engine is closed.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)compress":{"name":"compress","abstract":"

    If true the engine will attempt to use WebSocket compression.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)connected":{"name":"connected","abstract":"

    true if this engine is connected. Connected means that the initial poll connect has succeeded.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)connectParams":{"name":"connectParams","abstract":"

    The connect parameters sent during a connect.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)cookies":{"name":"cookies","abstract":"

    An array of HTTPCookies that are sent during the connection.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)engineQueue":{"name":"engineQueue","abstract":"

    The queue that all engine actions take place on.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)extraHeaders":{"name":"extraHeaders","abstract":"

    A dictionary of extra http headers that will be set during connection.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)fastUpgrade":{"name":"fastUpgrade","abstract":"

    When true, the engine is in the process of switching to WebSockets.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)forcePolling":{"name":"forcePolling","abstract":"

    When true, the engine will only use HTTP long-polling as a transport.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)forceWebsockets":{"name":"forceWebsockets","abstract":"

    When true, the engine will only use WebSockets as a transport.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)polling":{"name":"polling","abstract":"

    If true, the engine is currently in HTTP long-polling mode.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)probing":{"name":"probing","abstract":"

    If true, the engine is currently seeing whether it can upgrade to WebSockets.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)sid":{"name":"sid","abstract":"

    The session id for this engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)socketPath":{"name":"socketPath","abstract":"

    The path to engine.io.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)urlPolling":{"name":"urlPolling","abstract":"

    The url for polling.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)urlWebSocket":{"name":"urlWebSocket","abstract":"

    The url for WebSockets.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)websocket":{"name":"websocket","abstract":"

    If true, then the engine is currently in WebSockets mode.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)ws":{"name":"ws","abstract":"

    The WebSocket for this engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)initWithClient:url:options:":{"name":"init(client:url:options:)","abstract":"

    Creates a new engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)connect":{"name":"connect()","abstract":"

    Starts the connection to the server.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)didErrorWithReason:":{"name":"didError(reason:)","abstract":"

    Called when an error happens during execution. Causes a disconnection.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)disconnectWithReason:":{"name":"disconnect(reason:)","abstract":"

    Disconnects from the server.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)doFastUpgrade":{"name":"doFastUpgrade()","abstract":"

    Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)flushWaitingForPostToWebSocket":{"name":"flushWaitingForPostToWebSocket()","abstract":"

    Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)parseEngineData:":{"name":"parseEngineData(_:)","abstract":"

    Parses raw binary received from engine.io.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"

    Parses a raw engine.io packet.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)write:withType:withData:completion:":{"name":"write(_:withType:withData:completion:)","abstract":"

    Writes a message to engine.io, independent of transport.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP11invalidatedSbvp":{"name":"invalidated","abstract":"

    true If engine’s session has been invalidated.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP8postWaitSaySS3msg_yycSg10completiontGvp":{"name":"postWait","abstract":"

    A queue of engine.io messages waiting for POSTing

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP7sessionSo12NSURLSessionCSgvp":{"name":"session","abstract":"

    The URLSession that will be used for polling.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP14waitingForPollSbvp":{"name":"waitingForPoll","abstract":"

    true if there is an outstanding poll. Trying to poll before the first is done will cause socket.io to","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP14waitingForPostSbvp":{"name":"waitingForPost","abstract":"

    true if there is an outstanding post. Trying to post before the first is done will cause socket.io to","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP6doPollyyF":{"name":"doPoll()","abstract":"

    Call to send a long-polling request.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP15sendPollMessage_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF":{"name":"sendPollMessage(_:withType:withData:completion:)","abstract":"

    Sends an engine.io message through the polling transport.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP11stopPollingyyF":{"name":"stopPolling()","abstract":"

    Call to stop polling and invalidate the URLSession.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidErrorWithReason:":{"name":"engineDidError(reason:)","abstract":"

    Called when the engine errors.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidCloseWithReason:":{"name":"engineDidClose(reason:)","abstract":"

    Called when the engine closes.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidOpenWithReason:":{"name":"engineDidOpen(reason:)","abstract":"

    Called when the engine opens.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidReceivePong":{"name":"engineDidReceivePong()","abstract":"

    Called when the engine receives a pong message.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidSendPing":{"name":"engineDidSendPing()","abstract":"

    Called when the engine sends a ping to the server.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"

    Called when the engine has a message that must be parsed.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineBinaryData:":{"name":"parseEngineBinaryData(_:)","abstract":"

    Called when the engine receives binary data.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidWebsocketUpgradeWithHeaders:":{"name":"engineDidWebsocketUpgrade(headers:)","abstract":"

    Called when when upgrading the http connection to a websocket connection.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP10anyHandleryAA0A8AnyEventCcSgvp":{"name":"anyHandler","abstract":"

    A handler that will be called on any event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP8handlersSayAA0A12EventHandlerVGvp":{"name":"handlers","abstract":"

    The array of handlers for this socket.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7managerAA0a7ManagerD0_pSgvp":{"name":"manager","abstract":"

    The manager for this socket.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3nspSSvp":{"name":"nsp","abstract":"

    The namespace that this socket is currently connected to.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP11rawEmitViewAA0a3RawG0Cvp":{"name":"rawEmitView","abstract":"

    A view into this socket where emits do not check for binary data.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP6statusAA0A8IOStatusOvp":{"name":"status","abstract":"

    The status of this client.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7connectyyF":{"name":"connect()","abstract":"

    Connect to the server. The same as calling connect(timeoutAfter:withHandler:) with a timeout of 0.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7connect12timeoutAfter11withHandlerySd_yycSgtF":{"name":"connect(timeoutAfter:withHandler:)","abstract":"

    Connect to the server. If we aren’t connected after timeoutAfter seconds, then withHandler is called.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP10didConnect11toNamespaceySS_tF":{"name":"didConnect(toNamespace:)","abstract":"

    Called when the client connects to a namespace. If the client was created with a namespace upfront,","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP13didDisconnect6reasonySS_tF":{"name":"didDisconnect(reason:)","abstract":"

    Called when the client has disconnected from socket.io.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP8didError6reasonySS_tF":{"name":"didError(reason:)","abstract":"

    Called when the client encounters an error.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP10disconnectyyF":{"name":"disconnect()","abstract":"

    Disconnects the socket.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP4emit__10completionySS_AA0A4Data_pdyycSgtF":{"name":"emit(_:_:completion:)","abstract":"

    Send an event to the server, with optional data items and optional write completion handler.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7emitAck_4withySi_SayypGtF":{"name":"emitAck(_:with:)","abstract":"

    Call when you wish to tell the server that you’ve received the event for ack.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF":{"name":"emitWithAck(_:_:)","abstract":"

    Sends a message to the server, requesting an ack.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP9handleAck_4dataySi_SayypGtF":{"name":"handleAck(_:data:)","abstract":"

    Called when socket.io has acked one of our emits. Causes the corresponding ack callback to be called.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP17handleClientEvent_4datayAA0afG0O_SayypGtF":{"name":"handleClientEvent(_:data:)","abstract":"

    Called on socket.io specific events.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP11handleEvent_4data17isInternalMessage7withAckySS_SayypGSbSitF":{"name":"handleEvent(_:data:isInternalMessage:withAck:)","abstract":"

    Called when we get an event from socket.io.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP12handlePacketyyAA0aF0VF":{"name":"handlePacket(_:)","abstract":"

    Causes a client to handle a socket.io packet. The namespace for the packet must match the namespace of the","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP14leaveNamespaceyyF":{"name":"leaveNamespace()","abstract":"

    Call when you wish to leave a namespace and disconnect this socket.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP13joinNamespaceyyF":{"name":"joinNamespace()","abstract":"

    Joins nsp.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3off11clientEventyAA0a6ClientG0O_tF":{"name":"off(clientEvent:)","abstract":"

    Removes handler(s) for a client event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3offyySSF":{"name":"off(_:)","abstract":"

    Removes handler(s) based on an event name.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3off2idy10Foundation4UUIDV_tF":{"name":"off(id:)","abstract":"

    Removes a handler with the specified UUID gotten from an on or once

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP2on_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF":{"name":"on(_:callback:)","abstract":"

    Adds a handler for an event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP2on11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"on(clientEvent:callback:)","abstract":"

    Adds a handler for a client event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP4once11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"once(clientEvent:callback:)","abstract":"

    Adds a single-use handler for a client event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP4once_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF":{"name":"once(_:callback:)","abstract":"

    Adds a single-use handler for an event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP5onAnyyyyAA0aF5EventCcF":{"name":"onAny(_:)","abstract":"

    Adds a handler that will be called on every event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP17removeAllHandlersyyF":{"name":"removeAllHandlers()","abstract":"

    Removes all handlers.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP15setReconnecting6reasonySS_tF":{"name":"setReconnecting(reason:)","abstract":"

    Puts the socket back into the connecting state.","parent_name":"SocketIOClientSpec"},"Protocols/ConfigSettable.html#/s:8SocketIO14ConfigSettableP10setConfigsyyAA0A21IOClientConfigurationVF":{"name":"setConfigs(_:)","abstract":"

    Called when an ConfigSettable should set/update its configs from a given configuration.

    ","parent_name":"ConfigSettable"},"Protocols/ConfigSettable.html":{"name":"ConfigSettable","abstract":"

    Declares that a type can set configs from a SocketIOClientConfiguration.

    "},"Protocols/SocketIOClientSpec.html":{"name":"SocketIOClientSpec","abstract":"

    Defines the interface for a SocketIOClient.

    "},"Protocols/SocketEngineClient.html":{"name":"SocketEngineClient","abstract":"

    Declares that a type will be a delegate to an engine.

    "},"Protocols/SocketEnginePollable.html":{"name":"SocketEnginePollable","abstract":"

    Protocol that is used to implement socket.io polling support

    "},"Protocols/SocketEngineSpec.html":{"name":"SocketEngineSpec","abstract":"

    Specifies a SocketEngine.

    "},"Protocols/SocketEngineWebsocket.html":{"name":"SocketEngineWebsocket","abstract":"

    Protocol that is used to implement socket.io WebSocket support

    "},"Protocols/SocketManagerSpec.html":{"name":"SocketManagerSpec","abstract":"

    A manager for a socket.io connection.

    "},"Protocols/SocketParsable.html":{"name":"SocketParsable","abstract":"

    Defines that a type will be able to parse socket.io-protocol messages.

    "},"Protocols/SocketDataBufferable.html":{"name":"SocketDataBufferable","abstract":"

    Says that a type will be able to buffer binary data before all data for an event has come in.

    "},"Protocols/SocketLogger.html":{"name":"SocketLogger","abstract":"

    Represents a class will log client events.

    "},"Protocols/SocketData.html":{"name":"SocketData","abstract":"

    A marking protocol that says a type can be represented in a socket.io packet.

    "},"Enums/SocketParsableError.html#/s:8SocketIO0A13ParsableErrorO16invalidDataArrayyA2CmF":{"name":"invalidDataArray","abstract":"

    Thrown when a packet received has an invalid data array, or is missing the data array.

    ","parent_name":"SocketParsableError"},"Enums/SocketParsableError.html#/s:8SocketIO0A13ParsableErrorO13invalidPacketyA2CmF":{"name":"invalidPacket","abstract":"

    Thrown when an malformed packet is received.

    ","parent_name":"SocketParsableError"},"Enums/SocketParsableError.html#/s:8SocketIO0A13ParsableErrorO17invalidPacketTypeyA2CmF":{"name":"invalidPacketType","abstract":"

    Thrown when the parser receives an unknown packet type.

    ","parent_name":"SocketParsableError"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeOpen":{"name":"open","abstract":"

    Open message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeClose":{"name":"close","abstract":"

    Close message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypePing":{"name":"ping","abstract":"

    Ping message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypePong":{"name":"pong","abstract":"

    Pong message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeMessage":{"name":"message","abstract":"

    Regular message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeUpgrade":{"name":"upgrade","abstract":"

    Upgrade message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeNoop":{"name":"noop","abstract":"

    NOOP.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusNotConnected":{"name":"notConnected","abstract":"

    The client/manager has never been connected. Or the client has been reset.

    ","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusDisconnected":{"name":"disconnected","abstract":"

    The client/manager was once connected, but not anymore.

    ","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusConnecting":{"name":"connecting","abstract":"

    The client/manager is in the process of connecting.

    ","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusConnected":{"name":"connected","abstract":"

    The client/manager is currently connected.

    ","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/s:8SocketIO0A8IOStatusO6activeSbvp":{"name":"active","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SocketIOStatus"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO7connectyA2CmF":{"name":"connect","abstract":"

    Emitted when the client connects. This is also called on a successful reconnection. A connect event gets one","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO10disconnectyA2CmF":{"name":"disconnect","abstract":"

    Emitted when the socket has disconnected and will not attempt to try to reconnect.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO5erroryA2CmF":{"name":"error","abstract":"

    Emitted when an error occurs.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO4pingyA2CmF":{"name":"ping","abstract":"

    Emitted whenever the engine sends a ping.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO4pongyA2CmF":{"name":"pong","abstract":"

    Emitted whenever the engine gets a pong.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO9reconnectyA2CmF":{"name":"reconnect","abstract":"

    Emitted when the client begins the reconnection process.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO16reconnectAttemptyA2CmF":{"name":"reconnectAttempt","abstract":"

    Emitted each time the client tries to reconnect to the server.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO12statusChangeyA2CmF":{"name":"statusChange","abstract":"

    Emitted every time there is a change in the client’s status.

    ","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO16websocketUpgradeyA2CmF":{"name":"websocketUpgrade","abstract":"

    Emitted when when upgrading the http connection to a websocket connection.

    ","parent_name":"SocketClientEvent"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8compressyA2CmF":{"name":"compress","abstract":"

    If given, the WebSocket transport will attempt to use compression.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO13connectParamsyACSDySSypGcACmF":{"name":"connectParams(_:)","abstract":"

    A dictionary of GET parameters that will be included in the connect url.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO7cookiesyACSaySo12NSHTTPCookieCGcACmF":{"name":"cookies(_:)","abstract":"

    An array of cookies that will be sent during the initial connection.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO12extraHeadersyACSDyS2SGcACmF":{"name":"extraHeaders(_:)","abstract":"

    Any extra HTTP headers that should be sent during the initial connection.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8forceNewyACSbcACmF":{"name":"forceNew(_:)","abstract":"

    If passed true, will cause the client to always create a new engine. Useful for debugging,","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO12forcePollingyACSbcACmF":{"name":"forcePolling(_:)","abstract":"

    If passed true, the only transport that will be used will be HTTP long-polling.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO15forceWebsocketsyACSbcACmF":{"name":"forceWebsockets(_:)","abstract":"

    If passed true, the only transport that will be used will be WebSockets.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO11handleQueueyACSo17OS_dispatch_queueCcACmF":{"name":"handleQueue(_:)","abstract":"

    The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO3logyACSbcACmF":{"name":"log(_:)","abstract":"

    If passed true, the client will log debug information. This should be turned off in production code.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO6loggeryAcA0A6Logger_pcACmF":{"name":"logger(_:)","abstract":"

    Used to pass in a custom logger.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO4pathyACSScACmF":{"name":"path(_:)","abstract":"

    A custom path to socket.io. Only use this if the socket.io server is configured to look for this path.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO10reconnectsyACSbcACmF":{"name":"reconnects(_:)","abstract":"

    If passed false, the client will not reconnect when it loses connection. Useful if you want full control","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO17reconnectAttemptsyACSicACmF":{"name":"reconnectAttempts(_:)","abstract":"

    The number of times to try and reconnect before giving up. Pass -1 to never give up.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO13reconnectWaityACSicACmF":{"name":"reconnectWait(_:)","abstract":"

    The minimum number of seconds to wait before reconnect attempts.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO16reconnectWaitMaxyACSicACmF":{"name":"reconnectWaitMax(_:)","abstract":"

    The maximum number of seconds to wait before reconnect attempts.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO19randomizationFactoryACSdcACmF":{"name":"randomizationFactor(_:)","abstract":"

    The randomization factor for calculating reconnect jitter.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO6secureyACSbcACmF":{"name":"secure(_:)","abstract":"

    Set true if your server is using secure transports.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8securityyAcA11SSLSecurityCcACmF":{"name":"security(_:)","abstract":"

    Allows you to set which certs are valid. Useful for SSL pinning.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO10selfSignedyACSbcACmF":{"name":"selfSigned(_:)","abstract":"

    If you’re using a self-signed set. Only use for development.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO15sessionDelegateyACSo012NSURLSessionF0_pcACmF":{"name":"sessionDelegate(_:)","abstract":"

    Sets an NSURLSessionDelegate for the underlying engine. Useful if you need to handle self-signed certs.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO11descriptionSSvp":{"name":"description","abstract":"

    The description of this option.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compares whether two options are the same.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketAckStatus.html#/s:8SocketIO0A9AckStatusO02noC0yA2CmF":{"name":"noAck","abstract":"

    The ack timed out.

    ","parent_name":"SocketAckStatus"},"Enums/SocketAckStatus.html":{"name":"SocketAckStatus","abstract":"

    The status of an ack.

    "},"Enums/SocketIOClientOption.html":{"name":"SocketIOClientOption","abstract":"

    The options for a client.

    "},"Enums/SocketClientEvent.html":{"name":"SocketClientEvent","abstract":"

    The set of events that are generated by the client.

    "},"Enums/SocketIOStatus.html":{"name":"SocketIOStatus","abstract":"

    Represents state of a manager or client.

    "},"Enums/SocketEnginePacketType.html":{"name":"SocketEnginePacketType","abstract":"

    Represents the type of engine.io packet types.

    "},"Enums/SocketParsableError.html":{"name":"SocketParsableError","abstract":"

    Errors that can be thrown during parsing.

    "},"Classes/SSLSecurity.html#/s:8SocketIO11SSLSecurityC8security10StarscreamABCvp":{"name":"security","abstract":"

    The internal Starscream SSLSecurity.

    ","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/c:@M@SocketIO@objc(cs)SSLSecurity(im)initWithUsePublicKeys:":{"name":"init(usePublicKeys:)","abstract":"

    Creates a new SSLSecurity that specifies whether to use publicKeys or certificates should be used for SSL","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:8SocketIO11SSLSecurityC5certs13usePublicKeysACSay10Starscream7SSLCertCG_Sbtcfc":{"name":"init(certs:usePublicKeys:)","abstract":"

    Designated init

    ","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:8SocketIO11SSLSecurityC7isValid_6domainSbSo11SecTrustRefa_SSSgtF":{"name":"isValid(_:domain:)","abstract":"

    Returns whether or not the given trust is valid.

    ","parent_name":"SSLSecurity"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)defaultSocket":{"name":"defaultSocket","abstract":"

    The socket associated with the default namespace (/).

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)socketURL":{"name":"socketURL","abstract":"

    The URL of the socket.io server.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC6configAA0A21IOClientConfigurationVvp":{"name":"config","abstract":"

    The configuration for this client.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)engine":{"name":"engine","abstract":"

    The engine for this manager.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)forceNew":{"name":"forceNew","abstract":"

    If true then every time connect is called, a new engine will be created.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)handleQueue":{"name":"handleQueue","abstract":"

    The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)nsps":{"name":"nsps","abstract":"

    The sockets in this manager indexed by namespace.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)reconnects":{"name":"reconnects","abstract":"

    If true, this client will try and reconnect on any disconnects.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)reconnectWait":{"name":"reconnectWait","abstract":"

    The minimum number of seconds to wait before attempting to reconnect.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)reconnectWaitMax":{"name":"reconnectWaitMax","abstract":"

    The maximum number of seconds to wait before attempting to reconnect.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)randomizationFactor":{"name":"randomizationFactor","abstract":"

    The randomization factor for calculating reconnect jitter.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)status":{"name":"status","abstract":"

    The status of this manager.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC14waitingPacketsSayAA0A6PacketVGvp":{"name":"waitingPackets","abstract":"

    A list of packets that are waiting for binary data.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC9socketURL6configAC10Foundation0E0V_AA0A21IOClientConfigurationVtcfc":{"name":"init(socketURL:config:)","abstract":"

    Type safe way to create a new SocketIOClient. opts can be omitted.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)initWithSocketURL:config:":{"name":"init(socketURL:config:)","abstract":"

    Not so type safe way to create a SocketIOClient, meant for Objective-C compatiblity.","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)connect":{"name":"connect()","abstract":"

    Connects the underlying transport and the default namespace socket.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)connectSocket:":{"name":"connectSocket(_:)","abstract":"

    Connects a socket through this manager’s engine.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)didDisconnectWithReason:":{"name":"didDisconnect(reason:)","abstract":"

    Called when the manager has disconnected from socket.io.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnect":{"name":"disconnect()","abstract":"

    Disconnects the manager and all associated sockets.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnectSocket:":{"name":"disconnectSocket(_:)","abstract":"

    Disconnects the given socket.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnectSocketForNamespace:":{"name":"disconnectSocket(forNamespace:)","abstract":"

    Disconnects the socket associated with forNamespace.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC7emitAll11clientEvent4datayAA0a6ClientG0O_SayypGtF":{"name":"emitAll(clientEvent:data:)","abstract":"

    Sends a client event to all sockets in nsps

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC7emitAllyySS_AA0A4Data_pdtF":{"name":"emitAll(_:_:)","abstract":"

    Sends an event to the server on all namespaces in this manager.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)emitAll:withItems:":{"name":"emitAll(_:withItems:)","abstract":"

    Sends an event to the server on all namespaces in this manager.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidCloseWithReason:":{"name":"engineDidClose(reason:)","abstract":"

    Called when the engine closes.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidErrorWithReason:":{"name":"engineDidError(reason:)","abstract":"

    Called when the engine errors.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidOpenWithReason:":{"name":"engineDidOpen(reason:)","abstract":"

    Called when the engine opens.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidReceivePong":{"name":"engineDidReceivePong()","abstract":"

    Called when the engine receives a pong message.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidSendPing":{"name":"engineDidSendPing()","abstract":"

    Called when the sends a ping to the server.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidWebsocketUpgradeWithHeaders:":{"name":"engineDidWebsocketUpgrade(headers:)","abstract":"

    Called when when upgrading the http connection to a websocket connection.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"

    Called when the engine has a message that must be parsed.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineBinaryData:":{"name":"parseEngineBinaryData(_:)","abstract":"

    Called when the engine receives binary data.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)reconnect":{"name":"reconnect()","abstract":"

    Tries to reconnect to the server.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)removeSocket:":{"name":"removeSocket(_:)","abstract":"

    Removes the socket from the manager’s control. One of the disconnect methods should be called before calling this","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC10setConfigsyyAA0A21IOClientConfigurationVF":{"name":"setConfigs(_:)","abstract":"

    Sets manager specific configs.

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)socketForNamespace:":{"name":"socket(forNamespace:)","abstract":"

    Returns a SocketIOClient for the given namespace. This socket shares a transport with the manager.

    ","parent_name":"SocketManager"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)engineQueue":{"name":"engineQueue","abstract":"

    The queue that all engine actions take place on.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)connectParams":{"name":"connectParams","abstract":"

    The connect parameters sent during a connect.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)extraHeaders":{"name":"extraHeaders","abstract":"

    A dictionary of extra http headers that will be set during connection.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC8postWaitSaySS3msg_yycSg10completiontGvp":{"name":"postWait","abstract":"

    A queue of engine.io messages waiting for POSTing

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC14waitingForPollSbvp":{"name":"waitingForPoll","abstract":"

    true if there is an outstanding poll. Trying to poll before the first is done will cause socket.io to","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC14waitingForPostSbvp":{"name":"waitingForPost","abstract":"

    true if there is an outstanding post. Trying to post before the first is done will cause socket.io to","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)closed":{"name":"closed","abstract":"

    true if this engine is closed.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)compress":{"name":"compress","abstract":"

    If true the engine will attempt to use WebSocket compression.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)connected":{"name":"connected","abstract":"

    true if this engine is connected. Connected means that the initial poll connect has succeeded.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)cookies":{"name":"cookies","abstract":"

    An array of HTTPCookies that are sent during the connection.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)fastUpgrade":{"name":"fastUpgrade","abstract":"

    When true, the engine is in the process of switching to WebSockets.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)forcePolling":{"name":"forcePolling","abstract":"

    When true, the engine will only use HTTP long-polling as a transport.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)forceWebsockets":{"name":"forceWebsockets","abstract":"

    When true, the engine will only use WebSockets as a transport.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC11invalidatedSbvp":{"name":"invalidated","abstract":"

    true If engine’s session has been invalidated.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)polling":{"name":"polling","abstract":"

    If true, the engine is currently in HTTP long-polling mode.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)probing":{"name":"probing","abstract":"

    If true, the engine is currently seeing whether it can upgrade to WebSockets.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC7sessionSo12NSURLSessionCSgvp":{"name":"session","abstract":"

    The URLSession that will be used for polling.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)sid":{"name":"sid","abstract":"

    The session id for this engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)socketPath":{"name":"socketPath","abstract":"

    The path to engine.io.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)urlPolling":{"name":"urlPolling","abstract":"

    The url for polling.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)urlWebSocket":{"name":"urlWebSocket","abstract":"

    The url for WebSockets.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)websocket":{"name":"websocket","abstract":"

    If true, then the engine is currently in WebSockets mode.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)ws":{"name":"ws","abstract":"

    The WebSocket for this engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)client":{"name":"client","abstract":"

    The client for this engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC6client3url6configAcA0aC6Client_p_10Foundation3URLVAA0A21IOClientConfigurationVtcfc":{"name":"init(client:url:config:)","abstract":"

    Creates a new engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)initWithClient:url:options:":{"name":"init(client:url:options:)","abstract":"

    Creates a new engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)connect":{"name":"connect()","abstract":"

    Starts the connection to the server.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)didErrorWithReason:":{"name":"didError(reason:)","abstract":"

    Called when an error happens during execution. Causes a disconnection.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)disconnectWithReason:":{"name":"disconnect(reason:)","abstract":"

    Disconnects from the server.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)doFastUpgrade":{"name":"doFastUpgrade()","abstract":"

    Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)flushWaitingForPostToWebSocket":{"name":"flushWaitingForPostToWebSocket()","abstract":"

    Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineData:":{"name":"parseEngineData(_:)","abstract":"

    Parses raw binary received from engine.io.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"

    Parses a raw engine.io packet.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC10setConfigsyyAA0A21IOClientConfigurationVF":{"name":"setConfigs(_:)","abstract":"

    Called when the engine should set/update its configs from a given configuration.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)write:withType:withData:completion:":{"name":"write(_:withType:withData:completion:)","abstract":"

    Writes a message to engine.io, independent of transport.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC10URLSession7session25didBecomeInvalidWithErrorySo12NSURLSessionC_So7NSErrorCSgtF":{"name":"URLSession(session:didBecomeInvalidWithError:)","abstract":"

    Delegate called when the session becomes invalid.

    ","parent_name":"SocketEngine"},"Classes/SocketRawAckView.html#/s:8SocketIO0A10RawAckViewC4withyyAA0A4Data_pd_tF":{"name":"with(_:)","abstract":"

    Call to ack receiving this event.

    ","parent_name":"SocketRawAckView"},"Classes/SocketRawAckView.html#/c:@M@SocketIO@objc(cs)SocketRawAckView(im)with:":{"name":"with(_:)","abstract":"

    Call to ack receiving this event.

    ","parent_name":"SocketRawAckView"},"Classes/SocketRawView.html#/s:8SocketIO0A7RawViewC4emityySS_AA0A4Data_pdtF":{"name":"emit(_:_:)","abstract":"

    Send an event to the server, with optional data items.

    ","parent_name":"SocketRawView"},"Classes/SocketRawView.html#/c:@M@SocketIO@objc(cs)SocketRawView(im)emit:with:":{"name":"emit(_:with:)","abstract":"

    Same as emit, but meant for Objective-C

    ","parent_name":"SocketRawView"},"Classes/SocketRawView.html#/s:8SocketIO0A7RawViewC11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF":{"name":"emitWithAck(_:_:)","abstract":"

    Sends a message to the server, requesting an ack.

    ","parent_name":"SocketRawView"},"Classes/SocketRawView.html#/c:@M@SocketIO@objc(cs)SocketRawView(im)emitWithAck:with:":{"name":"emitWithAck(_:with:)","abstract":"

    Same as emitWithAck, but for Objective-C

    ","parent_name":"SocketRawView"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)nsp":{"name":"nsp","abstract":"

    The namespace that this socket is currently connected to.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)sid":{"name":"sid","abstract":"

    The session id of this client.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10anyHandleryAA0A8AnyEventCcSgvp":{"name":"anyHandler","abstract":"

    A handler that will be called on any event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC8handlersSayAA0A12EventHandlerVGvp":{"name":"handlers","abstract":"

    The array of handlers for this socket.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)manager":{"name":"manager","abstract":"

    The manager for this socket.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)rawEmitView":{"name":"rawEmitView","abstract":"

    A view into this socket where emits do not check for binary data.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)status":{"name":"status","abstract":"

    The status of this client.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)initWithManager:nsp:":{"name":"init(manager:nsp:)","abstract":"

    Type safe way to create a new SocketIOClient. opts can be omitted.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)connect":{"name":"connect()","abstract":"

    Connect to the server. The same as calling connect(timeoutAfter:withHandler:) with a timeout of 0.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)connectWithTimeoutAfter:withHandler:":{"name":"connect(timeoutAfter:withHandler:)","abstract":"

    Connect to the server. If we aren’t connected after timeoutAfter seconds, then withHandler is called.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10didConnect11toNamespaceySS_tF":{"name":"didConnect(toNamespace:)","abstract":"

    Called when the client connects to a namespace. If the client was created with a namespace upfront,","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC13didDisconnect6reasonySS_tF":{"name":"didDisconnect(reason:)","abstract":"

    Called when the client has disconnected from socket.io.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)disconnect":{"name":"disconnect()","abstract":"

    Disconnects the socket.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC4emit__10completionySS_AA0A4Data_pdyycSgtF":{"name":"emit(_:_:completion:)","abstract":"

    Send an event to the server, with optional data items and optional write completion handler.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)emit:with:":{"name":"emit(_:with:)","abstract":"

    Same as emit, but meant for Objective-C

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)emit:with:completion:":{"name":"emit(_:with:completion:)","abstract":"

    Same as emit, but meant for Objective-C

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC11emitWithAckyAA02OnF8CallbackCSS_AA0A4Data_pdtF":{"name":"emitWithAck(_:_:)","abstract":"

    Sends a message to the server, requesting an ack.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)emitWithAck:with:":{"name":"emitWithAck(_:with:)","abstract":"

    Same as emitWithAck, but for Objective-C

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC7emitAck_4withySi_SayypGtF":{"name":"emitAck(_:with:)","abstract":"

    Call when you wish to tell the server that you’ve received the event for ack.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)handleAck:data:":{"name":"handleAck(_:data:)","abstract":"

    Called when socket.io has acked one of our emits. Causes the corresponding ack callback to be called.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC17handleClientEvent_4datayAA0aeF0O_SayypGtF":{"name":"handleClientEvent(_:data:)","abstract":"

    Called on socket.io specific events.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)handleEvent:data:isInternalMessage:withAck:":{"name":"handleEvent(_:data:isInternalMessage:withAck:)","abstract":"

    Called when we get an event from socket.io.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC12handlePacketyyAA0aE0VF":{"name":"handlePacket(_:)","abstract":"

    Causes a client to handle a socket.io packet. The namespace for the packet must match the namespace of the","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)leaveNamespace":{"name":"leaveNamespace()","abstract":"

    Call when you wish to leave a namespace and disconnect this socket.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)joinNamespace":{"name":"joinNamespace()","abstract":"

    Joins nsp.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC3off11clientEventyAA0a6ClientF0O_tF":{"name":"off(clientEvent:)","abstract":"

    Removes handler(s) for a client event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)off:":{"name":"off(_:)","abstract":"

    Removes handler(s) based on an event name.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)offWithId:":{"name":"off(id:)","abstract":"

    Removes a handler with the specified UUID gotten from an on or once

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)on:callback:":{"name":"on(_:callback:)","abstract":"

    Adds a handler for an event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC2on11clientEvent8callback10Foundation4UUIDVAA0a6ClientF0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"on(clientEvent:callback:)","abstract":"

    Adds a handler for a client event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC4once11clientEvent8callback10Foundation4UUIDVAA0a6ClientF0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"once(clientEvent:callback:)","abstract":"

    Adds a single-use handler for a client event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)once:callback:":{"name":"once(_:callback:)","abstract":"

    Adds a single-use handler for an event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)onAny:":{"name":"onAny(_:)","abstract":"

    Adds a handler that will be called on every event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)removeAllHandlers":{"name":"removeAllHandlers()","abstract":"

    Removes all handlers.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)setReconnectingWithReason:":{"name":"setReconnecting(reason:)","abstract":"

    Puts the socket back into the connecting state.","parent_name":"SocketIOClient"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)event":{"name":"event","abstract":"

    The event name.

    ","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)items":{"name":"items","abstract":"

    The data items for this event.

    ","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)description":{"name":"description","abstract":"

    The description of this event.

    ","parent_name":"SocketAnyEvent"},"Classes/OnAckCallback.html#/c:@M@SocketIO@objc(cs)OnAckCallback(im)timingOutAfter:callback:":{"name":"timingOut(after:callback:)","abstract":"

    Completes an emitWithAck. If this isn’t called, the emit never happens.

    ","parent_name":"OnAckCallback"},"Classes/SocketAckEmitter.html#/c:@M@SocketIO@objc(cs)SocketAckEmitter(py)rawEmitView":{"name":"rawEmitView","abstract":"

    A view into this emitter where emits do not check for binary data.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC8expectedSbvp":{"name":"expected","abstract":"

    If true, this handler is expecting to be acked. Call with(_: SocketData...) to ack.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC6socket6ackNumAcA0A8IOClientC_Sitcfc":{"name":"init(socket:ackNum:)","abstract":"

    Creates a new SocketAckEmitter.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC4withyyAA0A4Data_pd_tF":{"name":"with(_:)","abstract":"

    Call to ack receiving this event.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/c:@M@SocketIO@objc(cs)SocketAckEmitter(im)with:":{"name":"with(_:)","abstract":"

    Call to ack receiving this event.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html":{"name":"SocketAckEmitter","abstract":"

    A class that represents a waiting ack call.

    "},"Classes/OnAckCallback.html":{"name":"OnAckCallback","abstract":"

    A class that represents an emit that will request an ack that has not yet been sent."},"Classes/SocketAnyEvent.html":{"name":"SocketAnyEvent","abstract":"

    Represents some event that was received.

    "},"Classes/SocketIOClient.html":{"name":"SocketIOClient","abstract":"

    Represents a socket.io-client.

    "},"Classes/SocketRawView.html":{"name":"SocketRawView","abstract":"

    Class that gives a backwards compatible way to cause an emit not to recursively check for Data objects.

    "},"Classes/SocketRawAckView.html":{"name":"SocketRawAckView","abstract":"

    Class that gives a backwards compatible way to cause an emit not to recursively check for Data objects.

    "},"Classes/SocketEngine.html":{"name":"SocketEngine","abstract":"

    The class that handles the engine.io protocol and transports."},"Classes/SocketManager.html":{"name":"SocketManager","abstract":"

    A manager for a socket.io connection.

    "},"Classes/SSLSecurity.html":{"name":"SSLSecurity","abstract":"

    A wrapper around Starscream’s SSLSecurity that provides a minimal Objective-C interface.

    "},"faq.html":{"name":"FAQ"},"12to13.html":{"name":"12to13"},"Guides.html":{"name":"Guides","abstract":"

    The following guides are available globally.

    "},"Classes.html":{"name":"Classes","abstract":"

    The following classes are available globally.

    "},"Enums.html":{"name":"Enumerations","abstract":"

    The following enumerations are available globally.

    "},"Protocols.html":{"name":"Protocols","abstract":"

    The following protocols are available globally.

    "},"Structs.html":{"name":"Structures","abstract":"

    The following structures are available globally.

    "},"Typealiases.html":{"name":"Type Aliases","abstract":"

    The following type aliases are available globally.

    "}} \ No newline at end of file