From f2ab06f73219a90c0d425ffbdad22804b81af490 Mon Sep 17 00:00:00 2001 From: Erik Little Date: Mon, 15 May 2017 08:21:14 -0400 Subject: [PATCH] update docs --- docs/Classes.html | 4 +- docs/Classes/OnAckCallback.html | 6 +- docs/Classes/SSLCert.html | 4 +- docs/Classes/SSLSecurity.html | 4 +- docs/Classes/SocketAckEmitter.html | 7 +- docs/Classes/SocketAnyEvent.html | 4 +- docs/Classes/SocketClientManager.html | 58 ++++----- docs/Classes/SocketEngine.html | 4 +- docs/Classes/SocketIOClient.html | 12 +- docs/Classes/WebSocket.html | 4 +- docs/Classes/WebSocket/CloseCode.html | 4 +- docs/Enums.html | 4 +- docs/Enums/SocketAckStatus.html | 4 +- docs/Enums/SocketClientEvent.html | 4 +- docs/Enums/SocketEnginePacketType.html | 4 +- docs/Enums/SocketIOClientOption.html | 4 +- docs/Enums/SocketIOClientStatus.html | 4 +- docs/Global Variables.html | 4 +- docs/Protocols.html | 4 +- docs/Protocols/SSLTrustValidator.html | 4 +- docs/Protocols/SocketData.html | 4 +- docs/Protocols/SocketEngineClient.html | 4 +- docs/Protocols/SocketEnginePollable.html | 4 +- docs/Protocols/SocketEngineSpec.html | 4 +- docs/Protocols/SocketEngineWebsocket.html | 4 +- docs/Protocols/SocketLogger.html | 4 +- docs/Protocols/WebSocketDelegate.html | 4 +- docs/Protocols/WebSocketPongDelegate.html | 4 +- docs/Structs.html | 4 +- docs/Structs/SocketIOClientConfiguration.html | 112 +++++++++--------- docs/Typealiases.html | 58 ++++----- docs/index.html | 4 +- docs/search.json | 2 +- 33 files changed, 184 insertions(+), 175 deletions(-) diff --git a/docs/Classes.html b/docs/Classes.html index 612bf90..77bceed 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -465,8 +465,8 @@ manager["room1"]?.emit("hello") diff --git a/docs/Classes/OnAckCallback.html b/docs/Classes/OnAckCallback.html index 4ec3397..1f1282c 100644 --- a/docs/Classes/OnAckCallback.html +++ b/docs/Classes/OnAckCallback.html @@ -248,7 +248,7 @@ Example:

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

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

@@ -266,8 +266,8 @@ Example:

diff --git a/docs/Classes/SSLCert.html b/docs/Classes/SSLCert.html index 604af3f..ff78dea 100644 --- a/docs/Classes/SSLCert.html +++ b/docs/Classes/SSLCert.html @@ -288,8 +288,8 @@ diff --git a/docs/Classes/SSLSecurity.html b/docs/Classes/SSLSecurity.html index 88d5363..8b75bb8 100644 --- a/docs/Classes/SSLSecurity.html +++ b/docs/Classes/SSLSecurity.html @@ -381,8 +381,8 @@ diff --git a/docs/Classes/SocketAckEmitter.html b/docs/Classes/SocketAckEmitter.html index 0cc8077..c36386a 100644 --- a/docs/Classes/SocketAckEmitter.html +++ b/docs/Classes/SocketAckEmitter.html @@ -248,6 +248,9 @@

Call to ack receiving this event.

+

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

+

Declaration

@@ -333,8 +336,8 @@
diff --git a/docs/Classes/SocketAnyEvent.html b/docs/Classes/SocketAnyEvent.html index d58cfb6..b4c4ce4 100644 --- a/docs/Classes/SocketAnyEvent.html +++ b/docs/Classes/SocketAnyEvent.html @@ -282,8 +282,8 @@ diff --git a/docs/Classes/SocketClientManager.html b/docs/Classes/SocketClientManager.html index 8010d43..30682ff 100644 --- a/docs/Classes/SocketClientManager.html +++ b/docs/Classes/SocketClientManager.html @@ -208,6 +208,33 @@ manager["room1"]?.emit("hello")
@@ -470,8 +470,8 @@ manager["room1"]?.emit("hello")
diff --git a/docs/Classes/SocketEngine.html b/docs/Classes/SocketEngine.html index 4cd7d81..55bdbf3 100644 --- a/docs/Classes/SocketEngine.html +++ b/docs/Classes/SocketEngine.html @@ -1461,8 +1461,8 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

diff --git a/docs/Classes/SocketIOClient.html b/docs/Classes/SocketIOClient.html index 07692dd..6a96766 100644 --- a/docs/Classes/SocketIOClient.html +++ b/docs/Classes/SocketIOClient.html @@ -733,6 +733,9 @@ If using Swift it’s recommended to use init(socketURL: NSURL, option

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

+

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

+

Declaration

@@ -852,6 +855,9 @@ If using Swift it’s recommended to use init(socketURL: NSURL, option

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

+

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

+

Example:

socket.emitWithAck("myEvent", 1).timingOut(after: 1) {data in
     ...
@@ -1286,7 +1292,7 @@ Check that your server’s api will ack the event being sent.

Removes handler(s) based on an event name.

-

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

+

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

@@ -1762,8 +1768,8 @@ Can be used after disconnecting to break any potential remaining retain cycles.<
diff --git a/docs/Classes/WebSocket.html b/docs/Classes/WebSocket.html index fab5bdb..ceb437e 100644 --- a/docs/Classes/WebSocket.html +++ b/docs/Classes/WebSocket.html @@ -906,8 +906,8 @@ Yodel a sound to the planet. This sends it as an astroid. -

© 2017 Erik. All rights reserved. (Last updated: 2017-05-07)

-

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

+

© 2017 Erik. All rights reserved. (Last updated: 2017-05-15)

+

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

diff --git a/docs/Classes/WebSocket/CloseCode.html b/docs/Classes/WebSocket/CloseCode.html index 9704545..9911251 100644 --- a/docs/Classes/WebSocket/CloseCode.html +++ b/docs/Classes/WebSocket/CloseCode.html @@ -368,8 +368,8 @@ diff --git a/docs/Enums.html b/docs/Enums.html index 7409db0..d324ced 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -343,8 +343,8 @@ diff --git a/docs/Enums/SocketAckStatus.html b/docs/Enums/SocketAckStatus.html index 6e82150..c5182a0 100644 --- a/docs/Enums/SocketAckStatus.html +++ b/docs/Enums/SocketAckStatus.html @@ -221,8 +221,8 @@ diff --git a/docs/Enums/SocketClientEvent.html b/docs/Enums/SocketClientEvent.html index 0e4a374..e748246 100644 --- a/docs/Enums/SocketClientEvent.html +++ b/docs/Enums/SocketClientEvent.html @@ -376,8 +376,8 @@ diff --git a/docs/Enums/SocketEnginePacketType.html b/docs/Enums/SocketEnginePacketType.html index 6c22f03..34b350f 100644 --- a/docs/Enums/SocketEnginePacketType.html +++ b/docs/Enums/SocketEnginePacketType.html @@ -407,8 +407,8 @@ diff --git a/docs/Enums/SocketIOClientOption.html b/docs/Enums/SocketIOClientOption.html index afaee62..bcea4ab 100644 --- a/docs/Enums/SocketIOClientOption.html +++ b/docs/Enums/SocketIOClientOption.html @@ -927,8 +927,8 @@ the background. This option is experimental as socket.io shouldn’t diff --git a/docs/Enums/SocketIOClientStatus.html b/docs/Enums/SocketIOClientStatus.html index b85db67..b827d9b 100644 --- a/docs/Enums/SocketIOClientStatus.html +++ b/docs/Enums/SocketIOClientStatus.html @@ -314,8 +314,8 @@ diff --git a/docs/Global Variables.html b/docs/Global Variables.html index e856abd..1257849 100644 --- a/docs/Global Variables.html +++ b/docs/Global Variables.html @@ -244,8 +244,8 @@ diff --git a/docs/Protocols.html b/docs/Protocols.html index b3c141c..2f2e2d9 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -456,8 +456,8 @@ diff --git a/docs/Protocols/SSLTrustValidator.html b/docs/Protocols/SSLTrustValidator.html index 892e0f4..184c4c2 100644 --- a/docs/Protocols/SSLTrustValidator.html +++ b/docs/Protocols/SSLTrustValidator.html @@ -207,8 +207,8 @@ diff --git a/docs/Protocols/SocketData.html b/docs/Protocols/SocketData.html index 04d01d0..cfb61b3 100644 --- a/docs/Protocols/SocketData.html +++ b/docs/Protocols/SocketData.html @@ -249,8 +249,8 @@ diff --git a/docs/Protocols/SocketEngineClient.html b/docs/Protocols/SocketEngineClient.html index 191f9a2..0ba9fb6 100644 --- a/docs/Protocols/SocketEngineClient.html +++ b/docs/Protocols/SocketEngineClient.html @@ -431,8 +431,8 @@ diff --git a/docs/Protocols/SocketEnginePollable.html b/docs/Protocols/SocketEnginePollable.html index af27187..a993c4d 100644 --- a/docs/Protocols/SocketEnginePollable.html +++ b/docs/Protocols/SocketEnginePollable.html @@ -494,8 +494,8 @@ disconnect us.

diff --git a/docs/Protocols/SocketEngineSpec.html b/docs/Protocols/SocketEngineSpec.html index 3ae0b5a..4343d88 100644 --- a/docs/Protocols/SocketEngineSpec.html +++ b/docs/Protocols/SocketEngineSpec.html @@ -1113,8 +1113,8 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

diff --git a/docs/Protocols/SocketEngineWebsocket.html b/docs/Protocols/SocketEngineWebsocket.html index b715cbd..eb81118 100644 --- a/docs/Protocols/SocketEngineWebsocket.html +++ b/docs/Protocols/SocketEngineWebsocket.html @@ -347,8 +347,8 @@ diff --git a/docs/Protocols/SocketLogger.html b/docs/Protocols/SocketLogger.html index 90247b6..4173ef4 100644 --- a/docs/Protocols/SocketLogger.html +++ b/docs/Protocols/SocketLogger.html @@ -395,8 +395,8 @@ diff --git a/docs/Protocols/WebSocketDelegate.html b/docs/Protocols/WebSocketDelegate.html index 38134d9..090192a 100644 --- a/docs/Protocols/WebSocketDelegate.html +++ b/docs/Protocols/WebSocketDelegate.html @@ -264,8 +264,8 @@ diff --git a/docs/Protocols/WebSocketPongDelegate.html b/docs/Protocols/WebSocketPongDelegate.html index 1ef18c9..bf15415 100644 --- a/docs/Protocols/WebSocketPongDelegate.html +++ b/docs/Protocols/WebSocketPongDelegate.html @@ -207,8 +207,8 @@ diff --git a/docs/Structs.html b/docs/Structs.html index d4a2ed7..5a2bb23 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -215,8 +215,8 @@ diff --git a/docs/Structs/SocketIOClientConfiguration.html b/docs/Structs/SocketIOClientConfiguration.html index c9d056f..41b4f82 100644 --- a/docs/Structs/SocketIOClientConfiguration.html +++ b/docs/Structs/SocketIOClientConfiguration.html @@ -193,33 +193,6 @@
    -
  • -
    - - - - Iterator - -
    -
    -
    -
    -
    -
    -

    Iterator type.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public typealias Iterator = Array<SocketIOClientOption>.Iterator
    - -
    -
    -
    -
    -
  • @@ -247,33 +220,6 @@
  • -
  • -
    - - - - SubSequence - -
    -
    -
    -
    -
    -
    -

    SubSequence type.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public typealias SubSequence =  Array<SocketIOClientOption>.SubSequence
    - -
    -
    -
    -
    -
  • @@ -301,6 +247,60 @@
  • +
  • +
    + + + + Iterator + +
    +
    +
    +
    +
    +
    +

    Iterator type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    SubSequence type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public typealias SubSequence =  Array<SocketIOClientOption>.SubSequence
    + +
    +
    +
    +
    +
@@ -642,8 +642,8 @@
diff --git a/docs/Typealiases.html b/docs/Typealiases.html index 70bb7e8..7872159 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -179,33 +179,6 @@
    -
  • -
    - - - - NormalCallback - -
    -
    -
    -
    -
    -
    -

    A typealias for a normal callback.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public typealias NormalCallback = ([Any], SocketAckEmitter) -> Void
    - -
    -
    -
    -
    -
  • @@ -233,6 +206,33 @@
  • +
  • +
    + + + + NormalCallback + +
    +
    +
    +
    +
    +
    +

    A typealias for a normal callback.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public typealias NormalCallback = ([Any], SocketAckEmitter) -> Void
    + +
    +
    +
    +
    +
@@ -241,8 +241,8 @@ diff --git a/docs/index.html b/docs/index.html index 8f67731..4ba06f4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -319,8 +319,8 @@ SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{ diff --git a/docs/search.json b/docs/search.json index ae79f8a..e191bd5 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -{"Typealiases.html#/s:8SocketIO14NormalCallback":{"name":"NormalCallback","abstract":"

A typealias for a normal callback.

"},"Typealiases.html#/s:8SocketIO11AckCallback":{"name":"AckCallback","abstract":"

A typealias for an ack 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/SSLTrustValidator.html#/s:FP8SocketIO17SSLTrustValidator7isValidFTCSo8SecTrust6domainGSqSS__Sb":{"name":"isValid(_:domain:)","abstract":"

Undocumented

","parent_name":"SSLTrustValidator"},"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/WebSocketPongDelegate.html#/s:FP8SocketIO21WebSocketPongDelegate23websocketDidReceivePongFT6socketCS_9WebSocket4dataGSqV10Foundation4Data__T_":{"name":"websocketDidReceivePong(socket:data:)","abstract":"

Undocumented

","parent_name":"WebSocketPongDelegate"},"Protocols/WebSocketDelegate.html#/s:FP8SocketIO17WebSocketDelegate19websocketDidConnectFT6socketCS_9WebSocket_T_":{"name":"websocketDidConnect(socket:)","abstract":"

Undocumented

","parent_name":"WebSocketDelegate"},"Protocols/WebSocketDelegate.html#/s:FP8SocketIO17WebSocketDelegate22websocketDidDisconnectFT6socketCS_9WebSocket5errorGSqCSo7NSError__T_":{"name":"websocketDidDisconnect(socket:error:)","abstract":"

Undocumented

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

Undocumented

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

Undocumented

","parent_name":"WebSocketDelegate"},"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:vP8SocketIO16SocketEngineSpec16doubleEncodeUTF8Sb":{"name":"doubleEncodeUTF8","abstract":"

Set to true if using the node.js version of socket.io. The node.js version of socket.io","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:vP8SocketIO16SocketEngineSpec2wsGSqCS_9WebSocket_":{"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:FP8SocketIO16SocketEngineSpec18parseEngineMessageFTSS11fromPollingSb_T_":{"name":"parseEngineMessage(_:fromPolling:)","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_21SocketEngineWebsocket26websocketDidReceiveMessageFT6socketCS_9WebSocket4textSS_T_":{"name":"websocketDidReceiveMessage(socket:text:)","abstract":"

Delegate method for when a message is received.

","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineWebsocket.html#/s:FE8SocketIOPS_21SocketEngineWebsocket23websocketDidReceiveDataFT6socketCS_9WebSocket4dataV10Foundation4Data_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/WebSocketDelegate.html":{"name":"WebSocketDelegate","abstract":"

Undocumented

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

Undocumented

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

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

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

Undocumented

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

The node.js socket.io currently does funky things to unicode when doing HTTP long-polling. Passing true in","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_FCS_11SSLSecurityS0_":{"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.

","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.

"},"Global Variables.html#/s:v8SocketIO31WebsocketDidConnectNotificationSS":{"name":"WebsocketDidConnectNotification","abstract":"

Undocumented

"},"Global Variables.html#/s:v8SocketIO34WebsocketDidDisconnectNotificationSS":{"name":"WebsocketDidDisconnectNotification","abstract":"

Undocumented

"},"Global Variables.html#/s:v8SocketIO34WebsocketDisconnectionErrorKeyNameSS":{"name":"WebsocketDisconnectionErrorKeyName","abstract":"

Undocumented

"},"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/SSLSecurity.html#/s:vC8SocketIO11SSLSecurity11validatedDNSb":{"name":"validatedDN","abstract":"

Undocumented

","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:FC8SocketIO11SSLSecuritycFT13usePublicKeysSb_S0_":{"name":"init(usePublicKeys:)","abstract":"

Use certs from main app bundle

","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:FC8SocketIO11SSLSecuritycFT5certsGSaCS_7SSLCert_13usePublicKeysSb_S0_":{"name":"init(certs:usePublicKeys:)","abstract":"

Designated init

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

Valid the trust and domain name.

","parent_name":"SSLSecurity"},"Classes/SSLCert.html#/s:FC8SocketIO7SSLCertcFT4dataV10Foundation4Data_S0_":{"name":"init(data:)","abstract":"

Designated init for certificates

","parent_name":"SSLCert"},"Classes/SSLCert.html#/s:FC8SocketIO7SSLCertcFT3keyCSo6SecKey_S0_":{"name":"init(key:)","abstract":"

Designated init for public keys

","parent_name":"SSLCert"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode6normalFMS1_S1_":{"name":"normal","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode9goingAwayFMS1_S1_":{"name":"goingAway","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode13protocolErrorFMS1_S1_":{"name":"protocolError","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode21protocolUnhandledTypeFMS1_S1_":{"name":"protocolUnhandledType","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode16noStatusReceivedFMS1_S1_":{"name":"noStatusReceived","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode8encodingFMS1_S1_":{"name":"encoding","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode14policyViolatedFMS1_S1_":{"name":"policyViolated","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode13messageTooBigFMS1_S1_":{"name":"messageTooBig","abstract":"

Undocumented

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

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:ZvC8SocketIO9WebSocket11ErrorDomainSS":{"name":"ErrorDomain","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket13callbackQueueCSo13DispatchQueue":{"name":"callbackQueue","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket8delegateXwGSqPS_17WebSocketDelegate__":{"name":"delegate","abstract":"

Responds to callback about new messages coming in over the WebSocket","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket12pongDelegateXwGSqPS_21WebSocketPongDelegate__":{"name":"pongDelegate","abstract":"

Receives a callback for each pong message recived.

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket9onConnectGSqFT_T__":{"name":"onConnect","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket12onDisconnectGSqFGSqCSo7NSError_T__":{"name":"onDisconnect","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6onTextGSqFSST__":{"name":"onText","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6onDataGSqFV10Foundation4DataT__":{"name":"onData","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6onPongGSqFGSqV10Foundation4Data_T__":{"name":"onPong","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket7headersGVs10DictionarySSSS_":{"name":"headers","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket11voipEnabledSb":{"name":"voipEnabled","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket24disableSSLCertValidationSb":{"name":"disableSSLCertValidation","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket8securityGSqPS_17SSLTrustValidator__":{"name":"security","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket22enabledSSLCipherSuitesGSqGSaVs6UInt32__":{"name":"enabledSSLCipherSuites","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6originGSqSS_":{"name":"origin","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket7timeoutSi":{"name":"timeout","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket11isConnectedSb":{"name":"isConnected","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket10currentURLV10Foundation3URL":{"name":"currentURL","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocketcFT3urlV10Foundation3URL9protocolsGSqGSaSS___S0_":{"name":"init(url:protocols:)","abstract":"

Used for setting protocols.

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocketcFT3urlV10Foundation3URL13writeQueueQOSOSC16QualityOfService9protocolsGSqGSaSS___S0_":{"name":"init(url:writeQueueQOS:protocols:)","abstract":"

Undocumented

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

Connect to the WebSocket server on a background thread.

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket10disconnectFT12forceTimeoutGSqSd_9closeCodeVs6UInt16_T_":{"name":"disconnect(forceTimeout:closeCode:)","abstract":"

Disconnect from the server. I send a Close control frame to the server, then expect the server to respond with a Close control frame and close the socket from its end. I notify my delegate once the socket has been closed.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket5writeFT6stringSS10completionGSqFT_T___T_":{"name":"write(string:completion:)","abstract":"

Write a string to the websocket. This sends it as a text frame.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket5writeFT4dataV10Foundation4Data10completionGSqFT_T___T_":{"name":"write(data:completion:)","abstract":"

Write binary data to the websocket. This sends it as a binary frame.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket5writeFT4pingV10Foundation4Data10completionGSqFT_T___T_":{"name":"write(ping:completion:)","abstract":"

Write a ping to the websocket. This sends it as a control frame.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket6streamFTCSo6Stream6handleVS1_5Event_T_":{"name":"stream(_:handle:)","abstract":"

Delegate for the stream methods. Processes incoming bytes

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

The URL of the socket.io server. This is set in the initializer.

","parent_name":"SocketIOClient"},"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: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:FC8SocketIO14SocketIOClient7connectFT12timeoutAfterSi11withHandlerGSqFT_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: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: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:FC8SocketIO13OnAckCallback9timingOutFT5afterSi8callbackFGSaP__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: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:vC8SocketIO12SocketEngine16doubleEncodeUTF8Sb":{"name":"doubleEncodeUTF8","abstract":"

Set to true if using the node.js version of socket.io. The node.js version of socket.io","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:vC8SocketIO12SocketEngine2wsGSqCS_9WebSocket_":{"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:FC8SocketIO12SocketEngine18parseEngineMessageFTSS11fromPollingSb_T_":{"name":"parseEngineMessage(_:fromPolling:)","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:FC8SocketIO12SocketEngine19websocketDidConnectFT6socketCS_9WebSocket_T_":{"name":"websocketDidConnect(socket:)","abstract":"

Delegate method for connection.

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

Undocumented

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

Undocumented

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

Undocumented

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

Represents some event that was received.

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

Experimental socket manager.

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

The following classes are available globally.

"},"Global Variables.html":{"name":"Global Variables","abstract":"

The following global variables 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:V8SocketIO27SocketIOClientConfiguration7Element":{"name":"Element","abstract":"

Type of element stored.

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

Index type.

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

Iterator type.

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

SubSequence 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/SSLTrustValidator.html#/s:FP8SocketIO17SSLTrustValidator7isValidFTCSo8SecTrust6domainGSqSS__Sb":{"name":"isValid(_:domain:)","abstract":"

Undocumented

","parent_name":"SSLTrustValidator"},"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/WebSocketPongDelegate.html#/s:FP8SocketIO21WebSocketPongDelegate23websocketDidReceivePongFT6socketCS_9WebSocket4dataGSqV10Foundation4Data__T_":{"name":"websocketDidReceivePong(socket:data:)","abstract":"

Undocumented

","parent_name":"WebSocketPongDelegate"},"Protocols/WebSocketDelegate.html#/s:FP8SocketIO17WebSocketDelegate19websocketDidConnectFT6socketCS_9WebSocket_T_":{"name":"websocketDidConnect(socket:)","abstract":"

Undocumented

","parent_name":"WebSocketDelegate"},"Protocols/WebSocketDelegate.html#/s:FP8SocketIO17WebSocketDelegate22websocketDidDisconnectFT6socketCS_9WebSocket5errorGSqCSo7NSError__T_":{"name":"websocketDidDisconnect(socket:error:)","abstract":"

Undocumented

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

Undocumented

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

Undocumented

","parent_name":"WebSocketDelegate"},"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:vP8SocketIO16SocketEngineSpec16doubleEncodeUTF8Sb":{"name":"doubleEncodeUTF8","abstract":"

Set to true if using the node.js version of socket.io. The node.js version of socket.io","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:vP8SocketIO16SocketEngineSpec2wsGSqCS_9WebSocket_":{"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:FP8SocketIO16SocketEngineSpec18parseEngineMessageFTSS11fromPollingSb_T_":{"name":"parseEngineMessage(_:fromPolling:)","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_21SocketEngineWebsocket26websocketDidReceiveMessageFT6socketCS_9WebSocket4textSS_T_":{"name":"websocketDidReceiveMessage(socket:text:)","abstract":"

Delegate method for when a message is received.

","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineWebsocket.html#/s:FE8SocketIOPS_21SocketEngineWebsocket23websocketDidReceiveDataFT6socketCS_9WebSocket4dataV10Foundation4Data_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/WebSocketDelegate.html":{"name":"WebSocketDelegate","abstract":"

Undocumented

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

Undocumented

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

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

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

Undocumented

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

The node.js socket.io currently does funky things to unicode when doing HTTP long-polling. Passing true in","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_FCS_11SSLSecurityS0_":{"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.

","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.

"},"Global Variables.html#/s:v8SocketIO31WebsocketDidConnectNotificationSS":{"name":"WebsocketDidConnectNotification","abstract":"

Undocumented

"},"Global Variables.html#/s:v8SocketIO34WebsocketDidDisconnectNotificationSS":{"name":"WebsocketDidDisconnectNotification","abstract":"

Undocumented

"},"Global Variables.html#/s:v8SocketIO34WebsocketDisconnectionErrorKeyNameSS":{"name":"WebsocketDisconnectionErrorKeyName","abstract":"

Undocumented

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

The shared manager.

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

Gets a socket by its name.

","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/SSLSecurity.html#/s:vC8SocketIO11SSLSecurity11validatedDNSb":{"name":"validatedDN","abstract":"

Undocumented

","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:FC8SocketIO11SSLSecuritycFT13usePublicKeysSb_S0_":{"name":"init(usePublicKeys:)","abstract":"

Use certs from main app bundle

","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:FC8SocketIO11SSLSecuritycFT5certsGSaCS_7SSLCert_13usePublicKeysSb_S0_":{"name":"init(certs:usePublicKeys:)","abstract":"

Designated init

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

Valid the trust and domain name.

","parent_name":"SSLSecurity"},"Classes/SSLCert.html#/s:FC8SocketIO7SSLCertcFT4dataV10Foundation4Data_S0_":{"name":"init(data:)","abstract":"

Designated init for certificates

","parent_name":"SSLCert"},"Classes/SSLCert.html#/s:FC8SocketIO7SSLCertcFT3keyCSo6SecKey_S0_":{"name":"init(key:)","abstract":"

Designated init for public keys

","parent_name":"SSLCert"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode6normalFMS1_S1_":{"name":"normal","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode9goingAwayFMS1_S1_":{"name":"goingAway","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode13protocolErrorFMS1_S1_":{"name":"protocolError","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode21protocolUnhandledTypeFMS1_S1_":{"name":"protocolUnhandledType","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode16noStatusReceivedFMS1_S1_":{"name":"noStatusReceived","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode8encodingFMS1_S1_":{"name":"encoding","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode14policyViolatedFMS1_S1_":{"name":"policyViolated","abstract":"

Undocumented

","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode13messageTooBigFMS1_S1_":{"name":"messageTooBig","abstract":"

Undocumented

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

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:ZvC8SocketIO9WebSocket11ErrorDomainSS":{"name":"ErrorDomain","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket13callbackQueueCSo13DispatchQueue":{"name":"callbackQueue","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket8delegateXwGSqPS_17WebSocketDelegate__":{"name":"delegate","abstract":"

Responds to callback about new messages coming in over the WebSocket","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket12pongDelegateXwGSqPS_21WebSocketPongDelegate__":{"name":"pongDelegate","abstract":"

Receives a callback for each pong message recived.

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket9onConnectGSqFT_T__":{"name":"onConnect","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket12onDisconnectGSqFGSqCSo7NSError_T__":{"name":"onDisconnect","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6onTextGSqFSST__":{"name":"onText","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6onDataGSqFV10Foundation4DataT__":{"name":"onData","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6onPongGSqFGSqV10Foundation4Data_T__":{"name":"onPong","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket7headersGVs10DictionarySSSS_":{"name":"headers","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket11voipEnabledSb":{"name":"voipEnabled","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket24disableSSLCertValidationSb":{"name":"disableSSLCertValidation","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket8securityGSqPS_17SSLTrustValidator__":{"name":"security","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket22enabledSSLCipherSuitesGSqGSaVs6UInt32__":{"name":"enabledSSLCipherSuites","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6originGSqSS_":{"name":"origin","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket7timeoutSi":{"name":"timeout","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket11isConnectedSb":{"name":"isConnected","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket10currentURLV10Foundation3URL":{"name":"currentURL","abstract":"

Undocumented

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocketcFT3urlV10Foundation3URL9protocolsGSqGSaSS___S0_":{"name":"init(url:protocols:)","abstract":"

Used for setting protocols.

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocketcFT3urlV10Foundation3URL13writeQueueQOSOSC16QualityOfService9protocolsGSqGSaSS___S0_":{"name":"init(url:writeQueueQOS:protocols:)","abstract":"

Undocumented

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

Connect to the WebSocket server on a background thread.

","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket10disconnectFT12forceTimeoutGSqSd_9closeCodeVs6UInt16_T_":{"name":"disconnect(forceTimeout:closeCode:)","abstract":"

Disconnect from the server. I send a Close control frame to the server, then expect the server to respond with a Close control frame and close the socket from its end. I notify my delegate once the socket has been closed.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket5writeFT6stringSS10completionGSqFT_T___T_":{"name":"write(string:completion:)","abstract":"

Write a string to the websocket. This sends it as a text frame.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket5writeFT4dataV10Foundation4Data10completionGSqFT_T___T_":{"name":"write(data:completion:)","abstract":"

Write binary data to the websocket. This sends it as a binary frame.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket5writeFT4pingV10Foundation4Data10completionGSqFT_T___T_":{"name":"write(ping:completion:)","abstract":"

Write a ping to the websocket. This sends it as a control frame.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket6streamFTCSo6Stream6handleVS1_5Event_T_":{"name":"stream(_:handle:)","abstract":"

Delegate for the stream methods. Processes incoming bytes

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

The URL of the socket.io server. This is set in the initializer.

","parent_name":"SocketIOClient"},"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: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:FC8SocketIO14SocketIOClient7connectFT12timeoutAfterSi11withHandlerGSqFT_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: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: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:FC8SocketIO13OnAckCallback9timingOutFT5afterSi8callbackFGSaP__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: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:vC8SocketIO12SocketEngine16doubleEncodeUTF8Sb":{"name":"doubleEncodeUTF8","abstract":"

Set to true if using the node.js version of socket.io. The node.js version of socket.io","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:vC8SocketIO12SocketEngine2wsGSqCS_9WebSocket_":{"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:FC8SocketIO12SocketEngine18parseEngineMessageFTSS11fromPollingSb_T_":{"name":"parseEngineMessage(_:fromPolling:)","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:FC8SocketIO12SocketEngine19websocketDidConnectFT6socketCS_9WebSocket_T_":{"name":"websocketDidConnect(socket:)","abstract":"

Delegate method for connection.

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

Undocumented

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

Undocumented

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

Undocumented

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

Represents some event that was received.

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

Experimental socket manager.

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

The following classes are available globally.

"},"Global Variables.html":{"name":"Global Variables","abstract":"

The following global variables 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