From 8364815deb85a83d72b34987782c317c23fc4558 Mon Sep 17 00:00:00 2001 From: Erik Little Date: Wed, 20 Sep 2017 07:13:24 -0400 Subject: [PATCH 1/2] bump version --- README.md | 22 +++++++++------------- Socket.IO-Client-Swift.podspec | 6 +++--- 2 files changed, 12 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index f1cd3ab..9755d4a 100644 --- a/README.md +++ b/README.md @@ -61,27 +61,23 @@ SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{ Checkout the [FAQs](https://nuclearace.github.io/Socket.IO-Client-Swift/faq.html) for commonly asked questions. ## Installation -Requires Swift 3/Xcode 8.x +Requires Swift 4/Xcode 9.x -If you need swift 2.3 use the swift2.3 tag (Pre-Swift 3 support is no longer maintained) +If you need Swift 2.3 use the [swift2.3 tag](https://github.com/socketio/socket.io-client-swift/releases/tag/swift2.3) (Pre-Swift 4 support is no longer maintained) -If you need swift 2.2 use 7.x. - -If you need Swift 2.1 use v5.5.0. - -If you need Swift 1.2 use v2.4.5. - -If you need Swift 1.1 use v1.5.2. +If you need Swift 3.x use v11.1.3. ### Swift Package Manager Add the project as a dependency to your Package.swift: ```swift +// swift-tools-version:4.0 + import PackageDescription let package = Package( name: "YourSocketIOProject", dependencies: [ - .Package(url: "https://github.com/socketio/socket.io-client-swift", majorVersion: 11) + .package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMajor(from: "12.0.0")) ] ) ``` @@ -91,8 +87,8 @@ Then import `import SocketIO`. ### Carthage Add these line to your `Cartfile`: ``` -github "nuclearace/Starscream" ~> 8.0.5 -github "socketio/socket.io-client-swift" ~> 11.1.3 # Or latest version +github "nuclearace/Starscream" ~> 8.0.7 +github "socketio/socket.io-client-swift" ~> 12.0.0 # Or latest version ``` Run `carthage update --platform ios,macosx`. @@ -104,7 +100,7 @@ Create `Podfile` and add `pod 'Socket.IO-Client-Swift'`: use_frameworks! target 'YourApp' do - pod 'Socket.IO-Client-Swift', '~> 11.1.3' # Or latest version + pod 'Socket.IO-Client-Swift', '~> 12.0.0' # Or latest version end ``` diff --git a/Socket.IO-Client-Swift.podspec b/Socket.IO-Client-Swift.podspec index eae9b3e..d757230 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 = "11.1.3" + s.version = "12.0.0" s.summary = "Socket.IO-client for iOS and OS X" s.description = <<-DESC Socket.IO-client for iOS and OS X. @@ -17,12 +17,12 @@ Pod::Spec.new do |s| s.requires_arc = true s.source = { :git => "https://github.com/socketio/socket.io-client-swift.git", - :tag => 'v11.1.3', + :tag => 'v12.0.0', :submodules => true } s.pod_target_xcconfig = { 'SWIFT_VERSION' => '4.0' } s.source_files = "Source/SocketIO/**/*.swift", "Source/SocketIO/*.swift" - s.dependency "StarscreamSocketIO", "~> 8.0.5" + s.dependency "StarscreamSocketIO", "~> 8.0.7" end From 8f50c5a3de3fbd7faa5ba98c04795bb65d39fa33 Mon Sep 17 00:00:00 2001 From: Erik Little Date: Wed, 20 Sep 2017 07:13:51 -0400 Subject: [PATCH 2/2] update docs --- docs/Classes.html | 32 ++-- docs/Classes/OnAckCallback.html | 16 +- docs/Classes/SocketAckEmitter.html | 22 +-- docs/Classes/SocketAnyEvent.html | 20 +- docs/Classes/SocketClientManager.html | 82 ++++---- docs/Classes/SocketEngine.html | 156 ++++++++-------- docs/Classes/SocketIOClient.html | 176 +++++++++--------- docs/Enums.html | 28 +-- docs/Enums/SocketAckStatus.html | 12 +- docs/Enums/SocketClientEvent.html | 32 ++-- docs/Enums/SocketEnginePacketType.html | 36 ++-- docs/Enums/SocketIOClientOption.html | 100 +++++----- docs/Enums/SocketIOClientStatus.html | 24 +-- docs/Guides.html | 8 +- docs/Protocols.html | 32 ++-- docs/Protocols/SocketData.html | 12 +- docs/Protocols/SocketEngineClient.html | 28 +-- docs/Protocols/SocketEnginePollable.html | 40 ++-- docs/Protocols/SocketEngineSpec.html | 116 ++++++------ docs/Protocols/SocketEngineWebsocket.html | 20 +- docs/Protocols/SocketLogger.html | 28 +-- docs/Structs.html | 12 +- docs/Structs/SocketIOClientConfiguration.html | 176 +++++++++--------- docs/Typealiases.html | 16 +- docs/faq.html | 8 +- docs/index.html | 32 ++-- docs/search.json | 2 +- 27 files changed, 631 insertions(+), 635 deletions(-) diff --git a/docs/Classes.html b/docs/Classes.html index 09de957..6399722 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -129,10 +129,10 @@ Typealiases @@ -155,9 +155,9 @@
  • - + - SocketEngine + SocketEngine
    @@ -188,9 +188,9 @@ See SocketEnginePollable
  • - + - SocketAckEmitter + SocketAckEmitter
    @@ -218,9 +218,9 @@ See SocketEnginePollable
  • @@ -256,9 +256,9 @@ Example:

  • @@ -288,9 +288,9 @@ Example:

  • @@ -324,9 +324,9 @@ Example:

  • @@ -372,8 +372,8 @@ manager["room1"]?.emit("hello")
    diff --git a/docs/Classes/OnAckCallback.html b/docs/Classes/OnAckCallback.html index 1556930..d208208 100644 --- a/docs/Classes/OnAckCallback.html +++ b/docs/Classes/OnAckCallback.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -175,9 +175,9 @@ Example:

  • @@ -192,7 +192,7 @@ Example:

    Declaration

    Swift

    -
    public func timingOut(after seconds: Double, callback: @escaping AckCallback)
    +
    public func timingOut(after seconds: Double, callback: @escaping AckCallback)
    @@ -221,7 +221,7 @@ Example:

    The callback called when an ack is received, or when a timeout happens. - To check for timeout, use SocketAckStatus‘s noAck case.

    + To check for timeout, use SocketAckStatus’s noAck case.

    @@ -239,8 +239,8 @@ Example:

    diff --git a/docs/Classes/SocketAckEmitter.html b/docs/Classes/SocketAckEmitter.html index f3ed5f6..7d86e28 100644 --- a/docs/Classes/SocketAckEmitter.html +++ b/docs/Classes/SocketAckEmitter.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -171,9 +171,9 @@
  • - + - expected + expected
    @@ -209,9 +209,9 @@
  • - + - with(_:) + with(_:)
    @@ -221,7 +221,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]

    @@ -258,9 +258,9 @@ will be emitted. The structure of the error data is [ackNum, items, theErr
  • - + - with(_:) + with(_:)
    @@ -309,8 +309,8 @@ will be emitted. The structure of the error data is [ackNum, items, theErr
    diff --git a/docs/Classes/SocketAnyEvent.html b/docs/Classes/SocketAnyEvent.html index a30f871..f510b23 100644 --- a/docs/Classes/SocketAnyEvent.html +++ b/docs/Classes/SocketAnyEvent.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -169,9 +169,9 @@
  • - + - event + event
    @@ -196,9 +196,9 @@
  • - + - items + items
    @@ -223,9 +223,9 @@
  • @@ -255,8 +255,8 @@
    diff --git a/docs/Classes/SocketClientManager.html b/docs/Classes/SocketClientManager.html index a50f57d..26e861d 100644 --- a/docs/Classes/SocketClientManager.html +++ b/docs/Classes/SocketClientManager.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -184,9 +184,36 @@ manager["room1"]?.emit("hello")
  • - + + + sharedManager + +
    +
    +
    +
    +
    +
    +

    The shared manager.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    open static let sharedManager = SocketClientManager()
    + +
    +
    +
    +
    +
  • +
  • +
    @@ -212,33 +239,6 @@ manager["room1"]?.emit("hello")
  • -
  • -
    - - - - sharedManager - -
    -
    -
    -
    -
    -
    -

    The shared manager.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    open static let sharedManager = SocketClientManager()
    - -
    -
    -
    -
    -
  • @@ -253,9 +253,9 @@ manager["room1"]?.emit("hello")
  • @@ -311,9 +311,9 @@ manager["room1"]?.emit("hello")
  • @@ -361,9 +361,9 @@ manager["room1"]?.emit("hello")
  • @@ -411,9 +411,9 @@ manager["room1"]?.emit("hello")
  • @@ -443,8 +443,8 @@ manager["room1"]?.emit("hello")
  • diff --git a/docs/Classes/SocketEngine.html b/docs/Classes/SocketEngine.html index 052f380..387479d 100644 --- a/docs/Classes/SocketEngine.html +++ b/docs/Classes/SocketEngine.html @@ -130,10 +130,10 @@ Typealiases @@ -170,9 +170,9 @@ See SocketEnginePollable<
  • @@ -197,9 +197,9 @@ See SocketEnginePollable<
  • @@ -224,9 +224,9 @@ See SocketEnginePollable<
  • @@ -253,9 +253,9 @@ See SocketEnginePollable<
  • @@ -283,9 +283,9 @@ disconnect us.

  • @@ -313,9 +313,9 @@ disconnect us.

  • - + - closed + closed
    @@ -340,9 +340,9 @@ disconnect us.

  • - + - compress + compress
    @@ -367,9 +367,9 @@ disconnect us.

  • @@ -394,9 +394,9 @@ disconnect us.

  • - + - cookies + cookies
    @@ -421,9 +421,9 @@ disconnect us.

  • @@ -448,9 +448,9 @@ disconnect us.

  • @@ -477,9 +477,9 @@ disconnect us.

  • @@ -504,9 +504,9 @@ disconnect us.

  • @@ -531,9 +531,9 @@ disconnect us.

  • @@ -558,9 +558,9 @@ disconnect us.

  • - + - polling + polling
    @@ -585,9 +585,9 @@ disconnect us.

  • - + - probing + probing
    @@ -612,9 +612,9 @@ disconnect us.

  • - + - session + session
    @@ -639,9 +639,9 @@ disconnect us.

  • - + - sid + sid
    @@ -666,9 +666,9 @@ disconnect us.

  • @@ -693,9 +693,9 @@ disconnect us.

  • @@ -720,9 +720,9 @@ disconnect us.

  • @@ -747,9 +747,9 @@ disconnect us.

  • @@ -774,9 +774,9 @@ disconnect us.

  • - + - ws + ws
    @@ -801,9 +801,9 @@ disconnect us.

  • - + - client + client
    @@ -839,9 +839,9 @@ disconnect us.

  • @@ -909,9 +909,9 @@ disconnect us.

  • @@ -990,9 +990,9 @@ disconnect us.

  • @@ -1017,9 +1017,9 @@ disconnect us.

  • @@ -1044,9 +1044,9 @@ disconnect us.

  • @@ -1090,9 +1090,9 @@ disconnect us.

  • @@ -1120,9 +1120,9 @@ WebSocket mode.

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

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

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

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

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

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

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

    diff --git a/docs/Classes/SocketIOClient.html b/docs/Classes/SocketIOClient.html index 71e74ff..2d100ce 100644 --- a/docs/Classes/SocketIOClient.html +++ b/docs/Classes/SocketIOClient.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -173,9 +173,9 @@
  • - + - engine + engine
    @@ -200,9 +200,9 @@
  • - + - status + status
    @@ -227,9 +227,9 @@
  • - + - forceNew + forceNew
    @@ -254,9 +254,9 @@
  • @@ -282,9 +282,9 @@ called on.

  • - + - nsp + nsp
    @@ -309,9 +309,9 @@ called on.

  • - + - config + config
    @@ -336,9 +336,9 @@ called on.

  • @@ -363,9 +363,9 @@ called on.

  • @@ -390,9 +390,9 @@ called on.

  • - + - sid + sid
    @@ -417,9 +417,9 @@ called on.

  • @@ -429,7 +429,7 @@ called on.

    The URL of the socket.io server.

    -

    If changed after calling init, forceNew must be set to true, or it will only connect to the url set in the +

    If changed after calling init, forceNew must be set to true, or it will only connect to the url set in the init.

    @@ -458,9 +458,9 @@ init.

  • @@ -516,9 +516,9 @@ init.

  • @@ -586,9 +586,9 @@ If using Swift it’s recommended to use init(socketURL: NSURL, option
  • @@ -613,9 +613,9 @@ If using Swift it’s recommended to use init(socketURL: NSURL, option
  • @@ -672,9 +672,9 @@ If using Swift it’s recommended to use init(socketURL: NSURL, option
  • @@ -699,9 +699,9 @@ If using Swift it’s recommended to use init(socketURL: NSURL, option
  • @@ -711,7 +711,7 @@ If using Swift it’s recommended to use init(socketURL: NSURL, option

    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]

    @@ -760,9 +760,9 @@ will be emitted. The structure of the error data is [eventName, items, the
  • @@ -818,9 +818,9 @@ will be emitted. The structure of the error data is [eventName, items, the
  • @@ -833,7 +833,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:

    @@ -892,9 +892,9 @@ will be emitted. The structure of the error data is [eventName, items, the
  • @@ -963,9 +963,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1009,9 +1009,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1055,9 +1055,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1101,9 +1101,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1183,9 +1183,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1210,9 +1210,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1258,9 +1258,9 @@ Check that your server’s api will ack the event being sent.

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

    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.

    @@ -1306,9 +1306,9 @@ Check that your server’s api will ack the event being sent.

  • - + - off(_:) + off(_:)
    @@ -1318,7 +1318,7 @@ Check that your server’s api will ack the event being sent.

    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.

    @@ -1354,9 +1354,9 @@ Check that your server’s api will ack the event being sent.

  • - + - off(id:) + off(id:)
    @@ -1366,7 +1366,7 @@ Check that your server’s api will ack the event being sent.

    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.

    @@ -1402,9 +1402,9 @@ Check that your server’s api will ack the event being sent.

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

    Declaration

    Swift

    -
    open func on(_ event: String, callback: @escaping NormalCallback) -> UUID
    +
    open func on(_ event: String, callback: @escaping NormalCallback) -> UUID
    @@ -1464,9 +1464,9 @@ Check that your server’s api will ack the event being sent.

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

    Declaration

    Swift

    -
    open func on(clientEvent event: SocketClientEvent, callback: @escaping NormalCallback) -> UUID
    +
    open func on(clientEvent event: SocketClientEvent, callback: @escaping NormalCallback) -> UUID
    @@ -1532,9 +1532,9 @@ Check that your server’s api will ack the event being sent.

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

    Declaration

    Swift

    -
    open func once(clientEvent event: SocketClientEvent, callback: @escaping NormalCallback) -> UUID
    +
    open func once(clientEvent event: SocketClientEvent, callback: @escaping NormalCallback) -> UUID
    @@ -1594,9 +1594,9 @@ Check that your server’s api will ack the event being sent.

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

    Declaration

    Swift

    -
    open func once(_ event: String, callback: @escaping NormalCallback) -> UUID
    +
    open func once(_ event: String, callback: @escaping NormalCallback) -> UUID
    @@ -1656,9 +1656,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1702,9 +1702,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1748,9 +1748,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1794,9 +1794,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1823,9 +1823,9 @@ Check that your server’s api will ack the event being sent.

  • @@ -1856,8 +1856,8 @@ Can be used after disconnecting to break any potential remaining retain cycles.<
    diff --git a/docs/Enums.html b/docs/Enums.html index 47c3093..08f21c4 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -129,10 +129,10 @@ Typealiases
  • @@ -155,9 +155,9 @@
  • @@ -187,9 +187,9 @@
  • @@ -219,9 +219,9 @@
  • @@ -251,9 +251,9 @@
  • @@ -283,9 +283,9 @@
  • @@ -316,8 +316,8 @@
    diff --git a/docs/Enums/SocketAckStatus.html b/docs/Enums/SocketAckStatus.html index ccf2bfe..c0e0ac2 100644 --- a/docs/Enums/SocketAckStatus.html +++ b/docs/Enums/SocketAckStatus.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -162,9 +162,9 @@
  • - + - noAck + noAck
    @@ -194,8 +194,8 @@
    diff --git a/docs/Enums/SocketClientEvent.html b/docs/Enums/SocketClientEvent.html index d5f3dae..b879888 100644 --- a/docs/Enums/SocketClientEvent.html +++ b/docs/Enums/SocketClientEvent.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -162,9 +162,9 @@
  • - + - connect + connect
    @@ -199,9 +199,9 @@ data item: the namespace that was connected to.

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

  • - + - error + error
    @@ -261,9 +261,9 @@ data item: the namespace that was connected to.

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

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

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

    diff --git a/docs/Enums/SocketEnginePacketType.html b/docs/Enums/SocketEnginePacketType.html index ad65ce2..8bbc66b 100644 --- a/docs/Enums/SocketEnginePacketType.html +++ b/docs/Enums/SocketEnginePacketType.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -162,9 +162,9 @@
  • - + - open + open
    @@ -193,9 +193,9 @@
  • - + - close + close
    @@ -224,9 +224,9 @@
  • - + - ping + ping
    @@ -255,9 +255,9 @@
  • - + - pong + pong
    @@ -286,9 +286,9 @@
  • - + - message + message
    @@ -317,9 +317,9 @@
  • - + - upgrade + upgrade
    @@ -348,9 +348,9 @@
  • - + - noop + noop
    @@ -380,8 +380,8 @@
    diff --git a/docs/Enums/SocketIOClientOption.html b/docs/Enums/SocketIOClientOption.html index aacdcd6..f86213d 100644 --- a/docs/Enums/SocketIOClientOption.html +++ b/docs/Enums/SocketIOClientOption.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -162,9 +162,9 @@
  • - + - compress + compress
    @@ -193,9 +193,9 @@
  • @@ -224,9 +224,9 @@
  • - + - cookies + cookies
    @@ -255,9 +255,9 @@
  • @@ -286,9 +286,9 @@
  • @@ -317,9 +317,9 @@
  • - + - forceNew + forceNew
    @@ -349,9 +349,9 @@ or when you want to be sure no state from previous engines is being carried over
  • @@ -380,9 +380,9 @@ or when you want to be sure no state from previous engines is being carried over
  • @@ -411,9 +411,9 @@ or when you want to be sure no state from previous engines is being carried over
  • @@ -443,9 +443,9 @@ called on.

  • - + - log + log
    @@ -474,9 +474,9 @@ called on.

  • - + - logger + logger
    @@ -505,9 +505,9 @@ called on.

  • - + - nsp + nsp
    @@ -537,9 +537,9 @@ and leaveNamespace methods on
    - + - path + path
    @@ -568,9 +568,9 @@ and leaveNamespace methods on
    @@ -600,9 +600,9 @@ over when reconnects happen.

  • @@ -631,9 +631,9 @@ over when reconnects happen.

  • @@ -662,9 +662,9 @@ over when reconnects happen.

  • - + - secure + secure
    @@ -693,9 +693,9 @@ over when reconnects happen.

  • - + - security + security
    @@ -724,9 +724,9 @@ over when reconnects happen.

  • @@ -755,9 +755,9 @@ over when reconnects happen.

  • @@ -786,9 +786,9 @@ over when reconnects happen.

  • @@ -825,9 +825,9 @@ the background. This option is experimental as socket.io shouldn’t
  • @@ -863,9 +863,9 @@ the background. This option is experimental as socket.io shouldn’t
  • - + - ==(_:_:) + ==(_:_:)
    @@ -930,8 +930,8 @@ the background. This option is experimental as socket.io shouldn’t
    diff --git a/docs/Enums/SocketIOClientStatus.html b/docs/Enums/SocketIOClientStatus.html index 28101b9..f977e6d 100644 --- a/docs/Enums/SocketIOClientStatus.html +++ b/docs/Enums/SocketIOClientStatus.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -162,9 +162,9 @@
  • @@ -193,9 +193,9 @@
  • @@ -224,9 +224,9 @@
  • @@ -255,9 +255,9 @@
  • @@ -287,8 +287,8 @@
    diff --git a/docs/Guides.html b/docs/Guides.html index 467d9c2..455227c 100644 --- a/docs/Guides.html +++ b/docs/Guides.html @@ -129,10 +129,10 @@ Typealiases
  • @@ -156,8 +156,8 @@ diff --git a/docs/Protocols.html b/docs/Protocols.html index d3adc2f..a598a91 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -129,10 +129,10 @@ Typealiases @@ -155,9 +155,9 @@
  • @@ -187,9 +187,9 @@
  • @@ -219,9 +219,9 @@
  • @@ -251,9 +251,9 @@
  • @@ -283,9 +283,9 @@
  • @@ -328,9 +328,9 @@
  • @@ -361,8 +361,8 @@
    diff --git a/docs/Protocols/SocketData.html b/docs/Protocols/SocketData.html index 0fe0f05..e443ce6 100644 --- a/docs/Protocols/SocketData.html +++ b/docs/Protocols/SocketData.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -182,9 +182,9 @@
  • - + - socketRepresentation() + socketRepresentation() Default implementation @@ -222,8 +222,8 @@
    diff --git a/docs/Protocols/SocketEngineClient.html b/docs/Protocols/SocketEngineClient.html index 585dfca..d830f0b 100644 --- a/docs/Protocols/SocketEngineClient.html +++ b/docs/Protocols/SocketEngineClient.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -169,9 +169,9 @@
  • @@ -215,9 +215,9 @@
  • @@ -261,9 +261,9 @@
  • @@ -307,9 +307,9 @@
  • @@ -353,9 +353,9 @@
  • @@ -404,8 +404,8 @@
    diff --git a/docs/Protocols/SocketEnginePollable.html b/docs/Protocols/SocketEnginePollable.html index 589194a..b224663 100644 --- a/docs/Protocols/SocketEnginePollable.html +++ b/docs/Protocols/SocketEnginePollable.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -162,9 +162,9 @@
  • @@ -190,9 +190,9 @@
  • - + - postWait + postWait
    @@ -219,9 +219,9 @@
  • - + - session + session
    @@ -246,9 +246,9 @@
  • @@ -276,9 +276,9 @@ disconnect us.

  • @@ -306,9 +306,9 @@ disconnect us.

  • - + - doPoll() + doPoll() Default implementation @@ -345,9 +345,9 @@ disconnect us.

  • - + - sendPollMessage(_:withType:withData:) + sendPollMessage(_:withType:withData:) Default implementation @@ -427,9 +427,9 @@ disconnect us.

  • - + - stopPolling() + stopPolling() Default implementation @@ -467,8 +467,8 @@ disconnect us.

    diff --git a/docs/Protocols/SocketEngineSpec.html b/docs/Protocols/SocketEngineSpec.html index 8ed47c0..999bb5a 100644 --- a/docs/Protocols/SocketEngineSpec.html +++ b/docs/Protocols/SocketEngineSpec.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -162,9 +162,9 @@
  • - + - client + client
    @@ -189,9 +189,9 @@
  • - + - closed + closed
    @@ -216,9 +216,9 @@
  • @@ -243,9 +243,9 @@
  • @@ -270,9 +270,9 @@
  • - + - cookies + cookies
    @@ -297,9 +297,9 @@
  • @@ -324,9 +324,9 @@
  • @@ -351,9 +351,9 @@
  • @@ -378,9 +378,9 @@
  • @@ -405,9 +405,9 @@
  • @@ -432,9 +432,9 @@
  • - + - polling + polling
    @@ -459,9 +459,9 @@
  • - + - probing + probing
    @@ -486,9 +486,9 @@
  • - + - sid + sid
    @@ -513,9 +513,9 @@
  • @@ -540,9 +540,9 @@
  • @@ -567,9 +567,9 @@
  • @@ -594,9 +594,9 @@
  • @@ -621,9 +621,9 @@
  • - + - ws + ws
    @@ -648,9 +648,9 @@
  • @@ -718,9 +718,9 @@
  • @@ -745,9 +745,9 @@
  • @@ -772,9 +772,9 @@
  • @@ -818,9 +818,9 @@
  • @@ -848,9 +848,9 @@ WebSocket mode.

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

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

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

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

    diff --git a/docs/Protocols/SocketEngineWebsocket.html b/docs/Protocols/SocketEngineWebsocket.html index fbb4005..d3fe422 100644 --- a/docs/Protocols/SocketEngineWebsocket.html +++ b/docs/Protocols/SocketEngineWebsocket.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -162,9 +162,9 @@
  • diff --git a/docs/Protocols/SocketLogger.html b/docs/Protocols/SocketLogger.html index 7e60749..c1f394f 100644 --- a/docs/Protocols/SocketLogger.html +++ b/docs/Protocols/SocketLogger.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -169,9 +169,9 @@
  • - + - log + log
    @@ -207,9 +207,9 @@
  • - - - log(_:type:args:) + + + log(_:type:) Default implementation @@ -232,7 +232,7 @@

    Declaration

    Swift

    -
    func log(_ message: String, type: String, args: Any...)
    +
    func log(_ message: @autoclosure () -> String, type: String)
    @@ -285,9 +285,9 @@
  • - - - error(_:type:args:) + + + error(_:type:) Default implementation @@ -310,7 +310,7 @@

    Declaration

    Swift

    -
    func error(_ message: String, type: String, args: Any...)
    +
    func error(_ message: @autoclosure () -> String, type: String)
    @@ -368,8 +368,8 @@ diff --git a/docs/Structs.html b/docs/Structs.html index dfebbe0..e16fbe7 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -129,10 +129,10 @@ Typealiases
  • @@ -155,9 +155,9 @@
  • @@ -188,8 +188,8 @@
    diff --git a/docs/Structs/SocketIOClientConfiguration.html b/docs/Structs/SocketIOClientConfiguration.html index 67cb2ef..5f59192 100644 --- a/docs/Structs/SocketIOClientConfiguration.html +++ b/docs/Structs/SocketIOClientConfiguration.html @@ -130,10 +130,10 @@ Typealiases
  • @@ -169,36 +169,9 @@
  • - - - Iterator - -
    -
    -
    -
    -
    -
    -

    Iterator type.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public typealias Iterator = Array<SocketIOClientOption>.Iterator
    - -
    -
    -
    -
    -
  • -
  • -
    - - + - Element + Element
    @@ -223,36 +196,9 @@
  • - - - SubSequence - -
    -
    -
    -
    -
    -
    -

    SubSequence type.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public typealias SubSequence =  Array<SocketIOClientOption>.SubSequence
    - -
    -
    -
    -
    -
  • -
  • -
    - - + - Index + Index
    @@ -274,6 +220,60 @@
  • +
  • +
    + + + + Iterator + +
    +
    +
    +
    +
    +
    +

    Iterator type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public typealias Iterator = Array<SocketIOClientOption>.Iterator
    + +
    +
    +
    +
    +
  • +
  • +
    + + + + SubSequence + +
    +
    +
    +
    +
    +
    +

    SubSequence type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public typealias SubSequence =  Array<SocketIOClientOption>.SubSequence
    + +
    +
    +
    +
    +
  • @@ -288,9 +288,9 @@
  • @@ -305,7 +305,7 @@

    Declaration

    Swift

    -
    public var startIndex: Index
    +
    public var startIndex: Index
    @@ -315,9 +315,9 @@
  • - + - endIndex + endIndex
    @@ -332,7 +332,7 @@

    Declaration

    Swift

    -
    public var endIndex: Index
    +
    public var endIndex: Index
    @@ -342,9 +342,9 @@
  • - + - isEmpty + isEmpty
    @@ -369,9 +369,9 @@
  • - + - count + count
    @@ -386,7 +386,7 @@

    Declaration

    Swift

    -
    public var count: Index.Stride
    +
    public var count: Index.Stride
    @@ -396,9 +396,9 @@
  • - + - first + first
    @@ -413,7 +413,7 @@

    Declaration

    Swift

    -
    public var first: Element?
    +
    public var first: Element?
    @@ -434,9 +434,9 @@
  • @@ -451,7 +451,7 @@

    Declaration

    Swift

    -
    public init(arrayLiteral elements: Element...)
    +
    public init(arrayLiteral elements: Element...)
    @@ -491,9 +491,9 @@
  • @@ -508,7 +508,7 @@

    Declaration

    Swift

    -
    public func makeIterator() -> Iterator
    +
    public func makeIterator() -> Iterator
    @@ -522,9 +522,9 @@
  • @@ -538,7 +538,7 @@

    Declaration

    Swift

    -
    public func index(after i: Index) -> Index
    +
    public func index(after i: Index) -> Index
    @@ -552,9 +552,9 @@
  • @@ -569,7 +569,7 @@

    Declaration

    Swift

    -
    public mutating func insert(_ element: Element, replacing replace: Bool = true)
    +
    public mutating func insert(_ element: Element, replacing replace: Bool = true)
    @@ -615,8 +615,8 @@
  • diff --git a/docs/Typealiases.html b/docs/Typealiases.html index b193c42..1afbc5b 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -129,10 +129,10 @@ Typealiases @@ -155,9 +155,9 @@
  • @@ -182,9 +182,9 @@
  • @@ -214,8 +214,8 @@
    diff --git a/docs/faq.html b/docs/faq.html index a1f3b68..2908fcd 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -129,10 +129,10 @@ Typealiases
  • @@ -198,8 +198,8 @@ will be released and its memory reclaimed.

    diff --git a/docs/index.html b/docs/index.html index a9aec01..111abe9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -129,10 +129,10 @@ Typealiases @@ -204,26 +204,22 @@ SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{

    Checkout the FAQs for commonly asked questions.

    Installation

    -

    Requires Swift 3/Xcode 8.x

    +

    Requires Swift 4/Xcode 9.x

    -

    If you need swift 2.3 use the swift2.3 tag (Pre-Swift 3 support is no longer maintained)

    +

    If you need Swift 2.3 use the swift2.3 tag (Pre-Swift 4 support is no longer maintained)

    -

    If you need swift 2.2 use 7.x.

    - -

    If you need Swift 2.1 use v5.5.0.

    - -

    If you need Swift 1.2 use v2.4.5.

    - -

    If you need Swift 1.1 use v1.5.2.

    +

    If you need Swift 3.x use v11.1.3.

    Swift Package Manager

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

    -
    import PackageDescription
    +
    // swift-tools-version:4.0
    +
    +import PackageDescription
     
     let package = Package(
         name: "YourSocketIOProject",
         dependencies: [
    -        .Package(url: "https://github.com/socketio/socket.io-client-swift", majorVersion: 11)
    +        .package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMajor(from: "12.0.0"))
         ]
     )
     
    @@ -232,8 +228,8 @@ SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{

    Carthage

    Add these line to your Cartfile:

    -
    github "nuclearace/Starscream" ~> 8.0.5
    -github "socketio/socket.io-client-swift" ~> 11.1.3 # Or latest version
    +
    github "nuclearace/Starscream" ~> 8.0.7
    +github "socketio/socket.io-client-swift" ~> 12.0.0 # Or latest version
     

    Run carthage update --platform ios,macosx.

    @@ -243,7 +239,7 @@ github "socketio/socket.io-client-swift" ~> 11.1.3 # Or latest version
    use_frameworks!
     
     target 'YourApp' do
    -    pod 'Socket.IO-Client-Swift', '~> 11.1.3' # Or latest version
    +    pod 'Socket.IO-Client-Swift', '~> 12.0.0' # Or latest version
     end
     
    @@ -283,8 +279,8 @@ github "socketio/socket.io-client-swift" ~> 11.1.3 # Or latest version diff --git a/docs/search.json b/docs/search.json index 0007c43..0594d61 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -{"Typealiases.html#/s:8SocketIO11AckCallback":{"name":"AckCallback","abstract":"

    A typealias for an ack callback.

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

    A typealias for a normal callback.

    "},"Structs/SocketIOClientConfiguration.html#/s:V8SocketIO27SocketIOClientConfiguration8Iterator":{"name":"Iterator","abstract":"

    Iterator type.

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

    Type of element stored.

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

    SubSequence type.

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

    Index type.

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

    The start index of this collection.

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

    The end index of this collection.

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

    Whether this collection is empty.

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

    The number of elements stored in this collection.

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

    The first element in this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:FV8SocketIO27SocketIOClientConfigurationcFt12arrayLiteralGSaOS_20SocketIOClientOption__S0_":{"name":"init(arrayLiteral:)","abstract":"

    Creates a new SocketIOClientConfiguration from an array literal.

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

    Creates an iterator for this collection.

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

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

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

    An array-like type that holds SocketIOClientOptions

    "},"Protocols/SocketLogger.html#/s:vP8SocketIO12SocketLogger3logSb":{"name":"log","abstract":"

    Whether to log or not

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

    Normal log messages

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

    Error Messages

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

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

    ","parent_name":"SocketData"},"Protocols/SocketEngineWebsocket.html#/s:FP8SocketIO21SocketEngineWebsocket20sendWebSocketMessageFTSS8withTypeOS_22SocketEnginePacketType8withDataGSaV10Foundation4Data__T_":{"name":"sendWebSocketMessage(_:withType:withData:)","abstract":"

    Sends an engine.io message through the WebSocket transport.

    ","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineWebsocket.html#/s:FE8SocketIOPS_21SocketEngineWebsocket26websocketDidReceiveMessageFT6socketC18StarscreamSocketIO9WebSocket4textSS_T_":{"name":"websocketDidReceiveMessage(socket:text:)","abstract":"

    Delegate method for when a message is received.

    ","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineWebsocket.html#/s:FE8SocketIOPS_21SocketEngineWebsocket23websocketDidReceiveDataFT6socketC18StarscreamSocketIO9WebSocket4dataV10Foundation4Data_T_":{"name":"websocketDidReceiveData(socket:data:)","abstract":"

    Delegate method for when binary is received.

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

    MARK: Properties","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:vP8SocketIO20SocketEnginePollable8postWaitGSaSS_":{"name":"postWait","abstract":"

    A queue of engine.io messages waiting for POSTing

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

    The URLSession that will be used for polling.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:vP8SocketIO20SocketEnginePollable14waitingForPollSb":{"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:vP8SocketIO20SocketEnginePollable14waitingForPostSb":{"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:FP8SocketIO20SocketEnginePollable6doPollFT_T_":{"name":"doPoll()","abstract":"

    Call to send a long-polling request.

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

    Sends an engine.io message through the polling transport.

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

    Call to stop polling and invalidate the URLSession.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEngineClient.html#/s:FP8SocketIO18SocketEngineClient14engineDidErrorFT6reasonSS_T_":{"name":"engineDidError(reason:)","abstract":"

    Called when the engine errors.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/s:FP8SocketIO18SocketEngineClient14engineDidCloseFT6reasonSS_T_":{"name":"engineDidClose(reason:)","abstract":"

    Called when the engine closes.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/s:FP8SocketIO18SocketEngineClient13engineDidOpenFT6reasonSS_T_":{"name":"engineDidOpen(reason:)","abstract":"

    Called when the engine opens.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/s:FP8SocketIO18SocketEngineClient18parseEngineMessageFSST_":{"name":"parseEngineMessage(_:)","abstract":"

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

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/s:FP8SocketIO18SocketEngineClient21parseEngineBinaryDataFV10Foundation4DataT_":{"name":"parseEngineBinaryData(_:)","abstract":"

    Called when the engine receives binary data.

    ","parent_name":"SocketEngineClient"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec6clientGSqPS_18SocketEngineClient__":{"name":"client","abstract":"

    The client for this engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec6closedSb":{"name":"closed","abstract":"

    true if this engine is closed.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec9connectedSb":{"name":"connected","abstract":"

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

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec13connectParamsGSqGVs10DictionarySSP___":{"name":"connectParams","abstract":"

    The connect parameters sent during a connect.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec7cookiesGSqGSaCSo10HTTPCookie__":{"name":"cookies","abstract":"

    An array of HTTPCookies that are sent during the connection.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec11engineQueueCSo13DispatchQueue":{"name":"engineQueue","abstract":"

    The queue that all engine actions take place on.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec12extraHeadersGSqGVs10DictionarySSSS__":{"name":"extraHeaders","abstract":"

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

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec11fastUpgradeSb":{"name":"fastUpgrade","abstract":"

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

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec12forcePollingSb":{"name":"forcePolling","abstract":"

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

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec15forceWebsocketsSb":{"name":"forceWebsockets","abstract":"

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

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec7pollingSb":{"name":"polling","abstract":"

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

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec7probingSb":{"name":"probing","abstract":"

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

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec3sidSS":{"name":"sid","abstract":"

    The session id for this engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec10socketPathSS":{"name":"socketPath","abstract":"

    The path to engine.io.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec10urlPollingV10Foundation3URL":{"name":"urlPolling","abstract":"

    The url for polling.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec12urlWebSocketV10Foundation3URL":{"name":"urlWebSocket","abstract":"

    The url for WebSockets.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec9websocketSb":{"name":"websocket","abstract":"

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

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec2wsGSqC18StarscreamSocketIO9WebSocket_":{"name":"ws","abstract":"

    The WebSocket for this engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpeccFT6clientPS_18SocketEngineClient_3urlV10Foundation3URL7optionsGSqCSo12NSDictionary__x":{"name":"init(client:url:options:)","abstract":"

    Creates a new engine.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec7connectFT_T_":{"name":"connect()","abstract":"

    Starts the connection to the server.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec8didErrorFT6reasonSS_T_":{"name":"didError(reason:)","abstract":"

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

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec10disconnectFT6reasonSS_T_":{"name":"disconnect(reason:)","abstract":"

    Disconnects from the server.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec13doFastUpgradeFT_T_":{"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#/s:FP8SocketIO16SocketEngineSpec30flushWaitingForPostToWebSocketFT_T_":{"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#/s:FP8SocketIO16SocketEngineSpec15parseEngineDataFV10Foundation4DataT_":{"name":"parseEngineData(_:)","abstract":"

    Parses raw binary received from engine.io.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec18parseEngineMessageFSST_":{"name":"parseEngineMessage(_:)","abstract":"

    Parses a raw engine.io packet.

    ","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec5writeFTSS8withTypeOS_22SocketEnginePacketType8withDataGSaV10Foundation4Data__T_":{"name":"write(_:withType:withData:)","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/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.

    "},"Enums/SocketIOClientStatus.html#/s:FO8SocketIO20SocketIOClientStatus12notConnectedFMS0_S0_":{"name":"notConnected","abstract":"

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

    ","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientStatus.html#/s:FO8SocketIO20SocketIOClientStatus12disconnectedFMS0_S0_":{"name":"disconnected","abstract":"

    The client was once connected, but not anymore.

    ","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientStatus.html#/s:FO8SocketIO20SocketIOClientStatus10connectingFMS0_S0_":{"name":"connecting","abstract":"

    The client is in the process of connecting.

    ","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientStatus.html#/s:FO8SocketIO20SocketIOClientStatus9connectedFMS0_S0_":{"name":"connected","abstract":"

    The client is currently connected.

    ","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption8compressFMS0_S0_":{"name":"compress","abstract":"

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

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

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

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

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

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption16doubleEncodeUTF8FMS0_FSbS0_":{"name":"doubleEncodeUTF8","abstract":"

    Deprecated

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

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

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption8forceNewFMS0_FSbS0_":{"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:FO8SocketIO20SocketIOClientOption12forcePollingFMS0_FSbS0_":{"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:FO8SocketIO20SocketIOClientOption15forceWebsocketsFMS0_FSbS0_":{"name":"forceWebsockets","abstract":"

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

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption11handleQueueFMS0_FCSo13DispatchQueueS0_":{"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:FO8SocketIO20SocketIOClientOption3logFMS0_FSbS0_":{"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:FO8SocketIO20SocketIOClientOption6loggerFMS0_FPS_12SocketLogger_S0_":{"name":"logger","abstract":"

    Used to pass in a custom logger.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption3nspFMS0_FSSS0_":{"name":"nsp","abstract":"

    The namespace that this client should connect to. Can be changed during use using the joinNamespace","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption4pathFMS0_FSSS0_":{"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:FO8SocketIO20SocketIOClientOption10reconnectsFMS0_FSbS0_":{"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:FO8SocketIO20SocketIOClientOption17reconnectAttemptsFMS0_FSiS0_":{"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:FO8SocketIO20SocketIOClientOption13reconnectWaitFMS0_FSiS0_":{"name":"reconnectWait","abstract":"

    The number of seconds to wait before reconnect attempts.

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

    Set true if your server is using secure transports.

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

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

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

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

    ","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption15sessionDelegateFMS0_FPSo18URLSessionDelegate_S0_":{"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:FO8SocketIO20SocketIOClientOption11voipEnabledFMS0_FSbS0_":{"name":"voipEnabled","abstract":"

    If passed true, the WebSocket transport will try and use voip logic to keep network connections open in","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:vO8SocketIO20SocketIOClientOption11descriptionSS":{"name":"description","abstract":"

    The description of this option.

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

    Compares whether two options are the same.

    ","parent_name":"SocketIOClientOption"},"Enums/SocketClientEvent.html#/s:FO8SocketIO17SocketClientEvent7connectFMS0_S0_":{"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:FO8SocketIO17SocketClientEvent10disconnectFMS0_S0_":{"name":"disconnect","abstract":"

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

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

    Called when an error occurs.

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

    Called when the client begins the reconnection process.

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

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

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

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

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

    The ack timed out.

    ","parent_name":"SocketAckStatus"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType4openFMS0_S0_":{"name":"open","abstract":"

    Open message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType5closeFMS0_S0_":{"name":"close","abstract":"

    Close message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType4pingFMS0_S0_":{"name":"ping","abstract":"

    Ping message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType4pongFMS0_S0_":{"name":"pong","abstract":"

    Pong message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType7messageFMS0_S0_":{"name":"message","abstract":"

    Regular message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType7upgradeFMS0_S0_":{"name":"upgrade","abstract":"

    Upgrade message.

    ","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType4noopFMS0_S0_":{"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/SocketIOClientStatus.html":{"name":"SocketIOClientStatus","abstract":"

    Represents the state of the client.

    "},"Classes/SocketClientManager.html#/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_":{"name":"subscript(_:)","abstract":"

    Gets a socket by its name.

    ","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_":{"name":"sharedManager","abstract":"

    The shared manager.

    ","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:FC8SocketIO19SocketClientManager9addSocketFTCS_14SocketIOClient9labeledAsSS_T_":{"name":"addSocket(_:labeledAs:)","abstract":"

    Adds a socket.

    ","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:FC8SocketIO19SocketClientManager12removeSocketFT9withLabelSS_GSqCS_14SocketIOClient_":{"name":"removeSocket(withLabel:)","abstract":"

    Removes a socket by a given name.

    ","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:FC8SocketIO19SocketClientManager12removeSocketFCS_14SocketIOClientGSqS1__":{"name":"removeSocket(_:)","abstract":"

    Removes a socket.

    ","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:FC8SocketIO19SocketClientManager13removeSocketsFT_T_":{"name":"removeSockets()","abstract":"

    Removes all the sockets in the manager.

    ","parent_name":"SocketClientManager"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient6engineGSqPS_16SocketEngineSpec__":{"name":"engine","abstract":"

    The engine for this client.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient6statusOS_20SocketIOClientStatus":{"name":"status","abstract":"

    The status of this client.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient8forceNewSb":{"name":"forceNew","abstract":"

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

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient11handleQueueCSo13DispatchQueue":{"name":"handleQueue","abstract":"

    The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient3nspSS":{"name":"nsp","abstract":"

    The namespace for this client.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient6configVS_27SocketIOClientConfiguration":{"name":"config","abstract":"

    The configuration for this client.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient10reconnectsSb":{"name":"reconnects","abstract":"

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

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient13reconnectWaitSi":{"name":"reconnectWait","abstract":"

    The number of seconds to wait before attempting to reconnect.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient3sidGSqSS_":{"name":"sid","abstract":"

    The session id of this client.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient9socketURLV10Foundation3URL":{"name":"socketURL","abstract":"

    The URL of the socket.io server.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClientcFT9socketURLV10Foundation3URL6configVS_27SocketIOClientConfiguration_S0_":{"name":"init(socketURL:config:)","abstract":"

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

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClientcFT9socketURLCSo5NSURL6configGSqCSo12NSDictionary__S0_":{"name":"init(socketURL:config:)","abstract":"

    Not so type safe way to create a SocketIOClient, meant for Objective-C compatiblity.","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient7connectFT_T_":{"name":"connect()","abstract":"

    Connect to the server.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient7connectFT12timeoutAfterSd11withHandlerGSqFT_T___T_":{"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:FC8SocketIO14SocketIOClient10disconnectFT_T_":{"name":"disconnect()","abstract":"

    Disconnects the socket.

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

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

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient4emitFTSS4withGSaP___T_":{"name":"emit(_:with:)","abstract":"

    Same as emit, but meant for Objective-C

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

    Sends a message to the server, requesting an ack.

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

    Same as emitWithAck, but for Objective-C

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient14engineDidCloseFT6reasonSS_T_":{"name":"engineDidClose(reason:)","abstract":"

    Called when the engine closes.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient14engineDidErrorFT6reasonSS_T_":{"name":"engineDidError(reason:)","abstract":"

    Called when the engine errors.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient13engineDidOpenFT6reasonSS_T_":{"name":"engineDidOpen(reason:)","abstract":"

    Called when the engine opens.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient11handleEventFTSS4dataGSaP__17isInternalMessageSb7withAckSi_T_":{"name":"handleEvent(_:data:isInternalMessage:withAck:)","abstract":"

    Causes an event to be handled, and any event handlers for that event to be called.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient14leaveNamespaceFT_T_":{"name":"leaveNamespace()","abstract":"

    Leaves nsp and goes back to the default namespace.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient13joinNamespaceFSST_":{"name":"joinNamespace(_:)","abstract":"

    Joins namespace.

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

    Removes handler(s) for a client event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient3offFSST_":{"name":"off(_:)","abstract":"

    Removes handler(s) based on an event name.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient3offFT2idV10Foundation4UUID_T_":{"name":"off(id:)","abstract":"

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

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient2onFTSS8callbackFTGSaP__CS_16SocketAckEmitter_T__V10Foundation4UUID":{"name":"on(_:callback:)","abstract":"

    Adds a handler for an event.

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

    Adds a handler for a client event.

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

    Adds a single-use handler for a client event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient4onceFTSS8callbackFTGSaP__CS_16SocketAckEmitter_T__V10Foundation4UUID":{"name":"once(_:callback:)","abstract":"

    Adds a single-use handler for an event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient5onAnyFFCS_14SocketAnyEventT_T_":{"name":"onAny(_:)","abstract":"

    Adds a handler that will be called on every event.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient18parseEngineMessageFSST_":{"name":"parseEngineMessage(_:)","abstract":"

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

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient21parseEngineBinaryDataFV10Foundation4DataT_":{"name":"parseEngineBinaryData(_:)","abstract":"

    Called when the engine receives binary data.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient9reconnectFT_T_":{"name":"reconnect()","abstract":"

    Tries to reconnect to the server.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient17removeAllHandlersFT_T_":{"name":"removeAllHandlers()","abstract":"

    Removes all handlers.","parent_name":"SocketIOClient"},"Classes/SocketAnyEvent.html#/s:vC8SocketIO14SocketAnyEvent5eventSS":{"name":"event","abstract":"

    The event name.

    ","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/s:vC8SocketIO14SocketAnyEvent5itemsGSqGSaP___":{"name":"items","abstract":"

    The data items for this event.

    ","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/s:vC8SocketIO14SocketAnyEvent11descriptionSS":{"name":"description","abstract":"

    The description of this event.

    ","parent_name":"SocketAnyEvent"},"Classes/OnAckCallback.html#/s:FC8SocketIO13OnAckCallback9timingOutFT5afterSd8callbackFGSaP__T__T_":{"name":"timingOut(after:callback:)","abstract":"

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

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

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

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

    Call to ack receiving this event.

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

    Call to ack receiving this event.

    ","parent_name":"SocketAckEmitter"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine11engineQueueCSo13DispatchQueue":{"name":"engineQueue","abstract":"

    The queue that all engine actions take place on.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine13connectParamsGSqGVs10DictionarySSP___":{"name":"connectParams","abstract":"

    The connect parameters sent during a connect.

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

    A queue of engine.io messages waiting for POSTing

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine14waitingForPollSb":{"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:vC8SocketIO12SocketEngine14waitingForPostSb":{"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#/s:vC8SocketIO12SocketEngine6closedSb":{"name":"closed","abstract":"

    true if this engine is closed.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine8compressSb":{"name":"compress","abstract":"

    If true the engine will attempt to use WebSocket compression.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine9connectedSb":{"name":"connected","abstract":"

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

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine7cookiesGSqGSaCSo10HTTPCookie__":{"name":"cookies","abstract":"

    An array of HTTPCookies that are sent during the connection.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine12extraHeadersGSqGVs10DictionarySSSS__":{"name":"extraHeaders","abstract":"

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

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine11fastUpgradeSb":{"name":"fastUpgrade","abstract":"

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

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine12forcePollingSb":{"name":"forcePolling","abstract":"

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

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine15forceWebsocketsSb":{"name":"forceWebsockets","abstract":"

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

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

    true If engine’s session has been invalidated.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine7pollingSb":{"name":"polling","abstract":"

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

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine7probingSb":{"name":"probing","abstract":"

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

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

    The URLSession that will be used for polling.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine3sidSS":{"name":"sid","abstract":"

    The session id for this engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine10socketPathSS":{"name":"socketPath","abstract":"

    The path to engine.io.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine10urlPollingV10Foundation3URL":{"name":"urlPolling","abstract":"

    The url for polling.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine12urlWebSocketV10Foundation3URL":{"name":"urlWebSocket","abstract":"

    The url for WebSockets.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine9websocketSb":{"name":"websocket","abstract":"

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

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine2wsGSqC18StarscreamSocketIO9WebSocket_":{"name":"ws","abstract":"

    The WebSocket for this engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine6clientXwGSqPS_18SocketEngineClient__":{"name":"client","abstract":"

    The client for this engine.

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

    Creates a new engine.

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

    Creates a new engine.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine7connectFT_T_":{"name":"connect()","abstract":"

    Starts the connection to the server.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine8didErrorFT6reasonSS_T_":{"name":"didError(reason:)","abstract":"

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

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine10disconnectFT6reasonSS_T_":{"name":"disconnect(reason:)","abstract":"

    Disconnects from the server.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine13doFastUpgradeFT_T_":{"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#/s:FC8SocketIO12SocketEngine30flushWaitingForPostToWebSocketFT_T_":{"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#/s:FC8SocketIO12SocketEngine15parseEngineDataFV10Foundation4DataT_":{"name":"parseEngineData(_:)","abstract":"

    Parses raw binary received from engine.io.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine18parseEngineMessageFSST_":{"name":"parseEngineMessage(_:)","abstract":"

    Parses a raw engine.io packet.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine5writeFTSS8withTypeOS_22SocketEnginePacketType8withDataGSaV10Foundation4Data__T_":{"name":"write(_:withType:withData:)","abstract":"

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

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine19websocketDidConnectFT6socketC18StarscreamSocketIO9WebSocket_T_":{"name":"websocketDidConnect(socket:)","abstract":"

    Delegate method for connection.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine22websocketDidDisconnectFT6socketC18StarscreamSocketIO9WebSocket5errorGSqCSo7NSError__T_":{"name":"websocketDidDisconnect(socket:error:)","abstract":"

    Delegate method for disconnection.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine10URLSessionFT7sessionCSo10URLSession25didBecomeInvalidWithErrorGSqCSo7NSError__T_":{"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":"

    The main class for SocketIOClientSwift.

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

    Experimental socket manager.

    "},"faq.html":{"name":"FAQ"},"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":"Enums","abstract":"

    The following enums are available globally.

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

    The following protocols are available globally.

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

    The following structs are available globally.

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

    The following typealiases 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.

    "},"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:8SocketIO0A21IOClientConfigurationV10startIndexSiv":{"name":"startIndex","abstract":"

    The start index of this collection.

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

    The end index of this collection.

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

    Whether this collection is empty.

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

    The number of elements stored in this collection.

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

    The first element in this collection.

    ","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationVACSayAA0aC6OptionOG12arrayLiterald_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/SocketIOClientConfiguration.html":{"name":"SocketIOClientConfiguration","abstract":"

    An array-like type that holds SocketIOClientOptions

    "},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP3logSbv":{"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/SocketData.html#/s:8SocketIO0A4DataP20socketRepresentationAaB_pyKF":{"name":"socketRepresentation()","abstract":"

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

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

    Sends an engine.io message through the WebSocket transport.

    ","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineWebsocket.html#/s:8SocketIO0A15EngineWebsocketPAAE26websocketDidReceiveMessagey010StarscreamaB003WebA0C6socket_SS4texttF":{"name":"websocketDidReceiveMessage(socket:text:)","abstract":"

    Delegate method for when a message is received.

    ","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineWebsocket.html#/s:8SocketIO0A15EngineWebsocketPAAE23websocketDidReceiveDatay010StarscreamaB003WebA0C6socket_10Foundation0H0V4datatF":{"name":"websocketDidReceiveData(socket:data:)","abstract":"

    Delegate method for when binary is received.

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

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

    A queue of engine.io messages waiting for POSTing

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

    The URLSession that will be used for polling.

    ","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP14waitingForPollSbv":{"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:8SocketIO0A14EnginePollableP14waitingForPostSbv":{"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)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/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)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/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/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.

    "},"Enums/SocketIOClientStatus.html#/c:@M@SocketIO@E@SocketIOClientStatus@SocketIOClientStatusNotConnected":{"name":"notConnected","abstract":"

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

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

    The client was once connected, but not anymore.

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

    The client is in the process of connecting.

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

    The client is currently connected.

    ","parent_name":"SocketIOClientStatus"},"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:8SocketIO0A14IOClientOptionO16doubleEncodeUTF8ACSbcACmF":{"name":"doubleEncodeUTF8","abstract":"

    Deprecated

    ","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:8SocketIO0A14IOClientOptionO3nspACSScACmF":{"name":"nsp","abstract":"

    The namespace that this client should connect to. Can be changed during use using the joinNamespace","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:8SocketIO0A14IOClientOptionO8securityAC010StarscreamaB011SSLSecurityCcACmF":{"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:8SocketIO0A14IOClientOptionO11voipEnabledACSbcACmF":{"name":"voipEnabled","abstract":"

    If passed true, the WebSocket transport will try and use voip logic to keep network connections open in","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO11descriptionSSv":{"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/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":"

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

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

    Called when an error occurs.

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

    Called when the client begins the reconnection process.

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

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

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

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

    ","parent_name":"SocketClientEvent"},"Enums/SocketAckStatus.html#/s:8SocketIO0A9AckStatusO02noC0A2CmF":{"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/SocketIOClientStatus.html":{"name":"SocketIOClientStatus","abstract":"

    Represents the state of the client.

    "},"Classes/SocketClientManager.html#/c:@M@SocketIO@objc(cs)SocketClientManager(cpy)sharedManager":{"name":"sharedManager","abstract":"

    The shared manager.

    ","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:8SocketIO0A13ClientManagerC9subscriptAA0A8IOClientCSgSSci":{"name":"subscript(_:)","abstract":"

    Gets a socket by its name.

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

    Adds a socket.

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

    Removes a socket by a given name.

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

    Removes a socket.

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

    Removes all the sockets in the manager.

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

    The engine for this client.

    ","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(py)forceNew":{"name":"forceNew","abstract":"

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

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(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":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)nsp":{"name":"nsp","abstract":"

    The namespace for this client.

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

    The configuration for this client.

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

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

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

    The number of seconds to wait before attempting to reconnect.

    ","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#/c:@M@SocketIO@objc(cs)SocketIOClient(py)socketURL":{"name":"socketURL","abstract":"

    The URL of the socket.io server.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientCAC10Foundation3URLV06socketE0_AA0aC13ConfigurationV6configtcfc":{"name":"init(socketURL:config:)","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)initWithSocketURL:config:":{"name":"init(socketURL:config:)","abstract":"

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

    Connect to the server.

    ","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#/c:@M@SocketIO@objc(cs)SocketIOClient(im)disconnect":{"name":"disconnect()","abstract":"

    Disconnects the socket.

    ","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC4emitySS_SayAA0A4Data_pGdtF":{"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_SayAA0A4Data_pGdtF":{"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#/c:@M@SocketIO@objc(cs)SocketIOClient(im)engineDidCloseWithReason:":{"name":"engineDidClose(reason:)","abstract":"

    Called when the engine closes.

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

    Called when the engine errors.

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

    Called when the engine opens.

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

    Causes an event to be handled, and any event handlers for that event to be called.

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

    Leaves nsp and goes back to the default namespace.

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

    Joins namespace.

    ","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)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"

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

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

    Called when the engine receives binary data.

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

    Tries to reconnect to the server.

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

    Removes all handlers.","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)expected":{"name":"expected","abstract":"

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

    ","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC4withySayAA0A4Data_pGd_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)postWait":{"name":"postWait","abstract":"

    A queue of engine.io messages waiting for POSTing

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)waitingForPoll":{"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#/c:@M@SocketIO@objc(cs)SocketEngine(py)waitingForPost":{"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)extraHeaders":{"name":"extraHeaders","abstract":"

    A dictionary of extra http headers that will be set during 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#/c:@M@SocketIO@objc(cs)SocketEngine(py)invalidated":{"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#/c:@M@SocketIO@objc(cs)SocketEngine(py)session":{"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#/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#/c:@M@SocketIO@objc(cs)SocketEngine(im)websocketDidConnectWithSocket:":{"name":"websocketDidConnect(socket:)","abstract":"

    Delegate method for connection.

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

    Delegate method for disconnection.

    ","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@CM@SocketIO@objc(cs)SocketEngine(im)URLSessionWithSession:didBecomeInvalidWithError:":{"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":"

    The main class for SocketIOClientSwift.

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

    Experimental socket manager.

    "},"faq.html":{"name":"FAQ"},"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":"Enums","abstract":"

    The following enums are available globally.

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

    The following protocols are available globally.

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

    The following structs are available globally.

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

    The following typealiases are available globally.

    "}} \ No newline at end of file