From f7ef126d97313f99da45fa11cad8ba1676762963 Mon Sep 17 00:00:00 2001 From: Erik Little Date: Wed, 28 Nov 2018 17:14:29 -0500 Subject: [PATCH] bump version --- CHANGELOG.md | 5 + Socket.IO-Client-Swift.podspec | 4 +- docs/12to13.html | 7 +- docs/Classes.html | 170 +++++----- docs/Classes/OnAckCallback.html | 10 +- docs/Classes/SSLSecurity.html | 18 +- docs/Classes/SocketAckEmitter.html | 25 +- docs/Classes/SocketAnyEvent.html | 15 +- docs/Classes/SocketEngine.html | 90 +++--- docs/Classes/SocketIOClient.html | 215 ++++++++----- docs/Classes/SocketManager.html | 99 ++++-- docs/Classes/SocketRawAckView.html | 16 +- docs/Classes/SocketRawView.html | 25 +- docs/Enums.html | 140 ++++----- docs/Enums/SocketAckStatus.html | 18 +- docs/Enums/SocketClientEvent.html | 112 +++++-- docs/Enums/SocketEnginePacketType.html | 34 +- docs/Enums/SocketIOClientOption.html | 193 ++++++++---- docs/Enums/SocketIOStatus.html | 33 +- docs/Enums/SocketParsableError.html | 34 +- docs/Guides.html | 8 +- docs/Protocols.html | 291 +++++++++--------- docs/Protocols/ConfigSettable.html | 11 +- docs/Protocols/SocketData.html | 7 +- docs/Protocols/SocketDataBufferable.html | 9 +- docs/Protocols/SocketEngineClient.html | 56 +++- docs/Protocols/SocketEnginePollable.html | 33 +- docs/Protocols/SocketEngineSpec.html | 71 +++-- docs/Protocols/SocketEngineWebsocket.html | 27 +- docs/Protocols/SocketIOClientSpec.html | 129 ++++---- docs/Protocols/SocketLogger.html | 17 +- docs/Protocols/SocketManagerSpec.html | 31 +- docs/Protocols/SocketParsable.html | 15 +- docs/Structs.html | 8 +- docs/Structs/SocketEventHandler.html | 15 +- docs/Structs/SocketIOClientConfiguration.html | 43 +-- docs/Structs/SocketPacket.html | 17 +- docs/Structs/SocketPacket/PacketType.html | 70 +++-- docs/Typealiases.html | 35 ++- docs/faq.html | 7 +- docs/index.html | 7 +- docs/search.json | 2 +- 42 files changed, 1327 insertions(+), 845 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6e5d99b..5f795a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +# v13.4.0 + +- Add emits with write completion handlers. [#1096](https://github.com/socketio/socket.io-client-swift/issues/1096) +- Add ability to listen for when a websocket upgrade happens + # v13.3.1 - Fixes various bugs. [#857](https://github.com/socketio/socket.io-client-swift/issues/857), [#1078](https://github.com/socketio/socket.io-client-swift/issues/1078) diff --git a/Socket.IO-Client-Swift.podspec b/Socket.IO-Client-Swift.podspec index 4367b39..6253e45 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.3.1" + s.version = "13.4.0" s.summary = "Socket.IO-client for iOS and OS X" s.description = <<-DESC Socket.IO-client for iOS and OS X. @@ -18,7 +18,7 @@ Pod::Spec.new do |s| s.requires_arc = true s.source = { :git => "https://github.com/socketio/socket.io-client-swift.git", - :tag => 'v13.3.1', + :tag => 'v13.4.0', :submodules => true } s.pod_target_xcconfig = { diff --git a/docs/12to13.html b/docs/12to13.html index 480603b..aca489a 100644 --- a/docs/12to13.html +++ b/docs/12to13.html @@ -173,6 +173,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -280,8 +283,8 @@ and a connect event fired.

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Classes.html b/docs/Classes.html index efa0b82..93b9d3a 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -14,7 +14,6 @@ - @@ -174,6 +173,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -190,6 +192,39 @@
    +
    + +
    • @@ -338,9 +373,9 @@ Example:

    • @@ -348,84 +383,15 @@ Example:

      -

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

      +

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

      -

      Usage:

      -
      socket.rawEmitView.emit("myEvent", myObject)
-
      - - See more + See more

      Declaration

      Swift

      - 
      public final class SocketRawView : NSObject
      - -
      -
      -
      -
      -
      • -
    • -
      - - - - SocketRawAckView - -
      -
      -
      -
      -
      -
      -

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

      - -

      Usage:

      -
      ack.rawEmitView.with(myObject)
-
      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      public final class SocketRawAckView : NSObject
      - -
      -
      -
      -
      -
      • -
    -
    -
    -
      -
    • -
      - - - - SocketEngine - -
      -
      -
      -
      -
      -
      -

      The class that handles the engine.io protocol and transports. -See SocketEnginePollable and SocketEngineWebsocket for transport specific methods.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      open class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePollable, SocketEngineWebsocket, ConfigSettable
      + 
      open class SSLSecurity : NSObject
      @@ -489,9 +455,9 @@ or call one of the disconnectSocket methods on this class.

    • @@ -499,15 +465,51 @@ or call one of the disconnectSocket methods on this class.

      -

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

      +

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

      - See more +

      Usage:

      +
      socket.rawEmitView.emit("myEvent", myObject)
+
      + + See more

      Declaration

      Swift

      - 
      open class SSLSecurity : NSObject
      + 
      public final class SocketRawView : NSObject
      + +
      +
      +
      +
      +
      • +
    • +
      + + + + SocketRawAckView + +
      +
      +
      +
      +
      +
      +

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

      + +

      Usage:

      +
      ack.rawEmitView.with(myObject)
+
      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public final class SocketRawAckView : NSObject
      @@ -522,8 +524,8 @@ or call one of the disconnectSocket methods on this class.

      -

      © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

      -

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

      +

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

      +

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

      • diff --git a/docs/Classes/OnAckCallback.html b/docs/Classes/OnAckCallback.html index 65a96f7..6af5167 100644 --- a/docs/Classes/OnAckCallback.html +++ b/docs/Classes/OnAckCallback.html @@ -174,6 +174,9 @@
    • NormalCallback
      • +
    • + Post +
    @@ -231,8 +234,7 @@ Example:

    Declaration

    Swift

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

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Classes/SSLSecurity.html b/docs/Classes/SSLSecurity.html index c68d72f..32af9c3 100644 --- a/docs/Classes/SSLSecurity.html +++ b/docs/Classes/SSLSecurity.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -264,8 +267,7 @@ pinning validation

    Declaration

    Swift

    - 
    @objc
-public convenience init(usePublicKeys: Bool = true)
    + 
    public convenience init(usePublicKeys: Bool = true)
    @@ -295,9 +297,9 @@ validation

  • - + - init(certs:usePublicKeys:) + init(certs:usePublicKeys:)
    @@ -358,9 +360,9 @@ validation

  • - + - isValid(_:domain:) + isValid(_:domain:)
    @@ -425,8 +427,8 @@ validation

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Classes/SocketAckEmitter.html b/docs/Classes/SocketAckEmitter.html index ffb3616..84f33c3 100644 --- a/docs/Classes/SocketAckEmitter.html +++ b/docs/Classes/SocketAckEmitter.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -226,8 +229,7 @@

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    public var expected: Bool { get }
    + 
    public var expected: Bool
    @@ -286,9 +288,9 @@
  • - + - init(socket:ackNum:) + init(socket:ackNum:)
    @@ -355,9 +357,9 @@
  • - + - with(_:) + with(_:)
    @@ -367,7 +369,7 @@

    Call to ack receiving this event.

    -

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error +

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error will be emitted. The structure of the error data is [ackNum, items, theError]

    @@ -421,8 +423,7 @@ will be emitted. The structure of the error data is [ackNum, items, theErr

    Declaration

    Swift

    - 
    @objc
-public func with(_ items: [Any])
    + 
    public func with(_ items: [Any])
    @@ -456,8 +457,8 @@ will be emitted. The structure of the error data is [ackNum, items, theErr
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Classes/SocketAnyEvent.html b/docs/Classes/SocketAnyEvent.html index 79ea6e7..d8e285d 100644 --- a/docs/Classes/SocketAnyEvent.html +++ b/docs/Classes/SocketAnyEvent.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -225,8 +228,7 @@

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    override public var description: String { get }
    + 
    override public var description: String
    @@ -296,8 +297,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Classes/SocketEngine.html b/docs/Classes/SocketEngine.html index 68178f1..7108424 100644 --- a/docs/Classes/SocketEngine.html +++ b/docs/Classes/SocketEngine.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -226,7 +229,7 @@ See SocketEnginePollable<

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    public var extraHeaders: [String : String]?
    + 
    public var extraHeaders: [String: String]?
    @@ -290,9 +293,9 @@ See     SocketEnginePollable<
  • @@ -309,7 +312,7 @@ See SocketEnginePollable<

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    public private(set) var probing: Bool
    + 
    public private(set) var probing = false
    @@ -651,9 +654,9 @@ disconnect us.

  • - + - session + session
    @@ -695,7 +698,7 @@ disconnect us.

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

  • @@ -966,7 +968,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]?)
    @@ -1282,9 +1284,9 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

  • @@ -1311,9 +1313,9 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

  • @@ -1328,7 +1330,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

    Declaration

    Swift

    - 
    open func write(_ msg: String, withType type: SocketEnginePacketType, withData data: [Data])
    + 
    open func write(_ msg: String, withType type: SocketEnginePacketType, withData data: [Data], completion: (() -> ())? = nil)
    @@ -1372,6 +1374,18 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

    + + + + completion + + + +
    +

    Callback called on transport write completion.

    +
    + + @@ -1392,9 +1406,9 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

  • @@ -1424,8 +1438,8 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Classes/SocketIOClient.html b/docs/Classes/SocketIOClient.html index 304a64f..88ca8e9 100644 --- a/docs/Classes/SocketIOClient.html +++ b/docs/Classes/SocketIOClient.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -238,8 +241,7 @@

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    @objc
-open func connect(timeoutAfter: Double, withHandler handler: (() -> ())?)
    + 
    open func connect(timeoutAfter: Double, withHandler handler: (() -> ())?)
    @@ -594,9 +589,9 @@
  • @@ -641,9 +636,9 @@ then this is only called when the client connects to that namespace.

  • @@ -707,8 +702,7 @@ then this is only called when the client connects to that namespace.

    Declaration

    Swift

    - 
    @objc
-open func disconnect()
    + 
    open func disconnect()
    @@ -718,9 +712,9 @@ then this is only called when the client connects to that namespace.

  • @@ -728,9 +722,9 @@ then this is only called when the client connects to that namespace.

    -

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

    +

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

    -

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error +

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error will be emitted. The structure of the error data is [eventName, items, theError]

    @@ -738,7 +732,7 @@ will be emitted. The structure of the error data is [eventName, items, the

    Declaration

    Swift

    - 
    open func emit(_ event: String, _ items: SocketData...)
    + 
    open func emit(_ event: String, _ items: SocketData..., completion: (() -> ())? = nil)
    @@ -770,6 +764,18 @@ will be emitted. The structure of the error data is [eventName, items, the + + + + completion + + + +
    +

    Callback called on transport write completion.

    +
    + + @@ -796,8 +802,7 @@ will be emitted. The structure of the error data is [eventName, items, the

    Declaration

    Swift

    - 
    @objc
-open func emit(_ event: String, with items: [Any])
    + 
    open func emit(_ event: String, with items: [Any])
    @@ -838,9 +843,79 @@ will be emitted. The structure of the error data is [eventName, items, the
  • +
    +
    +
    +
    +
    +

    Same as emit, but meant for Objective-C

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    open func emit(_ event: String, with items: [Any], completion: (() -> ())? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + event + + +
    +

    The event to send.

    +
    +
    + + items + + +
    +

    The items to send with this event. Send an empty array to send no data.

    +
    +
    + + completion + + +
    +

    Callback called on transport write completion.

    +
    +
    +
    +
    +
    +
    • +
  • +
    @@ -853,7 +928,7 @@ will be emitted. The structure of the error data is [eventName, items, the

    NOTE: It is up to the server send an ack back, just calling this method does not mean the server will ack. Check that your server’s api will ack the event being sent.

    -

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error +

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error will be emitted. The structure of the error data is [eventName, items, theError]

    Example:

    @@ -938,8 +1013,7 @@ Check that your server’s api will ack the event being sent.

    Declaration

    Swift

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

  • @@ -1061,8 +1135,7 @@ Check that your server’s api will ack the event being sent.

    Declaration

    Swift

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

  • @@ -1178,8 +1251,7 @@ Check that your server’s api will ack the event being sent.

    Declaration

    Swift

    - 
    @objc
-open func handleEvent(_ event: String, data: [Any], isInternalMessage: Bool, withAck ack: Int = -1)
    + 
    open func handleEvent(_ event: String, data: [Any], isInternalMessage: Bool, withAck ack: Int = -1)
    @@ -1244,9 +1316,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1308,8 +1380,7 @@ socket.

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    @objc
-open func joinNamespace()
    + 
    open func joinNamespace()
    @@ -1347,9 +1417,9 @@ socket.

  • @@ -1414,8 +1484,7 @@ socket.

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    @discardableResult
-@objc
-open func on(_ event: String, callback: @escaping NormalCallback) -> UUID
    + 
    open func on(_ event: String, callback: @escaping NormalCallback) -> UUID
    @@ -1557,9 +1623,9 @@ socket.

  • @@ -1580,8 +1646,7 @@ socket.

    Declaration

    Swift

    - 
    @discardableResult
-open func on(clientEvent event: SocketClientEvent, callback: @escaping NormalCallback) -> UUID
    + 
    open func on(clientEvent event: SocketClientEvent, callback: @escaping NormalCallback) -> UUID
    @@ -1626,9 +1691,9 @@ socket.

  • @@ -1643,8 +1708,7 @@ socket.

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    @objc
-open func setReconnecting(reason: String)
    + 
    open func setReconnecting(reason: String)
    @@ -1883,8 +1942,8 @@ Called when the manager detects a broken connection, or when a manual reconnect
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Classes/SocketManager.html b/docs/Classes/SocketManager.html index 3513a73..52acd4a 100644 --- a/docs/Classes/SocketManager.html +++ b/docs/Classes/SocketManager.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -243,7 +246,7 @@ or call one of the disconnectSocket methods on this class.

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    public var reconnects: Bool
    + 
    public var reconnects = true
    @@ -467,7 +470,7 @@ called on.

    Declaration

    Swift

    - 
    public var reconnectWait: Int
    + 
    public var reconnectWait = 10
    @@ -494,7 +497,7 @@ called on.

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    public var waitingPackets: [SocketPacket]
    + 
    public var waitingPackets = [SocketPacket]()
    @@ -547,9 +550,9 @@ So this should ideally be an array of one packet waiting for data.

  • @@ -623,8 +626,7 @@ If using Swift it’s recommended to use init(socketURL: NSURL, option

    Declaration

    Swift

    - 
    @objc
-public convenience init(socketURL: URL, config: [String : Any]?)
    + 
    public convenience init(socketURL: URL, config: [String: Any]?)
    @@ -922,9 +924,9 @@ releasing.

  • @@ -968,9 +970,9 @@ releasing.

  • @@ -1038,7 +1040,7 @@ releasing.

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

    -

    Same as emitAll(_:_:), but meant for Objective-C.

    +

    Same as emitAll(_:_:), but meant for Objective-C.

    @@ -1275,6 +1277,52 @@ releasing.

    • +
  • +
    + + + + engineDidWebsocketUpgrade(headers:) + +
    +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    open func engineDidWebsocketUpgrade(headers: [String: String])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + headers + + +
    +

    The http headers.

    +
    +
    +
    +
    +
    +
  • @@ -1382,8 +1430,8 @@ releasing.

    Tries to reconnect to the server.

    -

    This will cause a SocketClientEvent.reconnect event to be emitted, as well as -SocketClientEvent.reconnectAttempt events.

    +

    This will cause a SocketClientEvent.reconnect event to be emitted, as well as +SocketClientEvent.reconnectAttempt events.

    @@ -1420,8 +1468,7 @@ method.

    Declaration

    Swift

    - 
    @discardableResult
-open func removeSocket(_ socket: SocketIOClient) -> SocketIOClient?
    + 
    open func removeSocket(_ socket: SocketIOClient) -> SocketIOClient?
    @@ -1454,9 +1501,9 @@ method.

  • @@ -1544,8 +1591,8 @@ Or call -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Classes/SocketRawAckView.html b/docs/Classes/SocketRawAckView.html index ee00b0c..4f9ca8a 100644 --- a/docs/Classes/SocketRawAckView.html +++ b/docs/Classes/SocketRawAckView.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -205,9 +208,9 @@
  • - + - with(_:) + with(_:)
    @@ -217,7 +220,7 @@

    Call to ack receiving this event.

    -

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error +

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error will be emitted. The structure of the error data is [ackNum, items, theError]

    @@ -271,8 +274,7 @@ will be emitted. The structure of the error data is [ackNum, items, theErr

    Declaration

    Swift

    - 
    @objc
-public func with(_ items: [Any])
    + 
    public func with(_ items: [Any])
    @@ -306,8 +308,8 @@ will be emitted. The structure of the error data is [ackNum, items, theErr
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Classes/SocketRawView.html b/docs/Classes/SocketRawView.html index eb2580c..54c22a7 100644 --- a/docs/Classes/SocketRawView.html +++ b/docs/Classes/SocketRawView.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -205,9 +208,9 @@
  • @@ -217,7 +220,7 @@

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

    -

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error +

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error will be emitted. The structure of the error data is [eventName, items, theError]

    @@ -283,8 +286,7 @@ will be emitted. The structure of the error data is [eventName, items, the

    Declaration

    Swift

    - 
    @objc
-public func emit(_ event: String, with items: [Any])
    + 
    public func emit(_ event: String, with items: [Any])
    @@ -325,9 +327,9 @@ will be emitted. The structure of the error data is [eventName, items, the
  • @@ -340,7 +342,7 @@ will be emitted. The structure of the error data is [eventName, items, the

    NOTE: It is up to the server send an ack back, just calling this method does not mean the server will ack. Check that your server’s api will ack the event being sent.

    -

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error +

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error will be emitted. The structure of the error data is [eventName, items, theError]

    Example:

    @@ -425,8 +427,7 @@ Check that your server’s api will ack the event being sent.

    Declaration

    Swift

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

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Enums.html b/docs/Enums.html index 1cca4a4..89a0a8b 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -14,7 +14,6 @@ - @@ -174,6 +173,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -190,6 +192,38 @@
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      Represents the type of engine.io packet types.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @objc public enum SocketEnginePacketType : Int
      + +
      +
      +
      +
      +
      • +
    +
    • @@ -222,38 +256,6 @@
    -
    -
      -
    • -
      - - - - SocketIOClientOption - -
      -
      -
      -
      -
      -
      -

      The options for a client.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      public enum SocketIOClientOption : ClientOption
      - -
      -
      -
      -
      -
      • -
    -
    • @@ -286,6 +288,38 @@
    +
    +
      +
    • +
      + + + + SocketIOClientOption + +
      +
      +
      +
      +
      +
      +

      The options for a client.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public enum SocketIOClientOption : ClientOption
      + +
      +
      +
      +
      +
      • +
    +
    • @@ -309,41 +343,7 @@

      Declaration

      Swift

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

      Represents the type of engine.io packet types.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      @objc
-public enum SocketEnginePacketType : Int
      + 
      public enum SocketIOStatus : Int, CustomStringConvertible
      @@ -390,8 +390,8 @@
      -

      © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

      -

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

      +

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

      +

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

    diff --git a/docs/Enums/SocketAckStatus.html b/docs/Enums/SocketAckStatus.html index 60c5f19..440ba74 100644 --- a/docs/Enums/SocketAckStatus.html +++ b/docs/Enums/SocketAckStatus.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -197,20 +200,13 @@
    -
    - - - -

    Cases

    -     -
    diff --git a/docs/Enums/SocketClientEvent.html b/docs/Enums/SocketClientEvent.html index d6d89d7..01db543 100644 --- a/docs/Enums/SocketClientEvent.html +++ b/docs/Enums/SocketClientEvent.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -197,20 +200,13 @@
    -
    - - - -

    Cases

    -     -
    • - + - connect + connect
      @@ -238,12 +234,16 @@ data item: the namespace that was connected to.

    + + +
    +
    • @@ -271,12 +271,16 @@ data item: the namespace that was connected to.

    + + +
    +
    • - + - error + error
      @@ -304,12 +308,16 @@ data item: the namespace that was connected to.

      • +
    +
    +
    +
    • - + - ping + ping
      @@ -337,12 +345,16 @@ data item: the namespace that was connected to.

      • +
    +
    +
    +
    • - + - pong + pong
      @@ -370,12 +382,16 @@ data item: the namespace that was connected to.

      • +
    +
    +
    +
    • @@ -403,12 +419,16 @@ data item: the namespace that was connected to.

      • +
    +
    +
    + +
    +
    +
    +
    +
      +
    • +
      + + + + websocketUpgrade + +
      +
      +
      +
      +
      +
      +

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

      + +

      Usage:

      +
      socket.on(clientEvent: .websocketUpgrade) {data, ack in
+    let headers = (data as [Any])[0]
+    // Some header logic
+}
+
      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      case websocketUpgrade
      + +
      +
      +
      +
      +
      • +
    +
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Enums/SocketEnginePacketType.html b/docs/Enums/SocketEnginePacketType.html index 5857303..a239d4c 100644 --- a/docs/Enums/SocketEnginePacketType.html +++ b/docs/Enums/SocketEnginePacketType.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -185,8 +188,7 @@

    SocketEnginePacketType

    - 
    @objc
-public enum SocketEnginePacketType : Int
    + 
    @objc public enum SocketEnginePacketType : Int
    @@ -226,6 +228,10 @@ + + +
    +
    • @@ -253,6 +259,10 @@
      • +
    +
    +
    +
    • @@ -280,6 +290,10 @@
      • +
    +
    +
    +
    • @@ -307,6 +321,10 @@
      • +
    +
    +
    +
    • @@ -334,6 +352,10 @@
      • +
    +
    +
    +
    • @@ -361,6 +383,10 @@
      • +
    +
    +
    +
    diff --git a/docs/Enums/SocketIOClientOption.html b/docs/Enums/SocketIOClientOption.html index ad19368..ac3a344 100644 --- a/docs/Enums/SocketIOClientOption.html +++ b/docs/Enums/SocketIOClientOption.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -201,9 +204,9 @@
  • - + - compress + compress
    @@ -225,12 +228,16 @@
    • + + +
    +
    • @@ -245,19 +252,23 @@

      Declaration

      Swift

      - 
      case connectParams([String : Any])
      + 
      case connectParams([String: Any])
    + + +
    + +
    +
    +
    • @@ -299,19 +314,23 @@

      Declaration

      Swift

      - 
      case extraHeaders([String : String])
      + 
      case extraHeaders([String: String])
    + + +
    +
    • - - - forceNew + + + forceNew(_:)
      @@ -334,12 +353,16 @@ or when you want to be sure no state from previous engines is being carried over
      • +
    +
    +
    +
    • @@ -361,12 +384,16 @@ or when you want to be sure no state from previous engines is being carried over
      • +
    +
    +
    + +
    +
    + +
    +
    +
    • - - - log + + + log(_:)
      @@ -445,12 +480,16 @@ called on.

      • +
    +
    +
    + +
    +
    +
    • - - - path + + + path(_:)
      @@ -499,12 +542,16 @@ called on.

      • +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    • - - - secure + + + secure(_:)
      @@ -608,12 +667,16 @@ over when reconnects happen.

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

      Declaration

      Swift

      - 
      public var description: String { get }
      + 
      public var description: String
      @@ -741,9 +812,9 @@ over when reconnects happen.

    • - + - ==(_:_:) + ==(_:_:)
      @@ -758,7 +829,7 @@ over when reconnects happen.

      Declaration

      Swift

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

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Enums/SocketIOStatus.html b/docs/Enums/SocketIOStatus.html index 4e539f3..bb4f941 100644 --- a/docs/Enums/SocketIOStatus.html +++ b/docs/Enums/SocketIOStatus.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -185,8 +188,7 @@

    SocketIOStatus

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

    Cases

    -     -
    • @@ -233,6 +228,10 @@
    + + +
    +
    • @@ -260,6 +259,10 @@
      • +
    +
    +
    +
    • @@ -287,6 +290,10 @@
      • +
    +
    +
    +
    • @@ -344,7 +351,7 @@

      Declaration

      Swift

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

      Declaration

      Swift

      - 
      public var description: String { get }
      + 
      public var description: String
    @@ -389,8 +396,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Enums/SocketParsableError.html b/docs/Enums/SocketParsableError.html index df6f599..160b660 100644 --- a/docs/Enums/SocketParsableError.html +++ b/docs/Enums/SocketParsableError.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -197,20 +200,13 @@
    -
    - - - -

    Cases

    -     -
    + + +
    + +
    +
    +
    diff --git a/docs/Guides.html b/docs/Guides.html index f70f3f7..68e24d5 100644 --- a/docs/Guides.html +++ b/docs/Guides.html @@ -14,7 +14,6 @@ - @@ -174,6 +173,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -196,8 +198,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Protocols.html b/docs/Protocols.html index 32ee8cd..a0f19aa 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -14,7 +14,6 @@ - @@ -174,6 +173,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -195,9 +197,9 @@
  • @@ -205,47 +207,15 @@
    -

    Declares that a type can set configs from a SocketIOClientConfiguration.

    +

    Specifies a SocketEngine.

    - See more + See more

    Declaration

    Swift

    - 
    public protocol ConfigSettable
    - -
    -
    -
    -
    -
    • - - -
    -
      -
    • -
      - - - - SocketIOClientSpec - -
      -
      -
      -
      -
      -
      -

      Defines the interface for a SocketIOClient.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      public protocol SocketIOClientSpec : AnyObject
      + 
      @objc public protocol SocketEngineSpec
      @@ -277,8 +247,7 @@

      Declaration

      Swift

      - 
      @objc
-public protocol SocketEngineClient
      + 
      @objc public protocol SocketEngineClient
      @@ -319,39 +288,6 @@
    -
    -
      -
    • -
      - - - - SocketEngineSpec - -
      -
      -
      -
      -
      -
      -

      Specifies a SocketEngine.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      @objc
-public protocol SocketEngineSpec
      - -
      -
      -
      -
      -
      • -
    -
    • @@ -389,9 +325,9 @@
    • @@ -399,32 +335,124 @@
      -

      A manager for a socket.io connection.

      +

      Defines the interface for a SocketIOClient.

      -

      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

      - 
      @objc
-public protocol SocketManagerSpec : AnyObject, SocketEngineClient
      + 
      public protocol SocketIOClientSpec : 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
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
      +
    • +
      + + + + SocketLogger + +
      +
      +
      +
      +
      +
      +

      Represents a class will log client events.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public protocol SocketLogger : AnyObject
      @@ -498,9 +526,9 @@ or call one of the disconnectSocket methods on this class.

    • @@ -508,60 +536,31 @@ or call one of the disconnectSocket methods on this class.

      -

      Represents a class will log client events.

      +

      A manager for a socket.io connection.

      - See more -
      -
      -

      Declaration

      -
      -

      Swift

      - 
      public protocol SocketLogger : AnyObject
      +

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

      -
      -
      -
      -
      -
      • -
    -
    -
    -
      -
    • -
      - - - - SocketData - -
      -
      -
      -
      -
      -
      -

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

      +

      Example with SocketManager:

      +
      let manager = SocketManager(socketURL: URL(string:"http://localhost:8080/")!)
+let defaultNamespaceSocket = manager.defaultSocket
+let swiftSocket = manager.socket(forNamespace: "/swift")
 
-
      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))
+// 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
      + 
      public protocol SocketManagerSpec : AnyObject, SocketEngineClient
      @@ -576,8 +575,8 @@ or call one of the disconnectSocket methods on this class.

      -

      © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

      -

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

      +

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

      +

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

    diff --git a/docs/Protocols/ConfigSettable.html b/docs/Protocols/ConfigSettable.html index f67a884..311cf77 100644 --- a/docs/Protocols/ConfigSettable.html +++ b/docs/Protocols/ConfigSettable.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -208,9 +211,9 @@
  • @@ -259,8 +262,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Protocols/SocketData.html b/docs/Protocols/SocketData.html index ec83516..32b3ad5 100644 --- a/docs/Protocols/SocketData.html +++ b/docs/Protocols/SocketData.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -261,8 +264,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Protocols/SocketDataBufferable.html b/docs/Protocols/SocketDataBufferable.html index f50968f..af0502e 100644 --- a/docs/Protocols/SocketDataBufferable.html +++ b/docs/Protocols/SocketDataBufferable.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -230,7 +233,7 @@ So this should ideally be an array of one packet waiting for data.

    Declaration

    Swift

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

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Protocols/SocketEngineClient.html b/docs/Protocols/SocketEngineClient.html index 9a1b80e..02fa29f 100644 --- a/docs/Protocols/SocketEngineClient.html +++ b/docs/Protocols/SocketEngineClient.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -185,8 +188,7 @@

    SocketEngineClient

    - 
    @objc
-public protocol SocketEngineClient
    + 
    @objc public protocol SocketEngineClient
    @@ -490,6 +492,52 @@ +
  • + +
    +
    +
    +
    +
    +

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

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    func engineDidWebsocketUpgrade(headers: [String: String])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + headers + + +
    +

    The http headers.

    +
    +
    +
    +
    +
    +
    • @@ -498,8 +546,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Protocols/SocketEnginePollable.html b/docs/Protocols/SocketEnginePollable.html index ba0c9b8..c030156 100644 --- a/docs/Protocols/SocketEnginePollable.html +++ b/docs/Protocols/SocketEnginePollable.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -225,7 +228,7 @@

    Declaration

    Swift

    - 
    var invalidated: Bool { get }
    + 
    var invalidated: Bool
    @@ -235,9 +238,9 @@
  • - + - postWait + postWait
    @@ -254,7 +257,7 @@

    Declaration

    Swift

    - 
    var postWait: [String] { get set }
    + 
    var postWait: [Post]
    @@ -264,9 +267,9 @@
  • - + - session + session
    @@ -281,7 +284,7 @@

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    var waitingForPost: Bool { get set }
    + 
    var waitingForPost: Bool
    @@ -401,9 +404,9 @@ disconnect us.

  • - - - sendPollMessage(_:withType:withData:) + + + sendPollMessage(_:withType:withData:completion:) Default implementation @@ -430,7 +433,7 @@ disconnect us.

    Declaration

    Swift

    - 
    func sendPollMessage(_ message: String, withType type: SocketEnginePacketType, withData datas: [Data])
    + 
    func sendPollMessage(_ message: String, withType type: SocketEnginePacketType, withData datas: [Data], completion: (() -> ())?)
    @@ -523,8 +526,8 @@ disconnect us.

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Protocols/SocketEngineSpec.html b/docs/Protocols/SocketEngineSpec.html index a28a37b..fd8ace0 100644 --- a/docs/Protocols/SocketEngineSpec.html +++ b/docs/Protocols/SocketEngineSpec.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -185,8 +188,7 @@

    SocketEngineSpec

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

  • @@ -1084,7 +1085,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

    Declaration

    Swift

    - 
    func write(_ msg: String, withType type: SocketEnginePacketType, withData data: [Data])
    + 
    func write(_ msg: String, withType type: SocketEnginePacketType, withData data: [Data], completion: (() -> ())?)
    @@ -1128,6 +1129,18 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

    + + + + completion + + + +
    +

    Callback called on transport write completion.

    +
    + + @@ -1142,8 +1155,8 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Protocols/SocketEngineWebsocket.html b/docs/Protocols/SocketEngineWebsocket.html index a13d4da..c35b49e 100644 --- a/docs/Protocols/SocketEngineWebsocket.html +++ b/docs/Protocols/SocketEngineWebsocket.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -208,9 +211,9 @@
  • - - - sendWebSocketMessage(_:withType:withData:) + + + sendWebSocketMessage(_:withType:withData:completion:) Default implementation @@ -237,7 +240,7 @@

    Declaration

    Swift

    - 
    func sendWebSocketMessage(_ str: String, withType type: SocketEnginePacketType, withData datas: [Data])
    + 
    func sendWebSocketMessage(_ str: String,
    @@ -281,6 +284,18 @@ + + + + completion + + + +
    +

    Callback called on transport write completion.

    +
    + + @@ -295,8 +310,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Protocols/SocketIOClientSpec.html b/docs/Protocols/SocketIOClientSpec.html index 4d119bb..2fc3e3d 100644 --- a/docs/Protocols/SocketIOClientSpec.html +++ b/docs/Protocols/SocketIOClientSpec.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -225,7 +228,7 @@

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    var status: SocketIOStatus { get }
    + 
    var status: SocketIOStatus
    @@ -399,7 +402,7 @@
    -

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

    +

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

    Only call after adding your event listeners, unless you know what you’re doing.

    @@ -418,9 +421,9 @@
  • @@ -479,9 +482,9 @@
  • @@ -526,9 +529,9 @@ then this is only called when the client connects to that namespace.

  • @@ -572,9 +575,9 @@ then this is only called when the client connects to that namespace.

  • - + - didError(reason:) + didError(reason:) Default implementation @@ -653,9 +656,9 @@ then this is only called when the client connects to that namespace.

  • @@ -663,9 +666,9 @@ then this is only called when the client connects to that namespace.

    -

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

    +

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

    -

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error +

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error will be emitted. The structure of the error data is [eventName, items, theError]

    @@ -673,7 +676,7 @@ will be emitted. The structure of the error data is [eventName, items, the

    Declaration

    Swift

    - 
    func emit(_ event: String, _ items: SocketData...)
    + 
    func emit(_ event: String, _ items: SocketData..., completion: (() -> ())?)
    @@ -705,6 +708,18 @@ will be emitted. The structure of the error data is [eventName, items, the
    • + + + + completion + + + +
    +

    Callback called on transport write completion.

    +
    + + @@ -714,9 +729,9 @@ will be emitted. The structure of the error data is [eventName, items, the
  • @@ -772,9 +787,9 @@ will be emitted. The structure of the error data is [eventName, items, the
  • @@ -787,7 +802,7 @@ will be emitted. The structure of the error data is [eventName, items, the

    NOTE: It is up to the server send an ack back, just calling this method does not mean the server will ack. Check that your server’s api will ack the event being sent.

    -

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error +

    If an error occurs trying to transform items into their socket representation, a SocketClientEvent.error will be emitted. The structure of the error data is [eventName, items, theError]

    Example:

    @@ -846,9 +861,9 @@ will be emitted. The structure of the error data is [eventName, items, the
  • @@ -904,9 +919,9 @@ will be emitted. The structure of the error data is [eventName, items, the
  • @@ -962,9 +977,9 @@ will be emitted. The structure of the error data is [eventName, items, the
  • @@ -1044,9 +1059,9 @@ will be emitted. The structure of the error data is [eventName, items, the
  • @@ -1145,9 +1160,9 @@ socket.

  • @@ -1157,7 +1172,7 @@ socket.

    Removes handler(s) for a client event.

    -

    If you wish to remove a client event handler, call the off(id:) with the UUID received from its on call.

    +

    If you wish to remove a client event handler, call the off(id:) with the UUID received from its on call.

    @@ -1193,9 +1208,9 @@ socket.

  • - + - off(_:) + off(_:)
    @@ -1205,7 +1220,7 @@ socket.

    Removes handler(s) based on an event name.

    -

    If you wish to remove a specific event, call the off(id:) with the UUID received from its on call.

    +

    If you wish to remove a specific event, call the off(id:) with the UUID received from its on call.

    @@ -1241,9 +1256,9 @@ socket.

  • - + - off(id:) + off(id:)
    @@ -1253,7 +1268,7 @@ socket.

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

    -

    If you want to remove all events for an event, call the off off(_:) method with the event name.

    +

    If you want to remove all events for an event, call the off off(_:) method with the event name.

    @@ -1289,9 +1304,9 @@ socket.

  • @@ -1351,9 +1366,9 @@ socket.

  • @@ -1419,9 +1434,9 @@ socket.

  • @@ -1481,9 +1496,9 @@ socket.

  • @@ -1543,9 +1558,9 @@ socket.

  • @@ -1618,9 +1633,9 @@ socket.

  • @@ -1653,8 +1668,8 @@ Called when the manager detects a broken connection, or when a manual reconnect
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Protocols/SocketLogger.html b/docs/Protocols/SocketLogger.html index 852c378..9deff36 100644 --- a/docs/Protocols/SocketLogger.html +++ b/docs/Protocols/SocketLogger.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -225,7 +228,7 @@

    Declaration

    Swift

    - 
    var log: Bool { get set }
    + 
    var log: Bool
    @@ -246,9 +249,9 @@
  • - + - log(_:type:) + log(_:type:) Default implementation @@ -324,9 +327,9 @@
  • - + - error(_:type:) + error(_:type:) Default implementation @@ -407,8 +410,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Protocols/SocketManagerSpec.html b/docs/Protocols/SocketManagerSpec.html index 7c1d18e..7dffc50 100644 --- a/docs/Protocols/SocketManagerSpec.html +++ b/docs/Protocols/SocketManagerSpec.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -185,8 +188,7 @@

    SocketManagerSpec

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    var reconnects: Bool { get set }
    + 
    var reconnects: Bool
    @@ -405,7 +407,7 @@ called on.

    Declaration

    Swift

    - 
    var reconnectWait: Int { get set }
    + 
    var reconnectWait: Int
    @@ -432,7 +434,7 @@ called on.

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Protocols/SocketParsable.html b/docs/Protocols/SocketParsable.html index 615963b..951d64f 100644 --- a/docs/Protocols/SocketParsable.html +++ b/docs/Protocols/SocketParsable.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -208,9 +211,9 @@
  • - + - parseBinaryData(_:) + parseBinaryData(_:) Default implementation @@ -270,9 +273,9 @@ into the correct placeholder.

  • - + - parseSocketMessage(_:) + parseSocketMessage(_:) Default implementation @@ -333,8 +336,8 @@ into the correct placeholder.

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Structs.html b/docs/Structs.html index 46d40bb..dd1afc2 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -14,7 +14,6 @@ - @@ -174,6 +173,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -292,8 +294,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Structs/SocketEventHandler.html b/docs/Structs/SocketEventHandler.html index a2091d5..a0de2c1 100644 --- a/docs/Structs/SocketEventHandler.html +++ b/docs/Structs/SocketEventHandler.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -262,9 +265,9 @@
  • - + - callback + callback
    @@ -300,9 +303,9 @@
  • @@ -375,8 +378,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Structs/SocketIOClientConfiguration.html b/docs/Structs/SocketIOClientConfiguration.html index 075dac0..213cfdb 100644 --- a/docs/Structs/SocketIOClientConfiguration.html +++ b/docs/Structs/SocketIOClientConfiguration.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -306,7 +309,7 @@

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    - 
    public var first: Element? { get }
    + 
    public var first: Element?
    @@ -462,9 +465,9 @@
  • @@ -478,7 +481,7 @@

    Declaration

    Swift

    - 
    public subscript(position: Index) -> Element { get set }
    + 
    public subscript(position: Index) -> Element
    @@ -488,9 +491,9 @@
  • @@ -504,7 +507,7 @@

    Declaration

    Swift

    - 
    public subscript(bounds: Range<Index>) -> SubSequence { get set }
    + 
    public subscript(bounds: Range<Index>) -> SubSequence
    @@ -525,9 +528,9 @@
  • @@ -613,9 +616,9 @@
  • @@ -643,9 +646,9 @@
  • @@ -706,8 +709,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Structs/SocketPacket.html b/docs/Structs/SocketPacket.html index 9f6c29b..9eb78c2 100644 --- a/docs/Structs/SocketPacket.html +++ b/docs/Structs/SocketPacket.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -363,7 +366,7 @@ event type packets.

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Structs/SocketPacket/PacketType.html b/docs/Structs/SocketPacket/PacketType.html index e6ad15a..b63f76c 100644 --- a/docs/Structs/SocketPacket/PacketType.html +++ b/docs/Structs/SocketPacket/PacketType.html @@ -174,6 +174,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -185,7 +188,7 @@

    PacketType

    - 
    public enum PacketType : Int
    + 
    public enum PacketType: Int
    @@ -197,20 +200,13 @@
    -
    - - - -

    Cases

    -     -
    + + +
    + +
    +
    + +
    +
    +
    • - + - ack + ack
      @@ -313,12 +321,16 @@
      • +
    +
    +
    + +
    +
    + +
    +
    +
    • @@ -425,7 +445,7 @@

      Declaration

      Swift

      - 
      public var isBinary: Bool { get }
      + 
      public var isBinary: Bool
      @@ -440,8 +460,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/Typealiases.html b/docs/Typealiases.html index e90e4f8..cf0b90d 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -14,7 +14,6 @@ - @@ -174,6 +173,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -246,6 +248,33 @@ +
  • +
    + + + + Post + +
    +
    +
    +
    +
    +
    +

    A typealias for a queued POST

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public typealias Post = (msg: String, completion: (() -> ())?)
    + +
    +
    +
    +
    +
    • @@ -254,8 +283,8 @@
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/faq.html b/docs/faq.html index be5f436..c4ed1f9 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -173,6 +173,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -229,8 +232,8 @@ will be released, along with the socket, and its memory reclaimed.

    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/index.html b/docs/index.html index 93a50b1..5686b01 100644 --- a/docs/index.html +++ b/docs/index.html @@ -173,6 +173,9 @@
  • NormalCallback
    • +
  • + Post +
    • @@ -331,8 +334,8 @@ SocketIOClient* socket = manager.defaultSocket;
    -

    © 2018 Erik. All rights reserved. (Last updated: 2018-07-29)

    -

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

    +

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

    +

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

    diff --git a/docs/search.json b/docs/search.json index 5d15523..00b2a8c 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.

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

    Connect: 0

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

    Disconnect: 1

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

    Event: 2

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

    Ack: 3

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

    Error: 4

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

    Binary Event: 5

    ","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO9binaryAckA2EmF":{"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:s10CollectionP7ElementQz5IndexQzcip":{"name":"subscript(_:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:s10CollectionP11SubSequenceQzs5RangeVy5IndexQzGcip":{"name":"subscript(_:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationVAcA0aC6OptionO12arrayLiterald_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:8SocketIO0A21IOClientConfigurationV5indexS2i5after_tF":{"name":"index(after:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV6insertyAA0aC6OptionO_Sb9replacingtF":{"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:8SocketIO0A12EventHandlerV8callbackySayypG_AA0A10AckEmitterCtcvp":{"name":"callback","abstract":"

    The actual handler function.

    ","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV15executeCallbackySayypG4with_Si0G3AckAA0A8IOClientC0gA0tF":{"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:8SocketIO0A6LoggerP3logySSyXK_SS4typetF":{"name":"log(_:type:)","abstract":"

    Normal log messages

    ","parent_name":"SocketLogger"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP5errorySSyXK_SS4typetF":{"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:8SocketIO0A8ParsableP15parseBinaryDataAA0A6PacketVSg10Foundation0F0VF":{"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:8SocketIO0A8ParsableP05parseA7MessageAA0A6PacketVSgSSF":{"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 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/SocketEngineWebsocket.html#/s:8SocketIO0A15EngineWebsocketP07sendWebA7MessageySS_AA0aC10PacketTypeO04withI0Say10Foundation4DataVG0jL0tF":{"name":"sendWebSocketMessage(_:withType:withData:)","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:":{"name":"write(_:withType:withData:)","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:8SocketIO0A14EnginePollableP8postWaitSaySSGvp":{"name":"postWait","abstract":"

    A queue of engine.io messages waiting for POSTing

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP7sessionSo10URLSessionCSgvp":{"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:8SocketIO0A14EnginePollableP15sendPollMessageySS_AA0aC10PacketTypeO04withI0Say10Foundation4DataVG0jL0tF":{"name":"sendPollMessage(_:withType:withData:)","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/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:8SocketIO0A12IOClientSpecP7connectySd12timeoutAfter_yycSg11withHandlertF":{"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:8SocketIO0A12IOClientSpecP10didConnectySS11toNamespace_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:8SocketIO0A12IOClientSpecP13didDisconnectySS6reason_tF":{"name":"didDisconnect(reason:)","abstract":"

    Called when the client has disconnected from socket.io.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP8didErrorySS6reason_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:8SocketIO0A12IOClientSpecP4emitySS_AA0A4Data_pdtF":{"name":"emit(_:_:)","abstract":"

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

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7emitAckySi_SayypG4withtF":{"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:8SocketIO0A12IOClientSpecP11emitWithAckAA02OnG8CallbackCSS_AA0A4Data_pdtF":{"name":"emitWithAck(_:_:)","abstract":"

    Sends a message to the server, requesting an ack.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP9handleAckySi_SayypG4datatF":{"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:8SocketIO0A12IOClientSpecP17handleClientEventyAA0afG0O_SayypG4datatF":{"name":"handleClientEvent(_:data:)","abstract":"

    Called on socket.io specific events.

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

    Called when we get an event from socket.io.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP12handlePacketyAA0aF0VF":{"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:8SocketIO0A12IOClientSpecP3offyAA0A11ClientEventO06clientG0_tF":{"name":"off(clientEvent:)","abstract":"

    Removes handler(s) for a client event.

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

    Removes handler(s) based on an event name.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3offy10Foundation4UUIDV2id_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:8SocketIO0A12IOClientSpecP2on10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtc8callbacktF":{"name":"on(_:callback:)","abstract":"

    Adds a handler for an event.

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

    Adds a handler for a client event.

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

    Adds a single-use handler for a client event.

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

    Adds a single-use handler for an event.

    ","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP5onAnyyyAA0aF5EventCcF":{"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:8SocketIO0A12IOClientSpecP15setReconnectingySS6reason_tF":{"name":"setReconnecting(reason:)","abstract":"

    Puts the socket back into the connecting state.","parent_name":"SocketIOClientSpec"},"Protocols/ConfigSettable.html#/s:8SocketIO14ConfigSettableP10setConfigsyAA0A21IOClientConfigurationVF":{"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:8SocketIO0A13ParsableErrorO16invalidDataArrayA2CmF":{"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:8SocketIO0A13ParsableErrorO13invalidPacketA2CmF":{"name":"invalidPacket","abstract":"

    Thrown when an malformed packet is received.

    ","parent_name":"SocketParsableError"},"Enums/SocketParsableError.html#/s:8SocketIO0A13ParsableErrorO17invalidPacketTypeA2CmF":{"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:8SocketIO0A11ClientEventO7connectA2CmF":{"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:8SocketIO0A11ClientEventO10disconnectA2CmF":{"name":"disconnect","abstract":"

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

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

    Emitted when an error occurs.

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

    Emitted whenever the engine sends a ping.

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

    Emitted whenever the engine gets a pong.

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

    Emitted when the client begins the reconnection process.

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

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

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

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

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

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

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

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

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

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

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

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

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8forceNewACSbcACmF":{"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:8SocketIO0A14IOClientOptionO12forcePollingACSbcACmF":{"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:8SocketIO0A14IOClientOptionO15forceWebsocketsACSbcACmF":{"name":"forceWebsockets","abstract":"

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

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO11handleQueueACSo08DispatchF0CcACmF":{"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:8SocketIO0A14IOClientOptionO3logACSbcACmF":{"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:8SocketIO0A14IOClientOptionO6loggerAcA0A6Logger_pcACmF":{"name":"logger","abstract":"

    Used to pass in a custom logger.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO4pathACSScACmF":{"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:8SocketIO0A14IOClientOptionO10reconnectsACSbcACmF":{"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:8SocketIO0A14IOClientOptionO17reconnectAttemptsACSicACmF":{"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:8SocketIO0A14IOClientOptionO13reconnectWaitACSicACmF":{"name":"reconnectWait","abstract":"

    The number of seconds to wait before reconnect attempts.

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

    Set true if your server is using secure transports.

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

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

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

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

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO15sessionDelegateACSo010URLSessionF0_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:8SocketIO0A14IOClientOptionO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"

    Compares whether two options are the same.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketAckStatus.html#/s:8SocketIO0A9AckStatusO02noC0A2CmF":{"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:8SocketIO11SSLSecurityCACSay10Starscream7SSLCertCG5certs_Sb13usePublicKeystcfc":{"name":"init(certs:usePublicKeys:)","abstract":"

    Designated init

    ","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:8SocketIO11SSLSecurityC7isValidSbSo8SecTrustC_SSSg6domaintF":{"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 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:8SocketIO0A7ManagerCAC10Foundation3URLV06socketE0_AA0A21IOClientConfigurationV6configtcfc":{"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:8SocketIO0A7ManagerC7emitAllyAA0A11ClientEventO06clientG0_SayypG4datatF":{"name":"emitAll(clientEvent:data:)","abstract":"

    Sends a client event to all sockets in nsps

    ","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC7emitAllySS_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)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:8SocketIO0A7ManagerC10setConfigsyAA0A21IOClientConfigurationVF":{"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:8SocketIO0A6EngineC8postWaitSaySSGvp":{"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:8SocketIO0A6EngineC7sessionSo10URLSessionCSgvp":{"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:8SocketIO0A6EngineCAcA0aC6Client_p6client_10Foundation3URLV3urlAA0A21IOClientConfigurationV6configtcfc":{"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:8SocketIO0A6EngineC10setConfigsyAA0A21IOClientConfigurationVF":{"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:":{"name":"write(_:withType:withData:)","abstract":"

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

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

    Delegate called when the session becomes invalid.

    ","parent_name":"SocketEngine"},"Classes/SocketRawAckView.html#/s:8SocketIO0A10RawAckViewC4withyAA0A4Data_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:8SocketIO0A7RawViewC4emitySS_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:8SocketIO0A7RawViewC11emitWithAckAA02OnG8CallbackCSS_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:8SocketIO0A8IOClientC10didConnectySS11toNamespace_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:8SocketIO0A8IOClientC13didDisconnectySS6reason_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:8SocketIO0A8IOClientC4emitySS_AA0A4Data_pdtF":{"name":"emit(_:_:)","abstract":"

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

    ","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#/s:8SocketIO0A8IOClientC11emitWithAckAA02OnF8CallbackCSS_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:8SocketIO0A8IOClientC7emitAckySi_SayypG4withtF":{"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:8SocketIO0A8IOClientC17handleClientEventyAA0aeF0O_SayypG4datatF":{"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:8SocketIO0A8IOClientC12handlePacketyAA0aE0VF":{"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:8SocketIO0A8IOClientC3offyAA0A11ClientEventO06clientF0_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:8SocketIO0A8IOClientC2on10Foundation4UUIDVAA0A11ClientEventO06clientH0_ySayypG_AA0A10AckEmitterCtc8callbacktF":{"name":"on(clientEvent:callback:)","abstract":"

    Adds a handler for a client event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC4once10Foundation4UUIDVAA0A11ClientEventO06clientH0_ySayypG_AA0A10AckEmitterCtc8callbacktF":{"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:8SocketIO0A10AckEmitterCAcA0A8IOClientC6socket_Si6ackNumtcfc":{"name":"init(socket:ackNum:)","abstract":"

    Creates a new SocketAckEmitter.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC4withyAA0A4Data_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 +{"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