Erik 1ff8e11a1f
Document SocketIOClientSwift
add docs

Start documenting engine

More engine documentation

Document engine

document SocketEngineClient

Document SocketEnginePollable and SocketEnginePacketType

Document SocketEngineWebsocket

Document SocketIOClient

Document SocketIOClientStatus

Document SocketLogger

Document some typealiases

Document SocketIOClientOption

Document SocketIOClientConfiguration
2017-05-06 14:41:50 -04:00

1 line
53 KiB
JSON

{"Typealiases.html#/s:8SocketIO14NormalCallback":{"name":"NormalCallback","abstract":"<p>A typealias for a normal callback.</p>"},"Typealiases.html#/s:8SocketIO11AckCallback":{"name":"AckCallback","abstract":"<p>A typealias for an ack callback.</p>"},"Structs/SocketIOClientConfiguration.html#/s:V8SocketIO27SocketIOClientConfiguration8Iterator":{"name":"Iterator","abstract":"<p>Iterator type.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:V8SocketIO27SocketIOClientConfiguration7Element":{"name":"Element","abstract":"<p>Type of element stored.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:V8SocketIO27SocketIOClientConfiguration11SubSequence":{"name":"SubSequence","abstract":"<p>SubSequence type.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:V8SocketIO27SocketIOClientConfiguration5Index":{"name":"Index","abstract":"<p>Index type.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:vV8SocketIO27SocketIOClientConfiguration10startIndexSi":{"name":"startIndex","abstract":"<p>The start index of this collection.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:vV8SocketIO27SocketIOClientConfiguration8endIndexSi":{"name":"endIndex","abstract":"<p>The end index of this collection.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:vV8SocketIO27SocketIOClientConfiguration7isEmptySb":{"name":"isEmpty","abstract":"<p>Whether this collection is empty.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:vV8SocketIO27SocketIOClientConfiguration5countSi":{"name":"count","abstract":"<p>The number of elements stored in this collection.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:vV8SocketIO27SocketIOClientConfiguration5firstGSqOS_20SocketIOClientOption_":{"name":"first","abstract":"<p>The first element in this collection.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:FV8SocketIO27SocketIOClientConfigurationcFt12arrayLiteralGSaOS_20SocketIOClientOption__S0_":{"name":"init(arrayLiteral:)","abstract":"<p>Creates a new <code>SocketIOClientConfiguration</code> from an array literal.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:FV8SocketIO27SocketIOClientConfiguration12makeIteratorFT_GVs16IndexingIteratorGSaOS_20SocketIOClientOption__":{"name":"makeIterator()","abstract":"<p>Creates an iterator for this collection.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:FV8SocketIO27SocketIOClientConfiguration5indexFT5afterSi_Si":{"name":"index(after:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:FV8SocketIO27SocketIOClientConfiguration6insertFTOS_20SocketIOClientOption9replacingSb_T_":{"name":"insert(_:replacing:)","abstract":"<p>Special method that inserts <code>element</code> into the collection, replacing any other instances of <code>element</code>.</p>","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html":{"name":"SocketIOClientConfiguration","abstract":"<p>An array-like type that holds <code><a href=\"36f8f5912051ae747ef441d6511ca4cbEnums/SocketIOClientOption.html\">SocketIOClientOption</a></code>s</p>"},"Protocols/SSLTrustValidator.html#/s:FP8SocketIO17SSLTrustValidator7isValidFTCSo8SecTrust6domainGSqSS__Sb":{"name":"isValid(_:domain:)","abstract":"<p>Undocumented</p>","parent_name":"SSLTrustValidator"},"Protocols/SocketEngineClient.html#/s:FP8SocketIO18SocketEngineClient14engineDidErrorFT6reasonSS_T_":{"name":"engineDidError(reason:)","abstract":"<p>Called when the engine errors.</p>","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/s:FP8SocketIO18SocketEngineClient14engineDidCloseFT6reasonSS_T_":{"name":"engineDidClose(reason:)","abstract":"<p>Called when the engine closes.</p>","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/s:FP8SocketIO18SocketEngineClient13engineDidOpenFT6reasonSS_T_":{"name":"engineDidOpen(reason:)","abstract":"<p>Called when the engine opens.</p>","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/s:FP8SocketIO18SocketEngineClient18parseEngineMessageFSST_":{"name":"parseEngineMessage(_:)","abstract":"<p>Called when the engine has a message that must be parsed.</p>","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/s:FP8SocketIO18SocketEngineClient21parseEngineBinaryDataFV10Foundation4DataT_":{"name":"parseEngineBinaryData(_:)","abstract":"<p>Called when the engine receives binary data.</p>","parent_name":"SocketEngineClient"},"Protocols/WebSocketPongDelegate.html#/s:FP8SocketIO21WebSocketPongDelegate23websocketDidReceivePongFT6socketCS_9WebSocket4dataGSqV10Foundation4Data__T_":{"name":"websocketDidReceivePong(socket:data:)","abstract":"<p>Undocumented</p>","parent_name":"WebSocketPongDelegate"},"Protocols/WebSocketDelegate.html#/s:FP8SocketIO17WebSocketDelegate19websocketDidConnectFT6socketCS_9WebSocket_T_":{"name":"websocketDidConnect(socket:)","abstract":"<p>Undocumented</p>","parent_name":"WebSocketDelegate"},"Protocols/WebSocketDelegate.html#/s:FP8SocketIO17WebSocketDelegate22websocketDidDisconnectFT6socketCS_9WebSocket5errorGSqCSo7NSError__T_":{"name":"websocketDidDisconnect(socket:error:)","abstract":"<p>Undocumented</p>","parent_name":"WebSocketDelegate"},"Protocols/WebSocketDelegate.html#/s:FP8SocketIO17WebSocketDelegate26websocketDidReceiveMessageFT6socketCS_9WebSocket4textSS_T_":{"name":"websocketDidReceiveMessage(socket:text:)","abstract":"<p>Undocumented</p>","parent_name":"WebSocketDelegate"},"Protocols/WebSocketDelegate.html#/s:FP8SocketIO17WebSocketDelegate23websocketDidReceiveDataFT6socketCS_9WebSocket4dataV10Foundation4Data_T_":{"name":"websocketDidReceiveData(socket:data:)","abstract":"<p>Undocumented</p>","parent_name":"WebSocketDelegate"},"Protocols/SocketLogger.html#/s:vP8SocketIO12SocketLogger3logSb":{"name":"log","abstract":"<p>Whether to log or not</p>","parent_name":"SocketLogger"},"Protocols/SocketLogger.html#/s:FP8SocketIO12SocketLogger3logFtSS4typeSS4argsGSaP___T_":{"name":"log(_:type:args:)","abstract":"<p>Normal log messages</p>","parent_name":"SocketLogger"},"Protocols/SocketLogger.html#/s:FP8SocketIO12SocketLogger5errorFtSS4typeSS4argsGSaP___T_":{"name":"error(_:type:args:)","abstract":"<p>Error Messages</p>","parent_name":"SocketLogger"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec6clientXwGSqPS_18SocketEngineClient__":{"name":"client","abstract":"<p>The client for this engine.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec6closedSb":{"name":"closed","abstract":"<p><code>true</code> if this engine is closed.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec9connectedSb":{"name":"connected","abstract":"<p><code>true</code> if this engine is connected. Connected means that the initial poll connect has succeeded.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec13connectParamsGSqGVs10DictionarySSP___":{"name":"connectParams","abstract":"<p>The connect parameters sent during a connect.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec16doubleEncodeUTF8Sb":{"name":"doubleEncodeUTF8","abstract":"<p>Set to <code>true</code> if using the node.js version of socket.io. The node.js version of socket.io","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec7cookiesGSqGSaCSo10HTTPCookie__":{"name":"cookies","abstract":"<p>An array of HTTPCookies that are sent during the connection.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec11engineQueueCSo13DispatchQueue":{"name":"engineQueue","abstract":"<p>The queue that all engine actions take place on.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec12extraHeadersGSqGVs10DictionarySSSS__":{"name":"extraHeaders","abstract":"<p>A dictionary of extra http headers that will be set during connection.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec11fastUpgradeSb":{"name":"fastUpgrade","abstract":"<p>When <code>true</code>, the engine is in the process of switching to WebSockets.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec12forcePollingSb":{"name":"forcePolling","abstract":"<p>When <code>true</code>, the engine will only use HTTP long-polling as a transport.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec15forceWebsocketsSb":{"name":"forceWebsockets","abstract":"<p>When <code>true</code>, the engine will only use WebSockets as a transport.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec7pollingSb":{"name":"polling","abstract":"<p>If <code>true</code>, the engine is currently in HTTP long-polling mode.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec7probingSb":{"name":"probing","abstract":"<p>If <code>true</code>, the engine is currently seeing whether it can upgrade to WebSockets.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec3sidSS":{"name":"sid","abstract":"<p>The session id for this engine.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec10socketPathSS":{"name":"socketPath","abstract":"<p>The path to engine.io.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec10urlPollingV10Foundation3URL":{"name":"urlPolling","abstract":"<p>The url for polling.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec12urlWebSocketV10Foundation3URL":{"name":"urlWebSocket","abstract":"<p>The url for WebSockets.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec9websocketSb":{"name":"websocket","abstract":"<p>If <code>true</code>, then the engine is currently in WebSockets mode.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:vP8SocketIO16SocketEngineSpec2wsGSqCS_9WebSocket_":{"name":"ws","abstract":"<p>The WebSocket for this engine.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpeccFT6clientPS_18SocketEngineClient_3urlV10Foundation3URL7optionsGSqCSo12NSDictionary__x":{"name":"init(client:url:options:)","abstract":"<p>Creates a new engine.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec7connectFT_T_":{"name":"connect()","abstract":"<p>Starts the connection to the server.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec8didErrorFT6reasonSS_T_":{"name":"didError(reason:)","abstract":"<p>Called when an error happens during execution. Causes a disconnection.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec10disconnectFT6reasonSS_T_":{"name":"disconnect(reason:)","abstract":"<p>Disconnects from the server.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec13doFastUpgradeFT_T_":{"name":"doFastUpgrade()","abstract":"<p>Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec30flushWaitingForPostToWebSocketFT_T_":{"name":"flushWaitingForPostToWebSocket()","abstract":"<p>Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec15parseEngineDataFV10Foundation4DataT_":{"name":"parseEngineData(_:)","abstract":"<p>Parses raw binary received from engine.io.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec18parseEngineMessageFTSS11fromPollingSb_T_":{"name":"parseEngineMessage(_:fromPolling:)","abstract":"<p>Parses a raw engine.io packet.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/s:FP8SocketIO16SocketEngineSpec5writeFTSS8withTypeOS_22SocketEnginePacketType8withDataGSaV10Foundation4Data__T_":{"name":"write(_:withType:withData:)","abstract":"<p>Writes a message to engine.io, independent of transport.</p>","parent_name":"SocketEngineSpec"},"Protocols/SocketEnginePollable.html#/s:vP8SocketIO20SocketEnginePollable11invalidatedSb":{"name":"invalidated","abstract":"<p>MARK: Properties","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:vP8SocketIO20SocketEnginePollable8postWaitGSaSS_":{"name":"postWait","abstract":"<p>A queue of engine.io messages waiting for POSTing</p>","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:vP8SocketIO20SocketEnginePollable7sessionGSqCSo10URLSession_":{"name":"session","abstract":"<p>The URLSession that will be used for polling.</p>","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:vP8SocketIO20SocketEnginePollable14waitingForPollSb":{"name":"waitingForPoll","abstract":"<p><code>true</code> if there is an outstanding poll. Trying to poll before the first is done will cause socket.io to","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:vP8SocketIO20SocketEnginePollable14waitingForPostSb":{"name":"waitingForPost","abstract":"<p><code>true</code> if there is an outstanding post. Trying to post before the first is done will cause socket.io to","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:FP8SocketIO20SocketEnginePollable6doPollFT_T_":{"name":"doPoll()","abstract":"<p>Call to send a long-polling request.</p>","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:FP8SocketIO20SocketEnginePollable15sendPollMessageFTSS8withTypeOS_22SocketEnginePacketType8withDataGSaV10Foundation4Data__T_":{"name":"sendPollMessage(_:withType:withData:)","abstract":"<p>Sends an engine.io message through the polling transport.</p>","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:FP8SocketIO20SocketEnginePollable11stopPollingFT_T_":{"name":"stopPolling()","abstract":"<p>Call to stop polling and invalidate the URLSession.</p>","parent_name":"SocketEnginePollable"},"Protocols/SocketEngineWebsocket.html#/s:FP8SocketIO21SocketEngineWebsocket20sendWebSocketMessageFTSS8withTypeOS_22SocketEnginePacketType8withDataGSaV10Foundation4Data__T_":{"name":"sendWebSocketMessage(_:withType:withData:)","abstract":"<p>Sends an engine.io message through the WebSocket transport.</p>","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineWebsocket.html#/s:FE8SocketIOPS_21SocketEngineWebsocket26websocketDidReceiveMessageFT6socketCS_9WebSocket4textSS_T_":{"name":"websocketDidReceiveMessage(socket:text:)","abstract":"<p>Delegate method for when a message is received.</p>","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineWebsocket.html#/s:FE8SocketIOPS_21SocketEngineWebsocket23websocketDidReceiveDataFT6socketCS_9WebSocket4dataV10Foundation4Data_T_":{"name":"websocketDidReceiveData(socket:data:)","abstract":"<p>Delegate method for when binary is received.</p>","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineWebsocket.html":{"name":"SocketEngineWebsocket","abstract":"<p>Protocol that is used to implement socket.io WebSocket support</p>"},"Protocols/SocketEnginePollable.html":{"name":"SocketEnginePollable","abstract":"<p>Protocol that is used to implement socket.io polling support</p>"},"Protocols/SocketEngineSpec.html":{"name":"SocketEngineSpec","abstract":"<p>Specifies a SocketEngine.</p>"},"Protocols.html#/s:P8SocketIO10SocketData":{"name":"SocketData","abstract":"<p>A marking protocol that says a type can be represented in a socket.io packet.</p>"},"Protocols/SocketLogger.html":{"name":"SocketLogger","abstract":"<p>Represents a class will log client events.</p>"},"Protocols/WebSocketDelegate.html":{"name":"WebSocketDelegate","abstract":"<p>Undocumented</p>"},"Protocols/WebSocketPongDelegate.html":{"name":"WebSocketPongDelegate","abstract":"<p>Undocumented</p>"},"Protocols/SocketEngineClient.html":{"name":"SocketEngineClient","abstract":"<p>Declares that a type will be a delegate to an engine.</p>"},"Protocols/SSLTrustValidator.html":{"name":"SSLTrustValidator","abstract":"<p>Undocumented</p>"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption13connectParamsFMS0_FGVs10DictionarySSP__S0_":{"name":"connectParams","abstract":"<p>A dictionary of GET parameters that will be included in the connect url.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption7cookiesFMS0_FGSaCSo10HTTPCookie_S0_":{"name":"cookies","abstract":"<p>An array of cookies that will be sent during the initial connection.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption16doubleEncodeUTF8FMS0_FSbS0_":{"name":"doubleEncodeUTF8","abstract":"<p>The node.js socket.io currently does funky things to unicode when doing HTTP long-polling. Passing <code>true</code> in","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption12extraHeadersFMS0_FGVs10DictionarySSSS_S0_":{"name":"extraHeaders","abstract":"<p>Any extra HTTP headers that should be sent during the initial connection.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption8forceNewFMS0_FSbS0_":{"name":"forceNew","abstract":"<p>If passed <code>true</code>, will cause the client to always create a new engine. Useful for debugging,","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption12forcePollingFMS0_FSbS0_":{"name":"forcePolling","abstract":"<p>If passed <code>true</code>, the only transport that will be used will be HTTP long-polling.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption15forceWebsocketsFMS0_FSbS0_":{"name":"forceWebsockets","abstract":"<p>If passed <code>true</code>, the only transport that will be used will be WebSockets.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption11handleQueueFMS0_FCSo13DispatchQueueS0_":{"name":"handleQueue","abstract":"<p>The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption3logFMS0_FSbS0_":{"name":"log","abstract":"<p>If passed <code>true</code>, the client will log debug information. This should be turned off in production code.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption6loggerFMS0_FPS_12SocketLogger_S0_":{"name":"logger","abstract":"<p>Used to pass in a custom logger.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption3nspFMS0_FSSS0_":{"name":"nsp","abstract":"<p>The namespace that this client should connect to. Can be changed during use using the <code>joinNamespace</code>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption4pathFMS0_FSSS0_":{"name":"path","abstract":"<p>A custom path to socket.io. Only use this if the socket.io server is configured to look for this path.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption10reconnectsFMS0_FSbS0_":{"name":"reconnects","abstract":"<p>If passed <code>false</code>, the client will not reconnect when it loses connection. Useful if you want full control","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption17reconnectAttemptsFMS0_FSiS0_":{"name":"reconnectAttempts","abstract":"<p>The number of times to try and reconnect before giving up. Pass <code>-1</code> to <a href=\"https://www.youtube.com/watch?v=dQw4w9WgXcQ\">never give up</a>.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption13reconnectWaitFMS0_FSiS0_":{"name":"reconnectWait","abstract":"<p>The number of seconds to wait before reconnect attempts.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption6secureFMS0_FSbS0_":{"name":"secure","abstract":"<p>Set <code>true</code> if your server is using secure transports.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption8securityFMS0_FCS_11SSLSecurityS0_":{"name":"security","abstract":"<p>Allows you to set which certs are valid. Useful for SSL pinning.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption10selfSignedFMS0_FSbS0_":{"name":"selfSigned","abstract":"<p>If you&rsquo;re using a self-signed set. Only use for development.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption15sessionDelegateFMS0_FPSo18URLSessionDelegate_S0_":{"name":"sessionDelegate","abstract":"<p>Sets an NSURLSessionDelegate for the underlying engine. Useful if you need to handle self-signed certs.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:FO8SocketIO20SocketIOClientOption11voipEnabledFMS0_FSbS0_":{"name":"voipEnabled","abstract":"<p>If passed <code>true</code>, the WebSocket transport will try and use voip logic to keep network connections open in","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:vO8SocketIO20SocketIOClientOption11descriptionSS":{"name":"description","abstract":"<p>The description of this option.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:ZFO8SocketIO20SocketIOClientOptionoi2eeFTS0_S0__Sb":{"name":"==(_:_:)","abstract":"<p>Compares whether two options are the same.</p>","parent_name":"SocketIOClientOption"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType4openFMS0_S0_":{"name":"open","abstract":"<p>Open message.</p>","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType5closeFMS0_S0_":{"name":"close","abstract":"<p>Close message.</p>","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType4pingFMS0_S0_":{"name":"ping","abstract":"<p>Ping message.</p>","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType4pongFMS0_S0_":{"name":"pong","abstract":"<p>Pong message.</p>","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType7messageFMS0_S0_":{"name":"message","abstract":"<p>Regular message.</p>","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType7upgradeFMS0_S0_":{"name":"upgrade","abstract":"<p>Upgrade message.</p>","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/s:FO8SocketIO22SocketEnginePacketType4noopFMS0_S0_":{"name":"noop","abstract":"<p>NOOP.</p>","parent_name":"SocketEnginePacketType"},"Enums/SocketAckStatus.html#/s:FO8SocketIO15SocketAckStatus5noAckFMS0_S0_":{"name":"noAck","abstract":"<p>The ack timed out.</p>","parent_name":"SocketAckStatus"},"Enums/SocketIOClientStatus.html#/s:FO8SocketIO20SocketIOClientStatus12notConnectedFMS0_S0_":{"name":"notConnected","abstract":"<p>The client has never been connected. Or the client has been reset.</p>","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientStatus.html#/s:FO8SocketIO20SocketIOClientStatus12disconnectedFMS0_S0_":{"name":"disconnected","abstract":"<p>The client was once connected, but not anymore.</p>","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientStatus.html#/s:FO8SocketIO20SocketIOClientStatus10connectingFMS0_S0_":{"name":"connecting","abstract":"<p>The client is in the process of connecting.</p>","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientStatus.html#/s:FO8SocketIO20SocketIOClientStatus9connectedFMS0_S0_":{"name":"connected","abstract":"<p>The client is currently connected.</p>","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientStatus.html":{"name":"SocketIOClientStatus","abstract":"<p>Represents the state of the client.</p>"},"Enums/SocketAckStatus.html":{"name":"SocketAckStatus","abstract":"<p>The status of an ack.</p>"},"Enums/SocketEnginePacketType.html":{"name":"SocketEnginePacketType","abstract":"<p>Represents the type of engine.io packet types.</p>"},"Enums/SocketIOClientOption.html":{"name":"SocketIOClientOption","abstract":"<p>The options for a client.</p>"},"Global Variables.html#/s:v8SocketIO31WebsocketDidConnectNotificationSS":{"name":"WebsocketDidConnectNotification","abstract":"<p>Undocumented</p>"},"Global Variables.html#/s:v8SocketIO34WebsocketDidDisconnectNotificationSS":{"name":"WebsocketDidDisconnectNotification","abstract":"<p>Undocumented</p>"},"Global Variables.html#/s:v8SocketIO34WebsocketDisconnectionErrorKeyNameSS":{"name":"WebsocketDisconnectionErrorKeyName","abstract":"<p>Undocumented</p>"},"Classes/SocketClientManager.html#/s:iC8SocketIO19SocketClientManager9subscriptFSSGSqCS_14SocketIOClient_":{"name":"subscript(_:)","abstract":"<p>Gets a socket by its name.</p>","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:ZvC8SocketIO19SocketClientManager13sharedManagerS0_":{"name":"sharedManager","abstract":"<p>The shared manager.</p>","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:FC8SocketIO19SocketClientManager9addSocketFTCS_14SocketIOClient9labeledAsSS_T_":{"name":"addSocket(_:labeledAs:)","abstract":"<p>Adds a socket.</p>","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:FC8SocketIO19SocketClientManager12removeSocketFT9withLabelSS_GSqCS_14SocketIOClient_":{"name":"removeSocket(withLabel:)","abstract":"<p>Removes a socket by a given name.</p>","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:FC8SocketIO19SocketClientManager12removeSocketFCS_14SocketIOClientGSqS1__":{"name":"removeSocket(_:)","abstract":"<p>Removes a socket.</p>","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:FC8SocketIO19SocketClientManager13removeSocketsFT_T_":{"name":"removeSockets()","abstract":"<p>Removes all the sockets in the manager.</p>","parent_name":"SocketClientManager"},"Classes/SocketAnyEvent.html#/s:vC8SocketIO14SocketAnyEvent5eventSS":{"name":"event","abstract":"<p>The event name.</p>","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/s:vC8SocketIO14SocketAnyEvent5itemsGSqGSaP___":{"name":"items","abstract":"<p>The data items for this event.</p>","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/s:vC8SocketIO14SocketAnyEvent11descriptionSS":{"name":"description","abstract":"<p>The description of this event.</p>","parent_name":"SocketAnyEvent"},"Classes/SSLSecurity.html#/s:vC8SocketIO11SSLSecurity11validatedDNSb":{"name":"validatedDN","abstract":"<p>Undocumented</p>","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:FC8SocketIO11SSLSecuritycFT13usePublicKeysSb_S0_":{"name":"init(usePublicKeys:)","abstract":"<p>Use certs from main app bundle</p>","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:FC8SocketIO11SSLSecuritycFT5certsGSaCS_7SSLCert_13usePublicKeysSb_S0_":{"name":"init(certs:usePublicKeys:)","abstract":"<p>Designated init</p>","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:FC8SocketIO11SSLSecurity7isValidFTCSo8SecTrust6domainGSqSS__Sb":{"name":"isValid(_:domain:)","abstract":"<p>Valid the trust and domain name.</p>","parent_name":"SSLSecurity"},"Classes/SSLCert.html#/s:FC8SocketIO7SSLCertcFT4dataV10Foundation4Data_S0_":{"name":"init(data:)","abstract":"<p>Designated init for certificates</p>","parent_name":"SSLCert"},"Classes/SSLCert.html#/s:FC8SocketIO7SSLCertcFT3keyCSo6SecKey_S0_":{"name":"init(key:)","abstract":"<p>Designated init for public keys</p>","parent_name":"SSLCert"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode6normalFMS1_S1_":{"name":"normal","abstract":"<p>Undocumented</p>","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode9goingAwayFMS1_S1_":{"name":"goingAway","abstract":"<p>Undocumented</p>","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode13protocolErrorFMS1_S1_":{"name":"protocolError","abstract":"<p>Undocumented</p>","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode21protocolUnhandledTypeFMS1_S1_":{"name":"protocolUnhandledType","abstract":"<p>Undocumented</p>","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode16noStatusReceivedFMS1_S1_":{"name":"noStatusReceived","abstract":"<p>Undocumented</p>","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode8encodingFMS1_S1_":{"name":"encoding","abstract":"<p>Undocumented</p>","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode14policyViolatedFMS1_S1_":{"name":"policyViolated","abstract":"<p>Undocumented</p>","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html#/s:FOC8SocketIO9WebSocket9CloseCode13messageTooBigFMS1_S1_":{"name":"messageTooBig","abstract":"<p>Undocumented</p>","parent_name":"CloseCode"},"Classes/WebSocket/CloseCode.html":{"name":"CloseCode","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:ZvC8SocketIO9WebSocket11ErrorDomainSS":{"name":"ErrorDomain","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket13callbackQueueCSo13DispatchQueue":{"name":"callbackQueue","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket8delegateXwGSqPS_17WebSocketDelegate__":{"name":"delegate","abstract":"<p>Responds to callback about new messages coming in over the WebSocket","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket12pongDelegateXwGSqPS_21WebSocketPongDelegate__":{"name":"pongDelegate","abstract":"<p>Receives a callback for each pong message recived.</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket9onConnectGSqFT_T__":{"name":"onConnect","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket12onDisconnectGSqFGSqCSo7NSError_T__":{"name":"onDisconnect","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6onTextGSqFSST__":{"name":"onText","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6onDataGSqFV10Foundation4DataT__":{"name":"onData","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6onPongGSqFGSqV10Foundation4Data_T__":{"name":"onPong","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket7headersGVs10DictionarySSSS_":{"name":"headers","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket11voipEnabledSb":{"name":"voipEnabled","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket24disableSSLCertValidationSb":{"name":"disableSSLCertValidation","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket8securityGSqPS_17SSLTrustValidator__":{"name":"security","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket22enabledSSLCipherSuitesGSqGSaVs6UInt32__":{"name":"enabledSSLCipherSuites","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket6originGSqSS_":{"name":"origin","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket7timeoutSi":{"name":"timeout","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket11isConnectedSb":{"name":"isConnected","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:vC8SocketIO9WebSocket10currentURLV10Foundation3URL":{"name":"currentURL","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocketcFT3urlV10Foundation3URL9protocolsGSqGSaSS___S0_":{"name":"init(url:protocols:)","abstract":"<p>Used for setting protocols.</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocketcFT3urlV10Foundation3URL13writeQueueQOSOSC16QualityOfService9protocolsGSqGSaSS___S0_":{"name":"init(url:writeQueueQOS:protocols:)","abstract":"<p>Undocumented</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket7connectFT_T_":{"name":"connect()","abstract":"<p>Connect to the WebSocket server on a background thread.</p>","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket10disconnectFT12forceTimeoutGSqSd_9closeCodeVs6UInt16_T_":{"name":"disconnect(forceTimeout:closeCode:)","abstract":"<p>Disconnect from the server. I send a Close control frame to the server, then expect the server to respond with a Close control frame and close the socket from its end. I notify my delegate once the socket has been closed.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket5writeFT6stringSS10completionGSqFT_T___T_":{"name":"write(string:completion:)","abstract":"<p>Write a string to the websocket. This sends it as a text frame.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket5writeFT4dataV10Foundation4Data10completionGSqFT_T___T_":{"name":"write(data:completion:)","abstract":"<p>Write binary data to the websocket. This sends it as a binary frame.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket5writeFT4pingV10Foundation4Data10completionGSqFT_T___T_":{"name":"write(ping:completion:)","abstract":"<p>Write a ping to the websocket. This sends it as a control frame.","parent_name":"WebSocket"},"Classes/WebSocket.html#/s:FC8SocketIO9WebSocket6streamFTCSo6Stream6handleVS1_5Event_T_":{"name":"stream(_:handle:)","abstract":"<p>Delegate for the stream methods. Processes incoming bytes</p>","parent_name":"WebSocket"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient9socketURLV10Foundation3URL":{"name":"socketURL","abstract":"<p>The URL of the socket.io server. This is set in the initializer.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient6engineGSqPS_16SocketEngineSpec__":{"name":"engine","abstract":"<p>The engine for this client.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient6statusOS_20SocketIOClientStatus":{"name":"status","abstract":"<p>The status of this client.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient8forceNewSb":{"name":"forceNew","abstract":"<p>If <code>true</code> then every time <code>connect</code> is called, a new engine will be created.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient11handleQueueCSo13DispatchQueue":{"name":"handleQueue","abstract":"<p>The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient3nspSS":{"name":"nsp","abstract":"<p>The namespace for this client.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient6configVS_27SocketIOClientConfiguration":{"name":"config","abstract":"<p>The configuration for this client.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient10reconnectsSb":{"name":"reconnects","abstract":"<p>If <code>true</code>, this client will try and reconnect on any disconnects.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient13reconnectWaitSi":{"name":"reconnectWait","abstract":"<p>The number of seconds to wait before attempting to reconnect.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient3sidGSqSS_":{"name":"sid","abstract":"<p>The session id of this client.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClientcFT9socketURLV10Foundation3URL6configVS_27SocketIOClientConfiguration_S0_":{"name":"init(socketURL:config:)","abstract":"<p>Type safe way to create a new SocketIOClient. <code>opts</code> can be omitted.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClientcFT9socketURLCSo5NSURL6configGSqCSo12NSDictionary__S0_":{"name":"init(socketURL:config:)","abstract":"<p>Not so type safe way to create a SocketIOClient, meant for Objective-C compatiblity.","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient7connectFT_T_":{"name":"connect()","abstract":"<p>Connect to the server.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient7connectFT12timeoutAfterSi11withHandlerGSqFT_T___T_":{"name":"connect(timeoutAfter:withHandler:)","abstract":"<p>Connect to the server. If we aren&rsquo;t connected after <code>timeoutAfter</code> seconds, then <code>withHandler</code> is called.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient10disconnectFT_T_":{"name":"disconnect()","abstract":"<p>Disconnects the socket.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient4emitFtSSGSaPS_10SocketData___T_":{"name":"emit(_:_:)","abstract":"<p>Send an event to the server, with optional data items.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient4emitFTSS4withGSaP___T_":{"name":"emit(_:with:)","abstract":"<p>Same as emit, but meant for Objective-C</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient11emitWithAckFtSSGSaPS_10SocketData___CS_13OnAckCallback":{"name":"emitWithAck(_:_:)","abstract":"<p>Sends a message to the server, requesting an ack.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient11emitWithAckFTSS4withGSaP___CS_13OnAckCallback":{"name":"emitWithAck(_:with:)","abstract":"<p>Same as emitWithAck, but for Objective-C</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient14engineDidCloseFT6reasonSS_T_":{"name":"engineDidClose(reason:)","abstract":"<p>Called when the engine closes.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient14engineDidErrorFT6reasonSS_T_":{"name":"engineDidError(reason:)","abstract":"<p>Called when the engine errors.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient13engineDidOpenFT6reasonSS_T_":{"name":"engineDidOpen(reason:)","abstract":"<p>Called when the engine opens.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient11handleEventFTSS4dataGSaP__17isInternalMessageSb7withAckSi_T_":{"name":"handleEvent(_:data:isInternalMessage:withAck:)","abstract":"<p>Causes an event to be handled, and any event handlers for that event to be called.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient14leaveNamespaceFT_T_":{"name":"leaveNamespace()","abstract":"<p>Leaves nsp and goes back to the default namespace.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient13joinNamespaceFSST_":{"name":"joinNamespace(_:)","abstract":"<p>Joins <code>namespace</code>.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient3offFSST_":{"name":"off(_:)","abstract":"<p>Removes handler(s) based on an event name.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient3offFT2idV10Foundation4UUID_T_":{"name":"off(id:)","abstract":"<p>Removes a handler with the specified UUID gotten from an <code>on</code> or <code>once</code></p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient2onFTSS8callbackFTGSaP__CS_16SocketAckEmitter_T__V10Foundation4UUID":{"name":"on(_:callback:)","abstract":"<p>Adds a handler for an event.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient4onceFTSS8callbackFTGSaP__CS_16SocketAckEmitter_T__V10Foundation4UUID":{"name":"once(_:callback:)","abstract":"<p>Adds a single-use handler for an event.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient5onAnyFFCS_14SocketAnyEventT_T_":{"name":"onAny(_:)","abstract":"<p>Adds a handler that will be called on every event.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient18parseEngineMessageFSST_":{"name":"parseEngineMessage(_:)","abstract":"<p>Called when the engine has a message that must be parsed.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient21parseEngineBinaryDataFV10Foundation4DataT_":{"name":"parseEngineBinaryData(_:)","abstract":"<p>Called when the engine receives binary data.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient9reconnectFT_T_":{"name":"reconnect()","abstract":"<p>Tries to reconnect to the server.</p>","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:FC8SocketIO14SocketIOClient17removeAllHandlersFT_T_":{"name":"removeAllHandlers()","abstract":"<p>Removes all handlers.","parent_name":"SocketIOClient"},"Classes/OnAckCallback.html#/s:FC8SocketIO13OnAckCallback9timingOutFT5afterSi8callbackFGSaP__T__T_":{"name":"timingOut(after:callback:)","abstract":"<p>Completes an emitWithAck. If this isn&rsquo;t called, the emit never happens.</p>","parent_name":"OnAckCallback"},"Classes/SocketAckEmitter.html#/s:vC8SocketIO16SocketAckEmitter8expectedSb":{"name":"expected","abstract":"<p>If true, this handler is expecting to be acked. Call <code>with(_: SocketData...)</code> to ack.</p>","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:FC8SocketIO16SocketAckEmitter4withFtGSaPS_10SocketData___T_":{"name":"with(_:)","abstract":"<p>Call to ack receiving this event.</p>","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:FC8SocketIO16SocketAckEmitter4withFGSaP__T_":{"name":"with(_:)","abstract":"<p>Call to ack receiving this event.</p>","parent_name":"SocketAckEmitter"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine11engineQueueCSo13DispatchQueue":{"name":"engineQueue","abstract":"<p>The queue that all engine actions take place on.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine13connectParamsGSqGVs10DictionarySSP___":{"name":"connectParams","abstract":"<p>The connect parameters sent during a connect.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine8postWaitGSaSS_":{"name":"postWait","abstract":"<p>A queue of engine.io messages waiting for POSTing</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine14waitingForPollSb":{"name":"waitingForPoll","abstract":"<p><code>true</code> if there is an outstanding poll. Trying to poll before the first is done will cause socket.io to","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine14waitingForPostSb":{"name":"waitingForPost","abstract":"<p><code>true</code> if there is an outstanding post. Trying to post before the first is done will cause socket.io to","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine6closedSb":{"name":"closed","abstract":"<p><code>true</code> if this engine is closed.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine9connectedSb":{"name":"connected","abstract":"<p><code>true</code> if this engine is connected. Connected means that the initial poll connect has succeeded.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine7cookiesGSqGSaCSo10HTTPCookie__":{"name":"cookies","abstract":"<p>An array of HTTPCookies that are sent during the connection.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine16doubleEncodeUTF8Sb":{"name":"doubleEncodeUTF8","abstract":"<p>Set to <code>true</code> if using the node.js version of socket.io. The node.js version of socket.io","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine12extraHeadersGSqGVs10DictionarySSSS__":{"name":"extraHeaders","abstract":"<p>A dictionary of extra http headers that will be set during connection.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine11fastUpgradeSb":{"name":"fastUpgrade","abstract":"<p>When <code>true</code>, the engine is in the process of switching to WebSockets.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine12forcePollingSb":{"name":"forcePolling","abstract":"<p>When <code>true</code>, the engine will only use HTTP long-polling as a transport.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine15forceWebsocketsSb":{"name":"forceWebsockets","abstract":"<p>When <code>true</code>, the engine will only use WebSockets as a transport.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine11invalidatedSb":{"name":"invalidated","abstract":"<p><code>true</code> If engine&rsquo;s session has been invalidated.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine7pollingSb":{"name":"polling","abstract":"<p>If <code>true</code>, the engine is currently in HTTP long-polling mode.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine7probingSb":{"name":"probing","abstract":"<p>If <code>true</code>, the engine is currently seeing whether it can upgrade to WebSockets.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine7sessionGSqCSo10URLSession_":{"name":"session","abstract":"<p>The URLSession that will be used for polling.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine3sidSS":{"name":"sid","abstract":"<p>The session id for this engine.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine10socketPathSS":{"name":"socketPath","abstract":"<p>The path to engine.io.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine10urlPollingV10Foundation3URL":{"name":"urlPolling","abstract":"<p>The url for polling.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine12urlWebSocketV10Foundation3URL":{"name":"urlWebSocket","abstract":"<p>The url for WebSockets.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine9websocketSb":{"name":"websocket","abstract":"<p>If <code>true</code>, then the engine is currently in WebSockets mode.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine2wsGSqCS_9WebSocket_":{"name":"ws","abstract":"<p>The WebSocket for this engine.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:vC8SocketIO12SocketEngine6clientXwGSqPS_18SocketEngineClient__":{"name":"client","abstract":"<p>The client for this engine.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEnginecFT6clientPS_18SocketEngineClient_3urlV10Foundation3URL6configVS_27SocketIOClientConfiguration_S0_":{"name":"init(client:url:config:)","abstract":"<p>Creates a new engine.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEnginecFT6clientPS_18SocketEngineClient_3urlV10Foundation3URL7optionsGSqCSo12NSDictionary__S0_":{"name":"init(client:url:options:)","abstract":"<p>Creates a new engine.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine7connectFT_T_":{"name":"connect()","abstract":"<p>Starts the connection to the server.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine8didErrorFT6reasonSS_T_":{"name":"didError(reason:)","abstract":"<p>Called when an error happens during execution. Causes a disconnection.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine10disconnectFT6reasonSS_T_":{"name":"disconnect(reason:)","abstract":"<p>Disconnects from the server.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine13doFastUpgradeFT_T_":{"name":"doFastUpgrade()","abstract":"<p>Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine30flushWaitingForPostToWebSocketFT_T_":{"name":"flushWaitingForPostToWebSocket()","abstract":"<p>Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine15parseEngineDataFV10Foundation4DataT_":{"name":"parseEngineData(_:)","abstract":"<p>Parses raw binary received from engine.io.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine18parseEngineMessageFTSS11fromPollingSb_T_":{"name":"parseEngineMessage(_:fromPolling:)","abstract":"<p>Parses a raw engine.io packet.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine5writeFTSS8withTypeOS_22SocketEnginePacketType8withDataGSaV10Foundation4Data__T_":{"name":"write(_:withType:withData:)","abstract":"<p>Writes a message to engine.io, independent of transport.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine19websocketDidConnectFT6socketCS_9WebSocket_T_":{"name":"websocketDidConnect(socket:)","abstract":"<p>Delegate method for connection.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine22websocketDidDisconnectFT6socketCS_9WebSocket5errorGSqCSo7NSError__T_":{"name":"websocketDidDisconnect(socket:error:)","abstract":"<p>Delegate method for disconnection.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:FC8SocketIO12SocketEngine10URLSessionFT7sessionCSo10URLSession25didBecomeInvalidWithErrorGSqCSo7NSError__T_":{"name":"URLSession(session:didBecomeInvalidWithError:)","abstract":"<p>Delegate called when the session becomes invalid.</p>","parent_name":"SocketEngine"},"Classes/SocketEngine.html":{"name":"SocketEngine","abstract":"<p>The class that handles the engine.io protocol and transports."},"Classes/SocketAckEmitter.html":{"name":"SocketAckEmitter","abstract":"<p>A class that represents a waiting ack call.</p>"},"Classes/OnAckCallback.html":{"name":"OnAckCallback","abstract":"<p>A class that represents an emit that will request an ack that has not yet been sent."},"Classes/SocketIOClient.html":{"name":"SocketIOClient","abstract":"<p>The main class for SocketIOClientSwift.</p>"},"Classes/WebSocket.html":{"name":"WebSocket","abstract":"<p>Undocumented</p>"},"Classes/SSLCert.html":{"name":"SSLCert","abstract":"<p>Undocumented</p>"},"Classes/SSLSecurity.html":{"name":"SSLSecurity","abstract":"<p>Undocumented</p>"},"Classes/SocketAnyEvent.html":{"name":"SocketAnyEvent","abstract":"<p>Represents some event that was received.</p>"},"Classes/SocketClientManager.html":{"name":"SocketClientManager","abstract":"<p>Experimental socket manager.</p>"},"Classes.html":{"name":"Classes","abstract":"<p>The following classes are available globally.</p>"},"Global Variables.html":{"name":"Global Variables","abstract":"<p>The following global variables are available globally.</p>"},"Enums.html":{"name":"Enums","abstract":"<p>The following enums are available globally.</p>"},"Protocols.html":{"name":"Protocols","abstract":"<p>The following protocols are available globally.</p>"},"Structs.html":{"name":"Structs","abstract":"<p>The following structs are available globally.</p>"},"Typealiases.html":{"name":"Typealiases","abstract":"<p>The following typealiases are available globally.</p>"}}