A typealias for an ack callback.
"},"Typealiases.html#/s:8SocketIO14NormalCallbacka":{"name":"NormalCallback","abstract":"A typealias for a normal callback.
"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV7Elementa":{"name":"Element","abstract":"Type of element stored.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa":{"name":"Index","abstract":"Index type.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV8Iteratora":{"name":"Iterator","abstract":"Iterator type.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV11SubSequencea":{"name":"SubSequence","abstract":"SubSequence type.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV10startIndexSiv":{"name":"startIndex","abstract":"The start index of this collection.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV8endIndexSiv":{"name":"endIndex","abstract":"The end index of this collection.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV7isEmptySbv":{"name":"isEmpty","abstract":"Whether this collection is empty.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5countSiv":{"name":"count","abstract":"The number of elements stored in this collection.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5firstAA0aC6OptionOSgv":{"name":"first","abstract":"The first element in this collection.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationVACSayAA0aC6OptionOG12arrayLiterald_tcfc":{"name":"init(arrayLiteral:)","abstract":"Creates a new SocketIOClientConfiguration from an array literal.
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.
An array-like type that holds SocketIOClientOptions
Whether to log or not
","parent_name":"SocketLogger"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP3logySSyXK_SS4typetF":{"name":"log(_:type:)","abstract":"Normal log messages
","parent_name":"SocketLogger"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP5errorySSyXK_SS4typetF":{"name":"error(_:type:)","abstract":"Error Messages
","parent_name":"SocketLogger"},"Protocols/SocketData.html#/s:8SocketIO0A4DataP20socketRepresentationAaB_pyKF":{"name":"socketRepresentation()","abstract":"A representation of self that can sent over socket.io.
","parent_name":"SocketData"},"Protocols/SocketEngineWebsocket.html#/s:8SocketIO0A15EngineWebsocketP07sendWebA7MessageySS_AA0aC10PacketTypeO04withI0Say10Foundation4DataVG0jL0tF":{"name":"sendWebSocketMessage(_:withType:withData:)","abstract":"Sends an engine.io message through the WebSocket transport.
","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineWebsocket.html#/s:8SocketIO0A15EngineWebsocketPAAE26websocketDidReceiveMessagey010StarscreamaB003WebA0C6socket_SS4texttF":{"name":"websocketDidReceiveMessage(socket:text:)","abstract":"Delegate method for when a message is received.
","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEngineWebsocket.html#/s:8SocketIO0A15EngineWebsocketPAAE23websocketDidReceiveDatay010StarscreamaB003WebA0C6socket_10Foundation0H0V4datatF":{"name":"websocketDidReceiveData(socket:data:)","abstract":"Delegate method for when binary is received.
","parent_name":"SocketEngineWebsocket"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP11invalidatedSbv":{"name":"invalidated","abstract":"MARK: Properties","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP8postWaitSaySSGv":{"name":"postWait","abstract":"
A queue of engine.io messages waiting for POSTing
","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP7sessionSo10URLSessionCSgv":{"name":"session","abstract":"The URLSession that will be used for polling.
","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP14waitingForPollSbv":{"name":"waitingForPoll","abstract":"true if there is an outstanding poll. Trying to poll before the first is done will cause socket.io to","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP14waitingForPostSbv":{"name":"waitingForPost","abstract":"
true if there is an outstanding post. Trying to post before the first is done will cause socket.io to","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP6doPollyyF":{"name":"doPoll()","abstract":"
Call to send a long-polling request.
","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP15sendPollMessageySS_AA0aC10PacketTypeO04withI0Say10Foundation4DataVG0jL0tF":{"name":"sendPollMessage(_:withType:withData:)","abstract":"Sends an engine.io message through the polling transport.
","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP11stopPollingyyF":{"name":"stopPolling()","abstract":"Call to stop polling and invalidate the URLSession.
","parent_name":"SocketEnginePollable"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidErrorWithReason:":{"name":"engineDidError(reason:)","abstract":"Called when the engine errors.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidCloseWithReason:":{"name":"engineDidClose(reason:)","abstract":"Called when the engine closes.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidOpenWithReason:":{"name":"engineDidOpen(reason:)","abstract":"Called when the engine opens.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"Called when the engine has a message that must be parsed.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineBinaryData:":{"name":"parseEngineBinaryData(_:)","abstract":"Called when the engine receives binary data.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)client":{"name":"client","abstract":"The client for this engine.
","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)closed":{"name":"closed","abstract":"true if this engine is closed.
true if this engine is connected. Connected means that the initial poll connect has succeeded.
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.
When true, the engine will only use HTTP long-polling as a transport.
When true, the engine will only use WebSockets as a transport.
If true, the engine is currently in HTTP long-polling mode.
If true, the engine is currently seeing whether it can upgrade to WebSockets.
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.
The WebSocket for this engine.
","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)initWithClient:url:options:":{"name":"init(client:url:options:)","abstract":"Creates a new engine.
","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)connect":{"name":"connect()","abstract":"Starts the connection to the server.
","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)didErrorWithReason:":{"name":"didError(reason:)","abstract":"Called when an error happens during execution. Causes a disconnection.
","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)disconnectWithReason:":{"name":"disconnect(reason:)","abstract":"Disconnects from the server.
","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)doFastUpgrade":{"name":"doFastUpgrade()","abstract":"Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)flushWaitingForPostToWebSocket":{"name":"flushWaitingForPostToWebSocket()","abstract":"
Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)parseEngineData:":{"name":"parseEngineData(_:)","abstract":"
Parses raw binary received from engine.io.
","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"Parses a raw engine.io packet.
","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)write:withType:withData:":{"name":"write(_:withType:withData:)","abstract":"Writes a message to engine.io, independent of transport.
","parent_name":"SocketEngineSpec"},"Protocols/SocketEngineSpec.html":{"name":"SocketEngineSpec","abstract":"Specifies a SocketEngine.
"},"Protocols/SocketEngineClient.html":{"name":"SocketEngineClient","abstract":"Declares that a type will be a delegate to an engine.
"},"Protocols/SocketEnginePollable.html":{"name":"SocketEnginePollable","abstract":"Protocol that is used to implement socket.io polling support
"},"Protocols/SocketEngineWebsocket.html":{"name":"SocketEngineWebsocket","abstract":"Protocol that is used to implement socket.io WebSocket support
"},"Protocols/SocketData.html":{"name":"SocketData","abstract":"A marking protocol that says a type can be represented in a socket.io packet.
"},"Protocols/SocketLogger.html":{"name":"SocketLogger","abstract":"Represents a class will log client events.
"},"Enums/SocketIOClientStatus.html#/c:@M@SocketIO@E@SocketIOClientStatus@SocketIOClientStatusNotConnected":{"name":"notConnected","abstract":"The client has never been connected. Or the client has been reset.
","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientStatus.html#/c:@M@SocketIO@E@SocketIOClientStatus@SocketIOClientStatusDisconnected":{"name":"disconnected","abstract":"The client was once connected, but not anymore.
","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientStatus.html#/c:@M@SocketIO@E@SocketIOClientStatus@SocketIOClientStatusConnecting":{"name":"connecting","abstract":"The client is in the process of connecting.
","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientStatus.html#/c:@M@SocketIO@E@SocketIOClientStatus@SocketIOClientStatusConnected":{"name":"connected","abstract":"The client is currently connected.
","parent_name":"SocketIOClientStatus"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8compressA2CmF":{"name":"compress","abstract":"If given, the WebSocket transport will attempt to use compression.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO13connectParamsACs10DictionaryVySSypGcACmF":{"name":"connectParams","abstract":"A dictionary of GET parameters that will be included in the connect url.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO7cookiesACSaySo10HTTPCookieCGcACmF":{"name":"cookies","abstract":"An array of cookies that will be sent during the initial connection.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO16doubleEncodeUTF8ACSbcACmF":{"name":"doubleEncodeUTF8","abstract":"Deprecated
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO12extraHeadersACs10DictionaryVyS2SGcACmF":{"name":"extraHeaders","abstract":"Any extra HTTP headers that should be sent during the initial connection.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8forceNewACSbcACmF":{"name":"forceNew","abstract":"If passed true, will cause the client to always create a new engine. Useful for debugging,","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO12forcePollingACSbcACmF":{"name":"forcePolling","abstract":"
If passed true, the only transport that will be used will be HTTP long-polling.
If passed true, the only transport that will be used will be WebSockets.
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.
Used to pass in a custom logger.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO3nspACSScACmF":{"name":"nsp","abstract":"The namespace that this client should connect to. Can be changed during use using the joinNamespace","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO4pathACSScACmF":{"name":"path","abstract":"
A custom path to socket.io. Only use this if the socket.io server is configured to look for this path.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO10reconnectsACSbcACmF":{"name":"reconnects","abstract":"If passed false, the client will not reconnect when it loses connection. Useful if you want full control","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO17reconnectAttemptsACSicACmF":{"name":"reconnectAttempts","abstract":"
The number of times to try and reconnect before giving up. Pass -1 to never give up.
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.
Allows you to set which certs are valid. Useful for SSL pinning.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO10selfSignedACSbcACmF":{"name":"selfSigned","abstract":"If you’re using a self-signed set. Only use for development.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO15sessionDelegateACSo010URLSessionF0_pcACmF":{"name":"sessionDelegate","abstract":"Sets an NSURLSessionDelegate for the underlying engine. Useful if you need to handle self-signed certs.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO11voipEnabledACSbcACmF":{"name":"voipEnabled","abstract":"If passed true, the WebSocket transport will try and use voip logic to keep network connections open in","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO11descriptionSSv":{"name":"description","abstract":"
The description of this option.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO2eeoiSbAC_ACtFZ":{"name":"==(_:_:)","abstract":"Compares whether two options are the same.
","parent_name":"SocketIOClientOption"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO7connectA2CmF":{"name":"connect","abstract":"Emitted when the client connects. This is also called on a successful reconnection. A connect event gets one","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO10disconnectA2CmF":{"name":"disconnect","abstract":"
Called when the socket has disconnected and will not attempt to try to reconnect.
","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO5errorA2CmF":{"name":"error","abstract":"Called when an error occurs.
","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO9reconnectA2CmF":{"name":"reconnect","abstract":"Called when the client begins the reconnection process.
","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO16reconnectAttemptA2CmF":{"name":"reconnectAttempt","abstract":"Called each time the client tries to reconnect to the server.
","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO12statusChangeA2CmF":{"name":"statusChange","abstract":"Called every time there is a change in the client’s status.
","parent_name":"SocketClientEvent"},"Enums/SocketAckStatus.html#/s:8SocketIO0A9AckStatusO02noC0A2CmF":{"name":"noAck","abstract":"The ack timed out.
","parent_name":"SocketAckStatus"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeOpen":{"name":"open","abstract":"Open message.
","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeClose":{"name":"close","abstract":"Close message.
","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypePing":{"name":"ping","abstract":"Ping message.
","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypePong":{"name":"pong","abstract":"Pong message.
","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeMessage":{"name":"message","abstract":"Regular message.
","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeUpgrade":{"name":"upgrade","abstract":"Upgrade message.
","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html#/c:@M@SocketIO@E@SocketEnginePacketType@SocketEnginePacketTypeNoop":{"name":"noop","abstract":"NOOP.
","parent_name":"SocketEnginePacketType"},"Enums/SocketEnginePacketType.html":{"name":"SocketEnginePacketType","abstract":"Represents the type of engine.io packet types.
"},"Enums/SocketAckStatus.html":{"name":"SocketAckStatus","abstract":"The status of an ack.
"},"Enums/SocketClientEvent.html":{"name":"SocketClientEvent","abstract":"The set of events that are generated by the client.
"},"Enums/SocketIOClientOption.html":{"name":"SocketIOClientOption","abstract":"The options for a client.
"},"Enums/SocketIOClientStatus.html":{"name":"SocketIOClientStatus","abstract":"Represents the state of the client.
"},"Classes/SocketClientManager.html#/c:@M@SocketIO@objc(cs)SocketClientManager(cpy)sharedManager":{"name":"sharedManager","abstract":"The shared manager.
","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/s:8SocketIO0A13ClientManagerC9subscriptAA0A8IOClientCSgSSci":{"name":"subscript(_:)","abstract":"Gets a socket by its name.
","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/c:@M@SocketIO@objc(cs)SocketClientManager(im)addSocket:labeledAs:":{"name":"addSocket(_:labeledAs:)","abstract":"Adds a socket.
","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/c:@M@SocketIO@objc(cs)SocketClientManager(im)removeSocketWithLabel:":{"name":"removeSocket(withLabel:)","abstract":"Removes a socket by a given name.
","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/c:@M@SocketIO@objc(cs)SocketClientManager(im)removeSocket:":{"name":"removeSocket(_:)","abstract":"Removes a socket.
","parent_name":"SocketClientManager"},"Classes/SocketClientManager.html#/c:@M@SocketIO@objc(cs)SocketClientManager(im)removeSockets":{"name":"removeSockets()","abstract":"Removes all the sockets in the manager.
","parent_name":"SocketClientManager"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)engine":{"name":"engine","abstract":"The engine for this client.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)status":{"name":"status","abstract":"The status of this client.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)forceNew":{"name":"forceNew","abstract":"If true then every time connect is called, a new engine will be created.
The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)nsp":{"name":"nsp","abstract":"
The namespace for this client.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC6configAA0aC13ConfigurationVv":{"name":"config","abstract":"The configuration for this client.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)reconnects":{"name":"reconnects","abstract":"If true, this client will try and reconnect on any disconnects.
The number of seconds to wait before attempting to reconnect.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)sid":{"name":"sid","abstract":"The session id of this client.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)socketURL":{"name":"socketURL","abstract":"The URL of the socket.io server.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientCAC10Foundation3URLV06socketE0_AA0aC13ConfigurationV6configtcfc":{"name":"init(socketURL:config:)","abstract":"Type safe way to create a new SocketIOClient. opts can be omitted.
Not so type safe way to create a SocketIOClient, meant for Objective-C compatiblity.","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)connect":{"name":"connect()","abstract":"
Connect to the server.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)connectWithTimeoutAfter:withHandler:":{"name":"connect(timeoutAfter:withHandler:)","abstract":"Connect to the server. If we aren’t connected after timeoutAfter seconds, then withHandler is called.
Disconnects the socket.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC4emitySS_SayAA0A4Data_pGdtF":{"name":"emit(_:_:)","abstract":"Send an event to the server, with optional data items.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)emit:with:":{"name":"emit(_:with:)","abstract":"Same as emit, but meant for Objective-C
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC11emitWithAckAA02OnF8CallbackCSS_SayAA0A4Data_pGdtF":{"name":"emitWithAck(_:_:)","abstract":"Sends a message to the server, requesting an ack.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)emitWithAck:with:":{"name":"emitWithAck(_:with:)","abstract":"Same as emitWithAck, but for Objective-C
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)engineDidCloseWithReason:":{"name":"engineDidClose(reason:)","abstract":"Called when the engine closes.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)engineDidErrorWithReason:":{"name":"engineDidError(reason:)","abstract":"Called when the engine errors.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)engineDidOpenWithReason:":{"name":"engineDidOpen(reason:)","abstract":"Called when the engine opens.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)handleEvent:data:isInternalMessage:withAck:":{"name":"handleEvent(_:data:isInternalMessage:withAck:)","abstract":"Causes an event to be handled, and any event handlers for that event to be called.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)leaveNamespace":{"name":"leaveNamespace()","abstract":"Leaves nsp and goes back to the default namespace.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)joinNamespace:":{"name":"joinNamespace(_:)","abstract":"Joins namespace.
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
Adds a handler for an event.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC2on10Foundation4UUIDVAA0A11ClientEventO06clientH0_ySayypG_AA0A10AckEmitterCtc8callbacktF":{"name":"on(clientEvent:callback:)","abstract":"Adds a handler for a client event.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC4once10Foundation4UUIDVAA0A11ClientEventO06clientH0_ySayypG_AA0A10AckEmitterCtc8callbacktF":{"name":"once(clientEvent:callback:)","abstract":"Adds a single-use handler for a client event.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)once:callback:":{"name":"once(_:callback:)","abstract":"Adds a single-use handler for an event.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)onAny:":{"name":"onAny(_:)","abstract":"Adds a handler that will be called on every event.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"Called when the engine has a message that must be parsed.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)parseEngineBinaryData:":{"name":"parseEngineBinaryData(_:)","abstract":"Called when the engine receives binary data.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)reconnect":{"name":"reconnect()","abstract":"Tries to reconnect to the server.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)removeAllHandlers":{"name":"removeAllHandlers()","abstract":"Removes all handlers.","parent_name":"SocketIOClient"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)event":{"name":"event","abstract":"
The event name.
","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)items":{"name":"items","abstract":"The data items for this event.
","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)description":{"name":"description","abstract":"The description of this event.
","parent_name":"SocketAnyEvent"},"Classes/OnAckCallback.html#/c:@M@SocketIO@objc(cs)OnAckCallback(im)timingOutAfter:callback:":{"name":"timingOut(after:callback:)","abstract":"Completes an emitWithAck. If this isn’t called, the emit never happens.
","parent_name":"OnAckCallback"},"Classes/SocketAckEmitter.html#/c:@M@SocketIO@objc(cs)SocketAckEmitter(py)expected":{"name":"expected","abstract":"If true, this handler is expecting to be acked. Call with(_: SocketData...) to ack.
Call to ack receiving this event.
","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/c:@M@SocketIO@objc(cs)SocketAckEmitter(im)with:":{"name":"with(_:)","abstract":"Call to ack receiving this event.
","parent_name":"SocketAckEmitter"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)engineQueue":{"name":"engineQueue","abstract":"The queue that all engine actions take place on.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)connectParams":{"name":"connectParams","abstract":"The connect parameters sent during a connect.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)postWait":{"name":"postWait","abstract":"A queue of engine.io messages waiting for POSTing
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)waitingForPoll":{"name":"waitingForPoll","abstract":"true if there is an outstanding poll. Trying to poll before the first is done will cause socket.io to","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)waitingForPost":{"name":"waitingForPost","abstract":"
true if there is an outstanding post. Trying to post before the first is done will cause socket.io to","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)closed":{"name":"closed","abstract":"
true if this engine is closed.
If true the engine will attempt to use WebSocket compression.
true if this engine is connected. Connected means that the initial poll connect has succeeded.
An array of HTTPCookies that are sent during the connection.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)extraHeaders":{"name":"extraHeaders","abstract":"A dictionary of extra http headers that will be set during connection.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)fastUpgrade":{"name":"fastUpgrade","abstract":"When true, the engine is in the process of switching to WebSockets.
When true, the engine will only use HTTP long-polling as a transport.
When true, the engine will only use WebSockets as a transport.
true If engine’s session has been invalidated.
If true, the engine is currently in HTTP long-polling mode.
If true, the engine is currently seeing whether it can upgrade to WebSockets.
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.
The WebSocket for this engine.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)client":{"name":"client","abstract":"The client for this engine.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineCAcA0aC6Client_p6client_10Foundation3URLV3urlAA0A21IOClientConfigurationV6configtcfc":{"name":"init(client:url:config:)","abstract":"Creates a new engine.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)initWithClient:url:options:":{"name":"init(client:url:options:)","abstract":"Creates a new engine.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)connect":{"name":"connect()","abstract":"Starts the connection to the server.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)didErrorWithReason:":{"name":"didError(reason:)","abstract":"Called when an error happens during execution. Causes a disconnection.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)disconnectWithReason:":{"name":"disconnect(reason:)","abstract":"Disconnects from the server.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)doFastUpgrade":{"name":"doFastUpgrade()","abstract":"Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)flushWaitingForPostToWebSocket":{"name":"flushWaitingForPostToWebSocket()","abstract":"
Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineData:":{"name":"parseEngineData(_:)","abstract":"
Parses raw binary received from engine.io.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"Parses a raw engine.io packet.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)write:withType:withData:":{"name":"write(_:withType:withData:)","abstract":"Writes a message to engine.io, independent of transport.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)websocketDidConnectWithSocket:":{"name":"websocketDidConnect(socket:)","abstract":"Delegate method for connection.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)websocketDidDisconnectWithSocket:error:":{"name":"websocketDidDisconnect(socket:error:)","abstract":"Delegate method for disconnection.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@CM@SocketIO@objc(cs)SocketEngine(im)URLSessionWithSession:didBecomeInvalidWithError:":{"name":"URLSession(session:didBecomeInvalidWithError:)","abstract":"Delegate called when the session becomes invalid.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html":{"name":"SocketEngine","abstract":"The class that handles the engine.io protocol and transports."},"Classes/SocketAckEmitter.html":{"name":"SocketAckEmitter","abstract":"
A class that represents a waiting ack call.
"},"Classes/OnAckCallback.html":{"name":"OnAckCallback","abstract":"A class that represents an emit that will request an ack that has not yet been sent."},"Classes/SocketAnyEvent.html":{"name":"SocketAnyEvent","abstract":"
Represents some event that was received.
"},"Classes/SocketIOClient.html":{"name":"SocketIOClient","abstract":"The main class for SocketIOClientSwift.
"},"Classes/SocketClientManager.html":{"name":"SocketClientManager","abstract":"Experimental socket manager.
"},"faq.html":{"name":"FAQ"},"Guides.html":{"name":"Guides","abstract":"The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Enums.html":{"name":"Enums","abstract":"The following enums are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structs","abstract":"The following structs are available globally.
"},"Typealiases.html":{"name":"Typealiases","abstract":"The following typealiases are available globally.
"}}