From 3a09e7d5480f84ad165db3b163d887748f09f1cd Mon Sep 17 00:00:00 2001 From: Erik Little Date: Sun, 11 Mar 2018 11:01:49 -0400 Subject: [PATCH] update docs --- docs/12to13.html | 2 +- docs/Classes.html | 2 +- docs/Classes/OnAckCallback.html | 4 +- docs/Classes/SSLSecurity.html | 2 +- docs/Classes/SocketAckEmitter.html | 2 +- docs/Classes/SocketAnyEvent.html | 2 +- docs/Classes/SocketEngine.html | 84 +------------------ docs/Classes/SocketIOClient.html | 14 ++-- docs/Classes/SocketManager.html | 8 +- docs/Enums.html | 2 +- docs/Enums/SocketAckStatus.html | 2 +- docs/Enums/SocketClientEvent.html | 2 +- docs/Enums/SocketEnginePacketType.html | 2 +- docs/Enums/SocketIOClientOption.html | 2 +- docs/Enums/SocketIOStatus.html | 2 +- docs/Enums/SocketParsableError.html | 2 +- docs/Guides.html | 2 +- docs/Protocols.html | 4 +- docs/Protocols/ConfigSettable.html | 2 +- docs/Protocols/SocketData.html | 2 +- docs/Protocols/SocketDataBufferable.html | 2 +- docs/Protocols/SocketEngineClient.html | 2 +- docs/Protocols/SocketEnginePollable.html | 2 +- docs/Protocols/SocketEngineSpec.html | 19 +---- docs/Protocols/SocketEngineWebsocket.html | 75 +---------------- docs/Protocols/SocketIOClientSpec.html | 6 +- docs/Protocols/SocketLogger.html | 2 +- docs/Protocols/SocketManagerSpec.html | 8 +- docs/Protocols/SocketParsable.html | 2 +- docs/Structs.html | 2 +- docs/Structs/SocketEventHandler.html | 2 +- docs/Structs/SocketIOClientConfiguration.html | 2 +- docs/Structs/SocketPacket.html | 2 +- docs/Structs/SocketPacket/PacketType.html | 2 +- docs/Typealiases.html | 2 +- docs/faq.html | 2 +- docs/index.html | 2 +- docs/search.json | 2 +- 38 files changed, 59 insertions(+), 221 deletions(-) diff --git a/docs/12to13.html b/docs/12to13.html index ccf8495..83a90b5 100644 --- a/docs/12to13.html +++ b/docs/12to13.html @@ -274,7 +274,7 @@ and a connect event fired.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Classes.html b/docs/Classes.html index 795ba83..d19f8b0 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -446,7 +446,7 @@ or call one of the disconnectSocket methods on this class.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Classes/OnAckCallback.html b/docs/Classes/OnAckCallback.html index 4a02be0..93f1f56 100644 --- a/docs/Classes/OnAckCallback.html +++ b/docs/Classes/OnAckCallback.html @@ -236,7 +236,7 @@ Example:

- after + seconds @@ -272,7 +272,7 @@ Example:

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Classes/SSLSecurity.html b/docs/Classes/SSLSecurity.html index 25973c6..4905be5 100644 --- a/docs/Classes/SSLSecurity.html +++ b/docs/Classes/SSLSecurity.html @@ -418,7 +418,7 @@ validation

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Classes/SocketAckEmitter.html b/docs/Classes/SocketAckEmitter.html index 51a8cfc..55cab3e 100644 --- a/docs/Classes/SocketAckEmitter.html +++ b/docs/Classes/SocketAckEmitter.html @@ -411,7 +411,7 @@ will be emitted. The structure of the error data is [ackNum, items, theErr
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Classes/SocketAnyEvent.html b/docs/Classes/SocketAnyEvent.html index 7d80975..1fda445 100644 --- a/docs/Classes/SocketAnyEvent.html +++ b/docs/Classes/SocketAnyEvent.html @@ -288,7 +288,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Classes/SocketEngine.html b/docs/Classes/SocketEngine.html index 18d81d2..4be6ebe 100644 --- a/docs/Classes/SocketEngine.html +++ b/docs/Classes/SocketEngine.html @@ -1267,19 +1267,6 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

- - - - fromPolling - - - -
-

Whether this message is from long-polling. - If true we might have to fix utf8 encoding.

-
- - @@ -1358,7 +1345,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

- withType + type @@ -1370,7 +1357,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

- withData + data @@ -1387,71 +1374,6 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

-
-
- - - -

Starscream delegate conformance

- -
-
    -
  • - -
    -
    -
    -
    -
    -

    Delegate method for connection.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func websocketDidConnect(socket: WebSocketClient)
    - -
    -
    -
    -
    -
    • -
  • - -
    -
    -
    -
    -
    -

    Delegate method for disconnection.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func websocketDidDisconnect(socket: WebSocketClient, error: Error?)
    - -
    -
    -
    -
    -
    • -
-
@@ -1496,7 +1418,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Classes/SocketIOClient.html b/docs/Classes/SocketIOClient.html index 77abe5e..ec5b045 100644 --- a/docs/Classes/SocketIOClient.html +++ b/docs/Classes/SocketIOClient.html @@ -428,12 +428,12 @@ - socketURL + nsp
-

The url of the socket.io server.

+

The namespace of the socket.

@@ -529,7 +529,7 @@ - withHandler + handler @@ -771,7 +771,7 @@ will be emitted. The structure of the error data is [eventName, items, the - with + items @@ -912,7 +912,7 @@ Check that your server’s api will ack the event being sent.

- with + items @@ -1174,7 +1174,7 @@ Check that your server’s api will ack the event being sent.

- withAck + ack @@ -1818,7 +1818,7 @@ Called when the manager detects a broken connection, or when a manual reconnect
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Classes/SocketManager.html b/docs/Classes/SocketManager.html index 5aa4aa5..09073cb 100644 --- a/docs/Classes/SocketManager.html +++ b/docs/Classes/SocketManager.html @@ -895,7 +895,7 @@ releasing.

- forNamespace + nsp @@ -1059,7 +1059,7 @@ releasing.

- withItems + items @@ -1507,7 +1507,7 @@ Or call
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Enums.html b/docs/Enums.html index a9d08ea..8eab7a6 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -381,7 +381,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Enums/SocketAckStatus.html b/docs/Enums/SocketAckStatus.html index 39cc5ca..afc4158 100644 --- a/docs/Enums/SocketAckStatus.html +++ b/docs/Enums/SocketAckStatus.html @@ -227,7 +227,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Enums/SocketClientEvent.html b/docs/Enums/SocketClientEvent.html index b576994..33f67ce 100644 --- a/docs/Enums/SocketClientEvent.html +++ b/docs/Enums/SocketClientEvent.html @@ -492,7 +492,7 @@ data item: the namespace that was connected to.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Enums/SocketEnginePacketType.html b/docs/Enums/SocketEnginePacketType.html index 50f4219..cefcab2 100644 --- a/docs/Enums/SocketEnginePacketType.html +++ b/docs/Enums/SocketEnginePacketType.html @@ -413,7 +413,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Enums/SocketIOClientOption.html b/docs/Enums/SocketIOClientOption.html index a27d3cf..6f3fa99 100644 --- a/docs/Enums/SocketIOClientOption.html +++ b/docs/Enums/SocketIOClientOption.html @@ -868,7 +868,7 @@ over when reconnects happen.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Enums/SocketIOStatus.html b/docs/Enums/SocketIOStatus.html index 8ee7362..01a671f 100644 --- a/docs/Enums/SocketIOStatus.html +++ b/docs/Enums/SocketIOStatus.html @@ -387,7 +387,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Enums/SocketParsableError.html b/docs/Enums/SocketParsableError.html index 6a9013f..6068333 100644 --- a/docs/Enums/SocketParsableError.html +++ b/docs/Enums/SocketParsableError.html @@ -289,7 +289,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Guides.html b/docs/Guides.html index 12fa85d..f00450f 100644 --- a/docs/Guides.html +++ b/docs/Guides.html @@ -189,7 +189,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols.html b/docs/Protocols.html index 09ad42b..5ba8d7a 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -302,7 +302,7 @@

Declaration

Swift

- 
public protocol SocketEngineWebsocket : SocketEngineSpec, WebSocketDelegate
+ 
public protocol SocketEngineWebsocket : SocketEngineSpec
@@ -566,7 +566,7 @@ or call one of the disconnectSocket methods on this class.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols/ConfigSettable.html b/docs/Protocols/ConfigSettable.html index de9f55d..5a57af8 100644 --- a/docs/Protocols/ConfigSettable.html +++ b/docs/Protocols/ConfigSettable.html @@ -253,7 +253,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols/SocketData.html b/docs/Protocols/SocketData.html index 84295d6..d465769 100644 --- a/docs/Protocols/SocketData.html +++ b/docs/Protocols/SocketData.html @@ -255,7 +255,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols/SocketDataBufferable.html b/docs/Protocols/SocketDataBufferable.html index 00f65f0..6628d56 100644 --- a/docs/Protocols/SocketDataBufferable.html +++ b/docs/Protocols/SocketDataBufferable.html @@ -239,7 +239,7 @@ So this should ideally be an array of one packet waiting for data.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols/SocketEngineClient.html b/docs/Protocols/SocketEngineClient.html index 3f888a3..b0bc03c 100644 --- a/docs/Protocols/SocketEngineClient.html +++ b/docs/Protocols/SocketEngineClient.html @@ -491,7 +491,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols/SocketEnginePollable.html b/docs/Protocols/SocketEnginePollable.html index 496857e..7aff146 100644 --- a/docs/Protocols/SocketEnginePollable.html +++ b/docs/Protocols/SocketEnginePollable.html @@ -517,7 +517,7 @@ disconnect us.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols/SocketEngineSpec.html b/docs/Protocols/SocketEngineSpec.html index df3a94a..444b110 100644 --- a/docs/Protocols/SocketEngineSpec.html +++ b/docs/Protocols/SocketEngineSpec.html @@ -1050,19 +1050,6 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

- - - - fromPolling - - - -
-

Whether this message is from long-polling. - If true we might have to fix utf8 encoding.

-
- - @@ -1112,7 +1099,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

- withType + type @@ -1124,7 +1111,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

- withData + data @@ -1147,7 +1134,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols/SocketEngineWebsocket.html b/docs/Protocols/SocketEngineWebsocket.html index 7814717..6ab11fe 100644 --- a/docs/Protocols/SocketEngineWebsocket.html +++ b/docs/Protocols/SocketEngineWebsocket.html @@ -179,7 +179,7 @@

SocketEngineWebsocket

- 
public protocol SocketEngineWebsocket : SocketEngineSpec, WebSocketDelegate
+ 
public protocol SocketEngineWebsocket : SocketEngineSpec
@@ -283,84 +283,13 @@ -
-
- - - -

Starscream delegate methods

- -
-
    -
  • -
    - - - - websocketDidReceiveMessage(socket:text:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Delegate method for when a message is received.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func websocketDidReceiveMessage(socket: WebSocketClient, text: String)
    - -
    -
    -
    -
    -
    • -
  • -
    - - - - websocketDidReceiveData(socket:data:) - - - Extension method - -
    -
    -
    -
    -
    -
    -

    Delegate method for when binary is received.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func websocketDidReceiveData(socket: WebSocketClient, data: Data)
    - -
    -
    -
    -
    -
    • -
-
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols/SocketIOClientSpec.html b/docs/Protocols/SocketIOClientSpec.html index a9a8611..3127900 100644 --- a/docs/Protocols/SocketIOClientSpec.html +++ b/docs/Protocols/SocketIOClientSpec.html @@ -422,7 +422,7 @@ - withHandler + handler @@ -987,7 +987,7 @@ will be emitted. The structure of the error data is [eventName, items, the - withAck + ack @@ -1614,7 +1614,7 @@ Called when the manager detects a broken connection, or when a manual reconnect
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols/SocketLogger.html b/docs/Protocols/SocketLogger.html index 7b63bd3..dbf3746 100644 --- a/docs/Protocols/SocketLogger.html +++ b/docs/Protocols/SocketLogger.html @@ -401,7 +401,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols/SocketManagerSpec.html b/docs/Protocols/SocketManagerSpec.html index aa62d12..125a14e 100644 --- a/docs/Protocols/SocketManagerSpec.html +++ b/docs/Protocols/SocketManagerSpec.html @@ -693,7 +693,7 @@ called on.

- forNamespace + nsp @@ -751,7 +751,7 @@ called on.

- withItems + items @@ -883,7 +883,7 @@ Or call
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Protocols/SocketParsable.html b/docs/Protocols/SocketParsable.html index e74affd..f2a1f47 100644 --- a/docs/Protocols/SocketParsable.html +++ b/docs/Protocols/SocketParsable.html @@ -327,7 +327,7 @@ into the correct placeholder.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Structs.html b/docs/Structs.html index 181f6a5..326e4fd 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -285,7 +285,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Structs/SocketEventHandler.html b/docs/Structs/SocketEventHandler.html index 7e80889..22a815b 100644 --- a/docs/Structs/SocketEventHandler.html +++ b/docs/Structs/SocketEventHandler.html @@ -369,7 +369,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Structs/SocketIOClientConfiguration.html b/docs/Structs/SocketIOClientConfiguration.html index 17fba23..ee3ecdb 100644 --- a/docs/Structs/SocketIOClientConfiguration.html +++ b/docs/Structs/SocketIOClientConfiguration.html @@ -648,7 +648,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Structs/SocketPacket.html b/docs/Structs/SocketPacket.html index 6b47e48..40caa3c 100644 --- a/docs/Structs/SocketPacket.html +++ b/docs/Structs/SocketPacket.html @@ -492,7 +492,7 @@ event type packets.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Structs/SocketPacket/PacketType.html b/docs/Structs/SocketPacket/PacketType.html index 26bc296..ef8ceca 100644 --- a/docs/Structs/SocketPacket/PacketType.html +++ b/docs/Structs/SocketPacket/PacketType.html @@ -413,7 +413,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/Typealiases.html b/docs/Typealiases.html index 7805449..ea93e84 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -247,7 +247,7 @@
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/faq.html b/docs/faq.html index dd03698..36f9841 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -223,7 +223,7 @@ will be released, along with the socket, and its memory reclaimed.

-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/index.html b/docs/index.html index 07918ac..ebcaebd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -325,7 +325,7 @@ SocketIOClient* socket = manager.defaultSocket;
-

© 2018 Erik. All rights reserved. (Last updated: 2018-01-10)

+

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

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

diff --git a/docs/search.json b/docs/search.json index 5cf76cc..65f9e47 100644 --- a/docs/search.json +++ b/docs/search.json @@ -1 +1 @@ -{"Typealiases.html#/s:8SocketIO11AckCallbacka":{"name":"AckCallback","abstract":"

A typealias for an ack callback.

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

A typealias for a normal callback.

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

Connect: 0

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

Disconnect: 1

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

Event: 2

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

Ack: 3

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

Error: 4

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

Binary Event: 5

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

Binary Ack: 6

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

The namespace for this packet.

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

If > 0 then this packet is using acking.

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

The type of this packet.

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

An array of binary data for this packet.

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

The data for this event.

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

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

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

A string representation of this packet.

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

The event name for this packet.

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

A string representation of this packet.

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

The type of packets.

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

Type of element stored.

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

Index type.

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

Iterator type.

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

SubSequence type.

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

The start index of this collection.

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

The end index of this collection.

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

Whether this collection is empty.

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

The number of elements stored in this collection.

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

The first element in this collection.

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

Creates a new SocketIOClientConfiguration from an array literal.

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

Creates an iterator for this collection.

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

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

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

The event for this handler.

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

A unique identifier for this handler.

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

The actual handler function.

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

Causes this handler to be executed.

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

A wrapper around a handler.

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

An array-like type that holds SocketIOClientOptions

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

A struct that represents a socket.io packet.

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

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

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

The engine for this manager.

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

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

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

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

The sockets in this manager indexed by namespace.

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

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

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

The number of seconds to wait before attempting to reconnect.

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

The URL of the socket.io server.

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

The status of this manager.

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

Connects the underlying transport.

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

Connects a socket through this manager’s engine.

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

Called when the manager has disconnected from socket.io.

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

Disconnects the manager and all associated sockets.

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

Disconnects the given socket.

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

Disconnects the socket associated with forNamespace.

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

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

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

Tries to reconnect to the server.

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

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

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

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

A list of packets that are waiting for binary data.

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

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

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

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

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

Whether to log or not

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

Normal log messages

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

Error Messages

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

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

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

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

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

A handler that will be called on any event.

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

The array of handlers for this socket.

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

The manager for this socket.

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

The namespace that this socket is currently connected to.

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

The status of this client.

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

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

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

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

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

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

Called when the client has disconnected from socket.io.

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

Called when the client encounters an error.

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

Disconnects the socket.

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

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

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

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

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

Sends a message to the server, requesting an ack.

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

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

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

Called on socket.io specific events.

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

Called when we get an event from socket.io.

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

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

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

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

Joins nsp.

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

Removes handler(s) for a client event.

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

Removes handler(s) based on an event name.

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

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

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

Adds a handler for an event.

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

Adds a handler for a client event.

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

Adds a single-use handler for a client event.

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

Adds a single-use handler for an event.

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

Adds a handler that will be called on every event.

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

Removes all handlers.

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

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

Sends an engine.io message through the WebSocket transport.

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

Delegate method for when a message is received.

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

Delegate method for when binary is received.

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

true If engine’s session has been invalidated.

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

A queue of engine.io messages waiting for POSTing

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

The URLSession that will be used for polling.

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

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

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

Call to send a long-polling request.

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

Sends an engine.io message through the polling transport.

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

Call to stop polling and invalidate the URLSession.

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

Called when the engine errors.

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

Called when the engine closes.

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

Called when the engine opens.

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

Called when the engine receives a pong message.

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

Called when the engine sends a ping to the server.

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

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

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

Called when the engine receives binary data.

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

The client for this engine.

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

true if this engine is closed.

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

If true the engine will attempt to use WebSocket compression.

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

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

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

The connect parameters sent during a connect.

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

An array of HTTPCookies that are sent during the connection.

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

The queue that all engine actions take place on.

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

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

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

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

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

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

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

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

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

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

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

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

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

The session id for this engine.

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

The path to engine.io.

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

The url for polling.

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

The url for WebSockets.

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

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

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

The WebSocket for this engine.

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

Creates a new engine.

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

Starts the connection to the server.

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

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

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

Disconnects from the server.

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

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

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

Parses raw binary received from engine.io.

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

Parses a raw engine.io packet.

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

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

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

Specifies a SocketEngine.

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

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

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

Protocol that is used to implement socket.io polling support

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

Protocol that is used to implement socket.io WebSocket support

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

Defines the interface for a SocketIOClient.

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

Declares that a type can set configs from a SocketIOClientConfiguration.

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

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

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

Represents a class will log client events.

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

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

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

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

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

A manager for a socket.io connection.

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

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

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

Thrown when an malformed packet is received.

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

Thrown when the parser receives an unknown packet type.

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

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

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

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

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

The client/manager is in the process of connecting.

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

The client/manager is currently connected.

","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/s:8SocketIO0A8IOStatusO6activeSbv":{"name":"active","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/s:s23CustomStringConvertibleP11descriptionSSv":{"name":"description","parent_name":"SocketIOStatus"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8compressA2CmF":{"name":"compress","abstract":"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Used to pass in a custom logger.

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

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

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

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

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

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

The number of seconds to wait before reconnect attempts.

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

Set true if your server is using secure transports.

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

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

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

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

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

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

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

The description of this option.

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

Compares whether two options are the same.

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

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

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

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

Emitted when an error occurs.

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

Emitted whenever the engine sends a ping.

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

Emitted whenever the engine gets a pong.

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

Emitted when the client begins the reconnection process.

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

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

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

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

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

The ack timed out.

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

Open message.

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

Close message.

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

Ping message.

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

Pong message.

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

Regular message.

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

Upgrade message.

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

NOOP.

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

Represents the type of engine.io packet types.

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

The status of an ack.

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

The set of events that are generated by the client.

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

The options for a client.

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

Represents state of a manager or client.

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

Errors that can be thrown during parsing.

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

The socket associated with the default namespace (/).

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

The URL of the socket.io server.

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

The configuration for this client.

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

The engine for this manager.

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

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

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

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

The sockets in this manager indexed by namespace.

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

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

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

The number of seconds to wait before attempting to reconnect.

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

The status of this manager.

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

A list of packets that are waiting for binary data.

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

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

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

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

Connects the underlying transport and the default namespace socket.

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

Connects a socket through this manager’s engine.

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

Called when the manager has disconnected from socket.io.

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

Disconnects the manager and all associated sockets.

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

Disconnects the given socket.

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

Disconnects the socket associated with forNamespace.

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

Sends a client event to all sockets in nsps

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

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

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

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

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

Called when the engine closes.

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

Called when the engine errors.

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

Called when the engine opens.

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

Called when the engine receives a pong message.

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

Called when the sends a ping to the server.

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

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

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

Called when the engine receives binary data.

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

Tries to reconnect to the server.

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

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

Sets manager specific configs.

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

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

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

The internal Starscream SSLSecurity.

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

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

Designated init

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

Returns whether or not the given trust is valid.

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

The namespace that this socket is currently connected to.

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

The session id of this client.

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

A handler that will be called on any event.

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

The array of handlers for this socket.

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

The manager for this socket.

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

The status of this client.

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

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

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

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

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

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

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

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

Called when the client has disconnected from socket.io.

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

Disconnects the socket.

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

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

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

Same as emit, but meant for Objective-C

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

Sends a message to the server, requesting an ack.

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

Same as emitWithAck, but for Objective-C

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

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

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

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

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

Called on socket.io specific events.

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

Called when we get an event from socket.io.

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

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

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

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

Joins nsp.

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

Removes handler(s) for a client event.

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

Removes handler(s) based on an event name.

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

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

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

Adds a handler for an event.

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

Adds a handler for a client event.

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

Adds a single-use handler for a client event.

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

Adds a single-use handler for an event.

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

Adds a handler that will be called on every event.

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

Removes all handlers.

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

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

The event name.

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

The data items for this event.

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

The description of this event.

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

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

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

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

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

Creates a new SocketAckEmitter.

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

Call to ack receiving this event.

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

Call to ack receiving this event.

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

The queue that all engine actions take place on.

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

The connect parameters sent during a connect.

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

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

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

A queue of engine.io messages waiting for POSTing

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC14waitingForPollSbv":{"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:8SocketIO0A6EngineC14waitingForPostSbv":{"name":"waitingForPost","abstract":"

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

true if this engine is closed.

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

If true the engine will attempt to use WebSocket compression.

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

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

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

An array of HTTPCookies that are sent during the connection.

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

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

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

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

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

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

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

true If engine’s session has been invalidated.

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

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

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

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

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

The URLSession that will be used for polling.

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

The session id for this engine.

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

The path to engine.io.

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

The url for polling.

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

The url for WebSockets.

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

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

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

The WebSocket for this engine.

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

The client for this engine.

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

Creates a new engine.

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

Creates a new engine.

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

Starts the connection to the server.

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

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

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

Disconnects from the server.

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

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

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

Parses raw binary received from engine.io.

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

Parses a raw engine.io packet.

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

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

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

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

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

Delegate method for connection.

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

Delegate method for disconnection.

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

Delegate called when the session becomes invalid.

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

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

A class that represents a waiting ack call.

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

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

Represents some event that was received.

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

Represents a socket.io-client.

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

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

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

A manager for a socket.io connection.

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

The following guides are available globally.

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

The following classes are available globally.

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

The following enumerations are available globally.

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

The following protocols are available globally.

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

The following structures are available globally.

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

The following type aliases are available globally.

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

A typealias for an ack callback.

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

A typealias for a normal callback.

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

Connect: 0

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

Disconnect: 1

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

Event: 2

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

Ack: 3

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

Error: 4

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

Binary Event: 5

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

Binary Ack: 6

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

The namespace for this packet.

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

If > 0 then this packet is using acking.

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

The type of this packet.

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

An array of binary data for this packet.

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

The data for this event.

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

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

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

A string representation of this packet.

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

The event name for this packet.

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

A string representation of this packet.

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

The type of packets.

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

Type of element stored.

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

Index type.

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

Iterator type.

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

SubSequence type.

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

The start index of this collection.

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

The end index of this collection.

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

Whether this collection is empty.

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

The number of elements stored in this collection.

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

The first element in this collection.

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

Creates a new SocketIOClientConfiguration from an array literal.

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

Creates an iterator for this collection.

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

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

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

The event for this handler.

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

A unique identifier for this handler.

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

The actual handler function.

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

Causes this handler to be executed.

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

A wrapper around a handler.

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

An array-like type that holds SocketIOClientOptions

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

A struct that represents a socket.io packet.

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

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

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

The engine for this manager.

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

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

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

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

The sockets in this manager indexed by namespace.

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

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

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

The number of seconds to wait before attempting to reconnect.

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

The URL of the socket.io server.

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

The status of this manager.

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

Connects the underlying transport.

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

Connects a socket through this manager’s engine.

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

Called when the manager has disconnected from socket.io.

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

Disconnects the manager and all associated sockets.

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

Disconnects the given socket.

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

Disconnects the socket associated with forNamespace.

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

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

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

Tries to reconnect to the server.

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

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

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

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

A list of packets that are waiting for binary data.

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

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

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

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

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

Whether to log or not

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

Normal log messages

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

Error Messages

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

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

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

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

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

A handler that will be called on any event.

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

The array of handlers for this socket.

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

The manager for this socket.

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

The namespace that this socket is currently connected to.

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

The status of this client.

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

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

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

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

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

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

Called when the client has disconnected from socket.io.

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

Called when the client encounters an error.

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

Disconnects the socket.

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

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

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

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

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

Sends a message to the server, requesting an ack.

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

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

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

Called on socket.io specific events.

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

Called when we get an event from socket.io.

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

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

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

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

Joins nsp.

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

Removes handler(s) for a client event.

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

Removes handler(s) based on an event name.

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

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

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

Adds a handler for an event.

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

Adds a handler for a client event.

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

Adds a single-use handler for a client event.

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

Adds a single-use handler for an event.

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

Adds a handler that will be called on every event.

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

Removes all handlers.

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

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

Sends an engine.io message through the WebSocket transport.

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

true If engine’s session has been invalidated.

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

A queue of engine.io messages waiting for POSTing

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

The URLSession that will be used for polling.

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

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

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

Call to send a long-polling request.

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

Sends an engine.io message through the polling transport.

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

Call to stop polling and invalidate the URLSession.

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

Called when the engine errors.

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

Called when the engine closes.

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

Called when the engine opens.

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

Called when the engine receives a pong message.

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

Called when the engine sends a ping to the server.

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

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

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

Called when the engine receives binary data.

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

The client for this engine.

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

true if this engine is closed.

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

If true the engine will attempt to use WebSocket compression.

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

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

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

The connect parameters sent during a connect.

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

An array of HTTPCookies that are sent during the connection.

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

The queue that all engine actions take place on.

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

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

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

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

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

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

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

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

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

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

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

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

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

The session id for this engine.

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

The path to engine.io.

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

The url for polling.

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

The url for WebSockets.

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

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

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

The WebSocket for this engine.

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

Creates a new engine.

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

Starts the connection to the server.

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

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

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

Disconnects from the server.

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

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

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

Parses raw binary received from engine.io.

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

Parses a raw engine.io packet.

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

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

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

Specifies a SocketEngine.

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

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

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

Protocol that is used to implement socket.io polling support

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

Protocol that is used to implement socket.io WebSocket support

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

Defines the interface for a SocketIOClient.

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

Declares that a type can set configs from a SocketIOClientConfiguration.

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

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

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

Represents a class will log client events.

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

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

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

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

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

A manager for a socket.io connection.

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

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

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

Thrown when an malformed packet is received.

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

Thrown when the parser receives an unknown packet type.

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

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

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

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

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

The client/manager is in the process of connecting.

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

The client/manager is currently connected.

","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/s:8SocketIO0A8IOStatusO6activeSbv":{"name":"active","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/s:s23CustomStringConvertibleP11descriptionSSv":{"name":"description","parent_name":"SocketIOStatus"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8compressA2CmF":{"name":"compress","abstract":"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Used to pass in a custom logger.

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

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

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

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

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

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

The number of seconds to wait before reconnect attempts.

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

Set true if your server is using secure transports.

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

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

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

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

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

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

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

The description of this option.

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

Compares whether two options are the same.

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

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

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

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

Emitted when an error occurs.

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

Emitted whenever the engine sends a ping.

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

Emitted whenever the engine gets a pong.

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

Emitted when the client begins the reconnection process.

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

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

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

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

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

The ack timed out.

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

Open message.

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

Close message.

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

Ping message.

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

Pong message.

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

Regular message.

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

Upgrade message.

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

NOOP.

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

Represents the type of engine.io packet types.

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

The status of an ack.

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

The set of events that are generated by the client.

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

The options for a client.

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

Represents state of a manager or client.

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

Errors that can be thrown during parsing.

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

The socket associated with the default namespace (/).

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

The URL of the socket.io server.

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

The configuration for this client.

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

The engine for this manager.

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

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

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

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

The sockets in this manager indexed by namespace.

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

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

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

The number of seconds to wait before attempting to reconnect.

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

The status of this manager.

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

A list of packets that are waiting for binary data.

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

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

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

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

Connects the underlying transport and the default namespace socket.

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

Connects a socket through this manager’s engine.

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

Called when the manager has disconnected from socket.io.

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

Disconnects the manager and all associated sockets.

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

Disconnects the given socket.

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

Disconnects the socket associated with forNamespace.

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

Sends a client event to all sockets in nsps

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

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

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

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

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

Called when the engine closes.

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

Called when the engine errors.

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

Called when the engine opens.

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

Called when the engine receives a pong message.

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

Called when the sends a ping to the server.

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

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

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

Called when the engine receives binary data.

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

Tries to reconnect to the server.

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

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

Sets manager specific configs.

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

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

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

The internal Starscream SSLSecurity.

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

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

Designated init

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

Returns whether or not the given trust is valid.

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

The namespace that this socket is currently connected to.

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

The session id of this client.

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

A handler that will be called on any event.

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

The array of handlers for this socket.

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

The manager for this socket.

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

The status of this client.

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

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

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

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

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

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

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

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

Called when the client has disconnected from socket.io.

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

Disconnects the socket.

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

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

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

Same as emit, but meant for Objective-C

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

Sends a message to the server, requesting an ack.

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

Same as emitWithAck, but for Objective-C

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

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

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

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

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

Called on socket.io specific events.

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

Called when we get an event from socket.io.

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

Causes a client to handle a socket.io packet. The namespace for the packet must match the namespace of the","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)leaveNamespace":{"name":"leaveNamespace()","abstract":"

Call when you wish to leave a namespace and disconnect this socket.

","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)joinNamespace":{"name":"joinNamespace()","abstract":"

Joins nsp.

","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC3offyAA0A11ClientEventO06clientF0_tF":{"name":"off(clientEvent:)","abstract":"

Removes handler(s) for a client event.

","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)off:":{"name":"off(_:)","abstract":"

Removes handler(s) based on an event name.

","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)offWithId:":{"name":"off(id:)","abstract":"

Removes a handler with the specified UUID gotten from an on or once

","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)on:callback:":{"name":"on(_:callback:)","abstract":"

Adds a handler for an event.

","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC2on10Foundation4UUIDVAA0A11ClientEventO06clientH0_ySayypG_AA0A10AckEmitterCtc8callbacktF":{"name":"on(clientEvent:callback:)","abstract":"

Adds a handler for a client event.

","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC4once10Foundation4UUIDVAA0A11ClientEventO06clientH0_ySayypG_AA0A10AckEmitterCtc8callbacktF":{"name":"once(clientEvent:callback:)","abstract":"

Adds a single-use handler for a client event.

","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)once:callback:":{"name":"once(_:callback:)","abstract":"

Adds a single-use handler for an event.

","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)onAny:":{"name":"onAny(_:)","abstract":"

Adds a handler that will be called on every event.

","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)removeAllHandlers":{"name":"removeAllHandlers()","abstract":"

Removes all handlers.

","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)setReconnectingWithReason:":{"name":"setReconnecting(reason:)","abstract":"

Puts the socket back into the connecting state.","parent_name":"SocketIOClient"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)event":{"name":"event","abstract":"

The event name.

","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)items":{"name":"items","abstract":"

The data items for this event.

","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)description":{"name":"description","abstract":"

The description of this event.

","parent_name":"SocketAnyEvent"},"Classes/OnAckCallback.html#/c:@M@SocketIO@objc(cs)OnAckCallback(im)timingOutAfter:callback:":{"name":"timingOut(after:callback:)","abstract":"

Completes an emitWithAck. If this isn’t called, the emit never happens.

","parent_name":"OnAckCallback"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC8expectedSbv":{"name":"expected","abstract":"

If true, this handler is expecting to be acked. Call with(_: SocketData...) to ack.

","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterCAcA0A8IOClientC6socket_Si6ackNumtcfc":{"name":"init(socket:ackNum:)","abstract":"

Creates a new SocketAckEmitter.

","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC4withySayAA0A4Data_pGd_tF":{"name":"with(_:)","abstract":"

Call to ack receiving this event.

","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/c:@M@SocketIO@objc(cs)SocketAckEmitter(im)with:":{"name":"with(_:)","abstract":"

Call to ack receiving this event.

","parent_name":"SocketAckEmitter"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)engineQueue":{"name":"engineQueue","abstract":"

The queue that all engine actions take place on.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)connectParams":{"name":"connectParams","abstract":"

The connect parameters sent during a connect.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)extraHeaders":{"name":"extraHeaders","abstract":"

A dictionary of extra http headers that will be set during connection.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC8postWaitSaySSGv":{"name":"postWait","abstract":"

A queue of engine.io messages waiting for POSTing

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC14waitingForPollSbv":{"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:8SocketIO0A6EngineC14waitingForPostSbv":{"name":"waitingForPost","abstract":"

true if there is an outstanding post. Trying to post before the first is done will cause socket.io to","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)closed":{"name":"closed","abstract":"

true if this engine is closed.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)compress":{"name":"compress","abstract":"

If true the engine will attempt to use WebSocket compression.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)connected":{"name":"connected","abstract":"

true if this engine is connected. Connected means that the initial poll connect has succeeded.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)cookies":{"name":"cookies","abstract":"

An array of HTTPCookies that are sent during the connection.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)fastUpgrade":{"name":"fastUpgrade","abstract":"

When true, the engine is in the process of switching to WebSockets.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)forcePolling":{"name":"forcePolling","abstract":"

When true, the engine will only use HTTP long-polling as a transport.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)forceWebsockets":{"name":"forceWebsockets","abstract":"

When true, the engine will only use WebSockets as a transport.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC11invalidatedSbv":{"name":"invalidated","abstract":"

true If engine’s session has been invalidated.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)polling":{"name":"polling","abstract":"

If true, the engine is currently in HTTP long-polling mode.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)probing":{"name":"probing","abstract":"

If true, the engine is currently seeing whether it can upgrade to WebSockets.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC7sessionSo10URLSessionCSgv":{"name":"session","abstract":"

The URLSession that will be used for polling.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)sid":{"name":"sid","abstract":"

The session id for this engine.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)socketPath":{"name":"socketPath","abstract":"

The path to engine.io.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)urlPolling":{"name":"urlPolling","abstract":"

The url for polling.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)urlWebSocket":{"name":"urlWebSocket","abstract":"

The url for WebSockets.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)websocket":{"name":"websocket","abstract":"

If true, then the engine is currently in WebSockets mode.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)ws":{"name":"ws","abstract":"

The WebSocket for this engine.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)client":{"name":"client","abstract":"

The client for this engine.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineCAcA0aC6Client_p6client_10Foundation3URLV3urlAA0A21IOClientConfigurationV6configtcfc":{"name":"init(client:url:config:)","abstract":"

Creates a new engine.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)initWithClient:url:options:":{"name":"init(client:url:options:)","abstract":"

Creates a new engine.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)connect":{"name":"connect()","abstract":"

Starts the connection to the server.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)didErrorWithReason:":{"name":"didError(reason:)","abstract":"

Called when an error happens during execution. Causes a disconnection.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)disconnectWithReason:":{"name":"disconnect(reason:)","abstract":"

Disconnects from the server.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)doFastUpgrade":{"name":"doFastUpgrade()","abstract":"

Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)flushWaitingForPostToWebSocket":{"name":"flushWaitingForPostToWebSocket()","abstract":"

Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineData:":{"name":"parseEngineData(_:)","abstract":"

Parses raw binary received from engine.io.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"

Parses a raw engine.io packet.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC10setConfigsyAA0A21IOClientConfigurationVF":{"name":"setConfigs(_:)","abstract":"

Called when the engine should set/update its configs from a given configuration.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)write:withType:withData:":{"name":"write(_:withType:withData:)","abstract":"

Writes a message to engine.io, independent of transport.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC10URLSessionySoADC7session_So7NSErrorCSg25didBecomeInvalidWithErrortF":{"name":"URLSession(session:didBecomeInvalidWithError:)","abstract":"

Delegate called when the session becomes invalid.

","parent_name":"SocketEngine"},"Classes/SocketEngine.html":{"name":"SocketEngine","abstract":"

The class that handles the engine.io protocol and transports."},"Classes/SocketAckEmitter.html":{"name":"SocketAckEmitter","abstract":"

A class that represents a waiting ack call.

"},"Classes/OnAckCallback.html":{"name":"OnAckCallback","abstract":"

A class that represents an emit that will request an ack that has not yet been sent."},"Classes/SocketAnyEvent.html":{"name":"SocketAnyEvent","abstract":"

Represents some event that was received.

"},"Classes/SocketIOClient.html":{"name":"SocketIOClient","abstract":"

Represents a socket.io-client.

"},"Classes/SSLSecurity.html":{"name":"SSLSecurity","abstract":"

A wrapper around Starscream’s SSLSecurity that provides a minimal Objective-C interface.

"},"Classes/SocketManager.html":{"name":"SocketManager","abstract":"

A manager for a socket.io connection.

"},"faq.html":{"name":"FAQ"},"12to13.html":{"name":"12to13"},"Guides.html":{"name":"Guides","abstract":"

The following guides are available globally.

"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Protocols.html":{"name":"Protocols","abstract":"

The following protocols are available globally.

"},"Structs.html":{"name":"Structures","abstract":"

The following structures are available globally.

"},"Typealiases.html":{"name":"Type Aliases","abstract":"

The following type aliases are available globally.

"}} \ No newline at end of file