From 4929c8488c1687f4cefd85522638f00fcf993580 Mon Sep 17 00:00:00 2001 From: Erik Little Date: Thu, 31 Aug 2017 18:34:49 -0400 Subject: [PATCH] update docs --- docs/Classes.html | 66 +++++++------- docs/Classes/OnAckCallback.html | 2 +- docs/Classes/SocketAckEmitter.html | 2 +- docs/Classes/SocketAnyEvent.html | 2 +- docs/Classes/SocketClientManager.html | 2 +- docs/Classes/SocketEngine.html | 2 +- docs/Classes/SocketIOClient.html | 2 +- docs/Enums.html | 90 +++++++++---------- docs/Enums/SocketAckStatus.html | 2 +- docs/Enums/SocketClientEvent.html | 2 +- docs/Enums/SocketEnginePacketType.html | 2 +- docs/Enums/SocketIOClientOption.html | 2 +- docs/Enums/SocketIOClientStatus.html | 2 +- docs/Guides.html | 2 +- docs/Protocols.html | 90 +++++++++---------- docs/Protocols/SocketData.html | 2 +- docs/Protocols/SocketEngineClient.html | 2 +- docs/Protocols/SocketEnginePollable.html | 2 +- docs/Protocols/SocketEngineSpec.html | 2 +- docs/Protocols/SocketEngineWebsocket.html | 2 +- docs/Protocols/SocketLogger.html | 2 +- docs/Structs.html | 2 +- docs/Structs/SocketIOClientConfiguration.html | 2 +- docs/Typealiases.html | 2 +- docs/faq.html | 2 +- docs/index.html | 23 ++--- docs/search.json | 2 +- 27 files changed, 154 insertions(+), 161 deletions(-) diff --git a/docs/Classes.html b/docs/Classes.html index f9265bf..a84b0be 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -251,6 +251,38 @@ Example:

+
+ +
-
- -
diff --git a/docs/Classes/OnAckCallback.html b/docs/Classes/OnAckCallback.html index 031c948..dcfb711 100644 --- a/docs/Classes/OnAckCallback.html +++ b/docs/Classes/OnAckCallback.html @@ -239,7 +239,7 @@ Example:

diff --git a/docs/Classes/SocketAckEmitter.html b/docs/Classes/SocketAckEmitter.html index 55ecd06..a8133a3 100644 --- a/docs/Classes/SocketAckEmitter.html +++ b/docs/Classes/SocketAckEmitter.html @@ -309,7 +309,7 @@ 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 8a4f87c..0b37946 100644 --- a/docs/Classes/SocketAnyEvent.html +++ b/docs/Classes/SocketAnyEvent.html @@ -255,7 +255,7 @@ diff --git a/docs/Classes/SocketClientManager.html b/docs/Classes/SocketClientManager.html index b27c8f7..a18248b 100644 --- a/docs/Classes/SocketClientManager.html +++ b/docs/Classes/SocketClientManager.html @@ -443,7 +443,7 @@ manager["room1"]?.emit("hello") diff --git a/docs/Classes/SocketEngine.html b/docs/Classes/SocketEngine.html index 6a994fd..96ffdf5 100644 --- a/docs/Classes/SocketEngine.html +++ b/docs/Classes/SocketEngine.html @@ -1433,7 +1433,7 @@ 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 94f558e..7111bf1 100644 --- a/docs/Classes/SocketIOClient.html +++ b/docs/Classes/SocketIOClient.html @@ -1856,7 +1856,7 @@ Can be used after disconnecting to break any potential remaining retain cycles.< diff --git a/docs/Enums.html b/docs/Enums.html index ddcfe44..94f7c7e 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -155,9 +155,9 @@
  • - - - SocketClientEvent + + + SocketEnginePacketType
    @@ -165,47 +165,15 @@
    -

    The set of events that are generated by the client.

    +

    Represents the type of engine.io packet types.

    - See more + See more

    Declaration

    Swift

    -
    public enum SocketClientEvent : String
    - -
    -
    -
    -
    -
  • - - -
    -
      -
    • -
      - - - - SocketIOClientStatus - -
      -
      -
      -
      -
      -
      -

      Represents the state of the client.

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      @objc public enum SocketIOClientStatus : Int
      +
      @objc public enum SocketEnginePacketType : Int
      @@ -251,9 +219,9 @@
    • @@ -261,15 +229,15 @@
      -

      Represents the type of engine.io packet types.

      +

      The set of events that are generated by the client.

      - See more + See more

      Declaration

      Swift

      -
      @objc public enum SocketEnginePacketType : Int
      +
      public enum SocketClientEvent : String
      @@ -310,13 +278,45 @@
    +
    +
      +
    • +
      + + + + SocketIOClientStatus + +
      +
      +
      +
      +
      +
      +

      Represents the state of the client.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      +
      @objc public enum SocketIOClientStatus : Int
      + +
      +
      +
      +
      +
    • +
    +
    diff --git a/docs/Enums/SocketAckStatus.html b/docs/Enums/SocketAckStatus.html index bf77598..cea1b53 100644 --- a/docs/Enums/SocketAckStatus.html +++ b/docs/Enums/SocketAckStatus.html @@ -194,7 +194,7 @@ diff --git a/docs/Enums/SocketClientEvent.html b/docs/Enums/SocketClientEvent.html index c8f0bf6..c3bde2d 100644 --- a/docs/Enums/SocketClientEvent.html +++ b/docs/Enums/SocketClientEvent.html @@ -355,7 +355,7 @@ data item: the namespace that was connected to.

    diff --git a/docs/Enums/SocketEnginePacketType.html b/docs/Enums/SocketEnginePacketType.html index 92d36a1..5b0f7a4 100644 --- a/docs/Enums/SocketEnginePacketType.html +++ b/docs/Enums/SocketEnginePacketType.html @@ -380,7 +380,7 @@ diff --git a/docs/Enums/SocketIOClientOption.html b/docs/Enums/SocketIOClientOption.html index 9b023df..2cae078 100644 --- a/docs/Enums/SocketIOClientOption.html +++ b/docs/Enums/SocketIOClientOption.html @@ -930,7 +930,7 @@ the background. This option is experimental as socket.io shouldn’t diff --git a/docs/Enums/SocketIOClientStatus.html b/docs/Enums/SocketIOClientStatus.html index ba4371a..5bffb03 100644 --- a/docs/Enums/SocketIOClientStatus.html +++ b/docs/Enums/SocketIOClientStatus.html @@ -287,7 +287,7 @@ diff --git a/docs/Guides.html b/docs/Guides.html index a7eff9f..6cb35e2 100644 --- a/docs/Guides.html +++ b/docs/Guides.html @@ -156,7 +156,7 @@ diff --git a/docs/Protocols.html b/docs/Protocols.html index 55697e9..2f772d7 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -155,9 +155,9 @@
  • - - - SocketEngineWebsocket + + + SocketEngineSpec
    @@ -165,15 +165,47 @@
    -

    Protocol that is used to implement socket.io WebSocket support

    +

    Specifies a SocketEngine.

    - See more + See more

    Declaration

    Swift

    -
    public protocol SocketEngineWebsocket : SocketEngineSpec, WebSocketDelegate
    +
    @objc public protocol SocketEngineSpec
    + +
    +
    +
    +
    +
  • + + +
    +
      +
    • +
      + + + + SocketEngineClient + +
      +
      +
      +
      +
      +
      +

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

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      +
      @objc public protocol SocketEngineClient
      @@ -219,9 +251,9 @@
    • @@ -229,15 +261,15 @@
      -

      Specifies a SocketEngine.

      +

      Protocol that is used to implement socket.io WebSocket support

      - See more + See more

      Declaration

      Swift

      -
      @objc public protocol SocketEngineSpec
      +
      public protocol SocketEngineWebsocket : SocketEngineSpec, WebSocketDelegate
      @@ -323,45 +355,13 @@
    -
    -
      -
    • -
      - - - - SocketEngineClient - -
      -
      -
      -
      -
      -
      -

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

      - - See more -
      -
      -

      Declaration

      -
      -

      Swift

      -
      @objc public protocol SocketEngineClient
      - -
      -
      -
      -
      -
    • -
    -
    diff --git a/docs/Protocols/SocketData.html b/docs/Protocols/SocketData.html index 77b98ae..6acbc63 100644 --- a/docs/Protocols/SocketData.html +++ b/docs/Protocols/SocketData.html @@ -222,7 +222,7 @@ diff --git a/docs/Protocols/SocketEngineClient.html b/docs/Protocols/SocketEngineClient.html index fe33edc..6bec86c 100644 --- a/docs/Protocols/SocketEngineClient.html +++ b/docs/Protocols/SocketEngineClient.html @@ -404,7 +404,7 @@ diff --git a/docs/Protocols/SocketEnginePollable.html b/docs/Protocols/SocketEnginePollable.html index 5cd511d..d935e09 100644 --- a/docs/Protocols/SocketEnginePollable.html +++ b/docs/Protocols/SocketEnginePollable.html @@ -467,7 +467,7 @@ disconnect us.

    diff --git a/docs/Protocols/SocketEngineSpec.html b/docs/Protocols/SocketEngineSpec.html index 079b5da..979bae3 100644 --- a/docs/Protocols/SocketEngineSpec.html +++ b/docs/Protocols/SocketEngineSpec.html @@ -1058,7 +1058,7 @@ 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 4ac43a4..133a5cc 100644 --- a/docs/Protocols/SocketEngineWebsocket.html +++ b/docs/Protocols/SocketEngineWebsocket.html @@ -320,7 +320,7 @@ diff --git a/docs/Protocols/SocketLogger.html b/docs/Protocols/SocketLogger.html index f22cc4c..5d11f65 100644 --- a/docs/Protocols/SocketLogger.html +++ b/docs/Protocols/SocketLogger.html @@ -368,7 +368,7 @@ diff --git a/docs/Structs.html b/docs/Structs.html index 3b54099..e66c066 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -188,7 +188,7 @@ diff --git a/docs/Structs/SocketIOClientConfiguration.html b/docs/Structs/SocketIOClientConfiguration.html index 15b4138..23f8980 100644 --- a/docs/Structs/SocketIOClientConfiguration.html +++ b/docs/Structs/SocketIOClientConfiguration.html @@ -615,7 +615,7 @@ diff --git a/docs/Typealiases.html b/docs/Typealiases.html index 19cd538..a2ac224 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -214,7 +214,7 @@ diff --git a/docs/faq.html b/docs/faq.html index f77fa34..8b1d759 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -190,7 +190,7 @@ will be released and its memory reclaimed.

    diff --git a/docs/index.html b/docs/index.html index 614b9c8..c25b764 100644 --- a/docs/index.html +++ b/docs/index.html @@ -208,13 +208,13 @@ SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{

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

    -

    If you need swift 2.2 use 7.x (Pre-Swift 3 support is no longer maintained)

    +

    If you need swift 2.2 use 7.x.

    -

    If you need Swift 2.1 use v5.5.0 (Pre-Swift 2.2 support is no longer maintained)

    +

    If you need Swift 2.1 use v5.5.0.

    -

    If you need Swift 1.2 use v2.4.5 (Pre-Swift 2 support is no longer maintained)

    +

    If you need Swift 1.2 use v2.4.5.

    -

    If you need Swift 1.1 use v1.5.2. (Pre-Swift 1.2 support is no longer maintained)

    +

    If you need Swift 1.1 use v1.5.2.

    Swift Package Manager

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

    @@ -232,8 +232,8 @@ SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{

    Carthage

    Add these line to your Cartfile:

    -
    github "nuclearace/Starscream" ~> 8.0.2
    -github "socketio/socket.io-client-swift" ~> 11.1.0 # Or latest version
    +
    github "nuclearace/Starscream" ~> 8.0.5
    +github "socketio/socket.io-client-swift" ~> 11.1.2 # Or latest version
     

    Run carthage update --platform ios,macosx.

    @@ -243,7 +243,7 @@ github "socketio/socket.io-client-swift" ~> 11.1.0 # Or latest version
    use_frameworks!
     
     target 'YourApp' do
    -    pod 'Socket.IO-Client-Swift', '~> 11.1.0' # Or latest version
    +    pod 'Socket.IO-Client-Swift', '~> 11.1.2' # Or latest version
     end
     
    @@ -260,13 +260,6 @@ github "socketio/socket.io-client-swift" ~> 11.1.0 # Or latest version

    Objective-C:

    @import SocketIO;
     
    -

    CocoaSeeds

    - -

    Add this line to your Seedfile:

    -
    github "socketio/socket.io-client-swift", "v11.1.0", :files => "Source/*.swift" # Or latest version
    -
    - -

    Run seed install.

    Docs

      @@ -290,7 +283,7 @@ github "socketio/socket.io-client-swift" ~> 11.1.0 # Or latest version diff --git a/docs/search.json b/docs/search.json index dd843d3..00a88cb 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/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/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/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec6clientXwGSqPS_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/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/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/SocketEngineWebsocket.html":{"name":"SocketEngineWebsocket","abstract":"

      Protocol that is used to implement socket.io WebSocket support

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

      Protocol that is used to implement socket.io polling support

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

      Specifies a SocketEngine.

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

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

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

      Represents a class will log client events.

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

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

      "},"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/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/SocketAckStatus.html#/s:FO8SocketIO15SocketAckStatus5noAckFMS0_S0_":{"name":"noAck","abstract":"

      The ack timed out.

      ","parent_name":"SocketAckStatus"},"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/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/SocketClientEvent.html":{"name":"SocketClientEvent","abstract":"

      The set of events that are generated by the client.

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

      Represents the state of the client.

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

      The status of an ack.

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

      Represents the type of engine.io packet types.

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

      The options for a 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/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/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/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/SocketIOClient.html":{"name":"SocketIOClient","abstract":"

      The main class for SocketIOClientSwift.

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

      Represents some event that was received.

      "},"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: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:vP8SocketIO16SocketEngineSpec6clientXwGSqPS_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