A typealias for an ack callback.
"},"Typealiases.html#/s:8SocketIO14NormalCallbacka":{"name":"NormalCallback","abstract":"A typealias for a normal callback.
"},"Typealiases.html#/s:8SocketIO4Posta":{"name":"Post","abstract":"A typealias for a queued POST
"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO7connectyA2EmF":{"name":"connect","abstract":"Connect: 0
","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO10disconnectyA2EmF":{"name":"disconnect","abstract":"Disconnect: 1
","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO5eventyA2EmF":{"name":"event","abstract":"Event: 2
","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO3ackyA2EmF":{"name":"ack","abstract":"Ack: 3
","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO5erroryA2EmF":{"name":"error","abstract":"Error: 4
","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO11binaryEventyA2EmF":{"name":"binaryEvent","abstract":"Binary Event: 5
","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO9binaryAckyA2EmF":{"name":"binaryAck","abstract":"Binary Ack: 6
","parent_name":"PacketType"},"Structs/SocketPacket/PacketType.html#/s:8SocketIO0A6PacketV0C4TypeO8isBinarySbvp":{"name":"isBinary","abstract":"Whether or not this type is binary
","parent_name":"PacketType"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV3nspSSvp":{"name":"nsp","abstract":"The namespace for this packet.
","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV2idSivp":{"name":"id","abstract":"If > 0 then this packet is using acking.
","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV4typeAC0C4TypeOvp":{"name":"type","abstract":"The type of this packet.
","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV6binarySay10Foundation4DataVGvp":{"name":"binary","abstract":"An array of binary data for this packet.
","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV4dataSayypGvp":{"name":"data","abstract":"The data for this event.
","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV4argsSayypGvp":{"name":"args","abstract":"Returns the payload for this packet, minus the event name if this is an event or binaryEvent type packet.
","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV11descriptionSSvp":{"name":"description","abstract":"A string representation of this packet.
","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV5eventSSvp":{"name":"event","abstract":"The event name for this packet.
","parent_name":"SocketPacket"},"Structs/SocketPacket.html#/s:8SocketIO0A6PacketV12packetStringSSvp":{"name":"packetString","abstract":"A string representation of this packet.
","parent_name":"SocketPacket"},"Structs/SocketPacket/PacketType.html":{"name":"PacketType","abstract":"The type of packets.
","parent_name":"SocketPacket"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV7Elementa":{"name":"Element","abstract":"Type of element stored.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa":{"name":"Index","abstract":"Index type.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV8Iteratora":{"name":"Iterator","abstract":"Iterator type.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV11SubSequencea":{"name":"SubSequence","abstract":"SubSequence type.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV10startIndexSivp":{"name":"startIndex","abstract":"The start index of this collection.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV8endIndexSivp":{"name":"endIndex","abstract":"The end index of this collection.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV7isEmptySbvp":{"name":"isEmpty","abstract":"Whether this collection is empty.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5countSivp":{"name":"count","abstract":"The number of elements stored in this collection.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5firstAA0aC6OptionOSgvp":{"name":"first","abstract":"The first element in this collection.
","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:Sly7ElementQz5IndexQzcip":{"name":"subscript(_:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:Sly11SubSequenceQzSny5IndexQzGcip":{"name":"subscript(_:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV12arrayLiteralAcA0aC6OptionOd_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:8SocketIO0A21IOClientConfigurationV5index5afterS2i_tF":{"name":"index(after:)","parent_name":"SocketIOClientConfiguration"},"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV6insert_9replacingyAA0aC6OptionO_SbtF":{"name":"insert(_:replacing:)","abstract":"Special method that inserts element into the collection, replacing any other instances of element.
The event for this handler.
","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV2id10Foundation4UUIDVvp":{"name":"id","abstract":"A unique identifier for this handler.
","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV8callbackyySayypG_AA0A10AckEmitterCtcvp":{"name":"callback","abstract":"The actual handler function.
","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV15executeCallback4with0G3Ack0gA0ySayypG_SiAA0A8IOClientCtF":{"name":"executeCallback(with:withAck:withSocket:)","abstract":"Causes this handler to be executed.
","parent_name":"SocketEventHandler"},"Structs/SocketEventHandler.html":{"name":"SocketEventHandler","abstract":"A wrapper around a handler.
"},"Structs/SocketIOClientConfiguration.html":{"name":"SocketIOClientConfiguration","abstract":"An array-like type that holds SocketIOClientOptions
A struct that represents a socket.io packet.
"},"Protocols/SocketData.html#/s:8SocketIO0A4DataP20socketRepresentationAaB_pyKF":{"name":"socketRepresentation()","abstract":"A representation of self that can sent over socket.io.
","parent_name":"SocketData"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP3logSbvp":{"name":"log","abstract":"Whether to log or not
","parent_name":"SocketLogger"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP3log_4typeySSyXK_SStF":{"name":"log(_:type:)","abstract":"Normal log messages
","parent_name":"SocketLogger"},"Protocols/SocketLogger.html#/s:8SocketIO0A6LoggerP5error_4typeySSyXK_SStF":{"name":"error(_:type:)","abstract":"Error Messages
","parent_name":"SocketLogger"},"Protocols/SocketDataBufferable.html#/s:8SocketIO0A14DataBufferableP14waitingPacketsSayAA0A6PacketVGvp":{"name":"waitingPackets","abstract":"A list of packets that are waiting for binary data.
","parent_name":"SocketDataBufferable"},"Protocols/SocketParsable.html#/s:8SocketIO0A8ParsableP15parseBinaryDatayAA0A6PacketVSg10Foundation0F0VF":{"name":"parseBinaryData(_:)","abstract":"Called when the engine has received some binary data that should be attached to a packet.
","parent_name":"SocketParsable"},"Protocols/SocketParsable.html#/s:8SocketIO0A8ParsableP05parseA7MessageyAA0A6PacketVSgSSF":{"name":"parseSocketMessage(_:)","abstract":"Called when the engine has received a string that should be parsed into a socket.io packet.
","parent_name":"SocketParsable"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)defaultSocket":{"name":"defaultSocket","abstract":"Returns the socket associated with the default namespace (/
).
The engine for this manager.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)forceNew":{"name":"forceNew","abstract":"If true then every time connect is called, a new engine will be created.
The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)nsps":{"name":"nsps","abstract":"
The sockets in this manager indexed by namespace.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnects":{"name":"reconnects","abstract":"If true, this manager will try and reconnect on any disconnects.
The minimum number of seconds to wait before attempting to reconnect.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnectWaitMax":{"name":"reconnectWaitMax","abstract":"The maximum number of seconds to wait before attempting to reconnect.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)randomizationFactor":{"name":"randomizationFactor","abstract":"The randomization factor for calculating reconnect jitter.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)socketURL":{"name":"socketURL","abstract":"The URL of the socket.io server.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)status":{"name":"status","abstract":"The status of this manager.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)connect":{"name":"connect()","abstract":"Connects the underlying transport.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)connectSocket:":{"name":"connectSocket(_:)","abstract":"Connects a socket through this manager’s engine.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)didDisconnectWithReason:":{"name":"didDisconnect(reason:)","abstract":"Called when the manager has disconnected from socket.io.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnect":{"name":"disconnect()","abstract":"Disconnects the manager and all associated sockets.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnectSocket:":{"name":"disconnectSocket(_:)","abstract":"Disconnects the given socket.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnectSocketForNamespace:":{"name":"disconnectSocket(forNamespace:)","abstract":"Disconnects the socket associated with forNamespace.
Sends an event to the server on all namespaces in this manager.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)reconnect":{"name":"reconnect()","abstract":"Tries to reconnect to the server.
","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)removeSocket:":{"name":"removeSocket(_:)","abstract":"Removes the socket from the manager’s control.","parent_name":"SocketManagerSpec"},"Protocols/SocketManagerSpec.html#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)socketForNamespace:":{"name":"socket(forNamespace:)","abstract":"
Returns a SocketIOClient for the given namespace. This socket shares a transport with the manager.
Sends an engine.io message through the WebSocket transport.
","parent_name":"SocketEngineWebsocket"},"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.
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.
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:completion:":{"name":"write(_:withType:withData:completion:)","abstract":"Writes a message to engine.io, independent of transport.
","parent_name":"SocketEngineSpec"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP11invalidatedSbvp":{"name":"invalidated","abstract":"true If engine’s session has been invalidated.
A queue of engine.io messages waiting for POSTing
","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP7sessionSo12NSURLSessionCSgvp":{"name":"session","abstract":"The URLSession that will be used for polling.
","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP14waitingForPollSbvp":{"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:8SocketIO0A14EnginePollableP14waitingForPostSbvp":{"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:8SocketIO0A14EnginePollableP15sendPollMessage_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF":{"name":"sendPollMessage(_:withType:withData:completion:)","abstract":"Sends an engine.io message through the polling transport.
","parent_name":"SocketEnginePollable"},"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP11stopPollingyyF":{"name":"stopPolling()","abstract":"Call to stop polling and invalidate the URLSession.
","parent_name":"SocketEnginePollable"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidErrorWithReason:":{"name":"engineDidError(reason:)","abstract":"Called when the engine errors.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidCloseWithReason:":{"name":"engineDidClose(reason:)","abstract":"Called when the engine closes.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidOpenWithReason:":{"name":"engineDidOpen(reason:)","abstract":"Called when the engine opens.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidReceivePong":{"name":"engineDidReceivePong()","abstract":"Called when the engine receives a pong message.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidSendPing":{"name":"engineDidSendPing()","abstract":"Called when the engine sends a ping to the server.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"Called when the engine has a message that must be parsed.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineBinaryData:":{"name":"parseEngineBinaryData(_:)","abstract":"Called when the engine receives binary data.
","parent_name":"SocketEngineClient"},"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidWebsocketUpgradeWithHeaders:":{"name":"engineDidWebsocketUpgrade(headers:)","abstract":"Called when when upgrading the http connection to a websocket connection.
","parent_name":"SocketEngineClient"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP10anyHandleryAA0A8AnyEventCcSgvp":{"name":"anyHandler","abstract":"A handler that will be called on any event.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP8handlersSayAA0A12EventHandlerVGvp":{"name":"handlers","abstract":"The array of handlers for this socket.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7managerAA0a7ManagerD0_pSgvp":{"name":"manager","abstract":"The manager for this socket.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3nspSSvp":{"name":"nsp","abstract":"The namespace that this socket is currently connected to.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP11rawEmitViewAA0a3RawG0Cvp":{"name":"rawEmitView","abstract":"A view into this socket where emits do not check for binary data.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP6statusAA0A8IOStatusOvp":{"name":"status","abstract":"The status of this client.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7connectyyF":{"name":"connect()","abstract":"Connect to the server. The same as calling connect(timeoutAfter:withHandler:) with a timeout of 0.
Connect to the server. If we aren’t connected after timeoutAfter seconds, then withHandler is called.
Called when the client connects to a namespace. If the client was created with a namespace upfront,","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP13didDisconnect6reasonySS_tF":{"name":"didDisconnect(reason:)","abstract":"
Called when the client has disconnected from socket.io.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP8didError6reasonySS_tF":{"name":"didError(reason:)","abstract":"Called when the client encounters an error.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP10disconnectyyF":{"name":"disconnect()","abstract":"Disconnects the socket.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP4emit__10completionySS_AA0A4Data_pdyycSgtF":{"name":"emit(_:_:completion:)","abstract":"Send an event to the server, with optional data items and optional write completion handler.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7emitAck_4withySi_SayypGtF":{"name":"emitAck(_:with:)","abstract":"Call when you wish to tell the server that you’ve received the event for ack.
Sends a message to the server, requesting an ack.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP9handleAck_4dataySi_SayypGtF":{"name":"handleAck(_:data:)","abstract":"Called when socket.io has acked one of our emits. Causes the corresponding ack callback to be called.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP17handleClientEvent_4datayAA0afG0O_SayypGtF":{"name":"handleClientEvent(_:data:)","abstract":"Called on socket.io specific events.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP11handleEvent_4data17isInternalMessage7withAckySS_SayypGSbSitF":{"name":"handleEvent(_:data:isInternalMessage:withAck:)","abstract":"Called when we get an event from socket.io.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP12handlePacketyyAA0aF0VF":{"name":"handlePacket(_:)","abstract":"Causes a client to handle a socket.io packet. The namespace for the packet must match the namespace of the","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP14leaveNamespaceyyF":{"name":"leaveNamespace()","abstract":"
Call when you wish to leave a namespace and disconnect this socket.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP13joinNamespaceyyF":{"name":"joinNamespace()","abstract":"Joins nsp.
Removes handler(s) for a client event.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3offyySSF":{"name":"off(_:)","abstract":"Removes handler(s) based on an event name.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3off2idy10Foundation4UUIDV_tF":{"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":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP2on11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"on(clientEvent:callback:)","abstract":"Adds a handler for a client event.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP4once11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"once(clientEvent:callback:)","abstract":"Adds a single-use handler for a client event.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP4once_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF":{"name":"once(_:callback:)","abstract":"Adds a single-use handler for an event.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP5onAnyyyyAA0aF5EventCcF":{"name":"onAny(_:)","abstract":"Adds a handler that will be called on every event.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP17removeAllHandlersyyF":{"name":"removeAllHandlers()","abstract":"Removes all handlers.
","parent_name":"SocketIOClientSpec"},"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP15setReconnecting6reasonySS_tF":{"name":"setReconnecting(reason:)","abstract":"Puts the socket back into the connecting state.","parent_name":"SocketIOClientSpec"},"Protocols/ConfigSettable.html#/s:8SocketIO14ConfigSettableP10setConfigsyyAA0A21IOClientConfigurationVF":{"name":"setConfigs(_:)","abstract":"
Called when an ConfigSettable should set/update its configs from a given configuration.
Declares that a type can set configs from a SocketIOClientConfiguration.
Defines the interface for a SocketIOClient.
"},"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/SocketEngineSpec.html":{"name":"SocketEngineSpec","abstract":"Specifies a SocketEngine.
"},"Protocols/SocketEngineWebsocket.html":{"name":"SocketEngineWebsocket","abstract":"Protocol that is used to implement socket.io WebSocket support
"},"Protocols/SocketManagerSpec.html":{"name":"SocketManagerSpec","abstract":"A manager for a socket.io connection.
"},"Protocols/SocketParsable.html":{"name":"SocketParsable","abstract":"Defines that a type will be able to parse socket.io-protocol messages.
"},"Protocols/SocketDataBufferable.html":{"name":"SocketDataBufferable","abstract":"Says that a type will be able to buffer binary data before all data for an event has come in.
"},"Protocols/SocketLogger.html":{"name":"SocketLogger","abstract":"Represents a class will log client events.
"},"Protocols/SocketData.html":{"name":"SocketData","abstract":"A marking protocol that says a type can be represented in a socket.io packet.
"},"Enums/SocketParsableError.html#/s:8SocketIO0A13ParsableErrorO16invalidDataArrayyA2CmF":{"name":"invalidDataArray","abstract":"Thrown when a packet received has an invalid data array, or is missing the data array.
","parent_name":"SocketParsableError"},"Enums/SocketParsableError.html#/s:8SocketIO0A13ParsableErrorO13invalidPacketyA2CmF":{"name":"invalidPacket","abstract":"Thrown when an malformed packet is received.
","parent_name":"SocketParsableError"},"Enums/SocketParsableError.html#/s:8SocketIO0A13ParsableErrorO17invalidPacketTypeyA2CmF":{"name":"invalidPacketType","abstract":"Thrown when the parser receives an unknown packet type.
","parent_name":"SocketParsableError"},"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/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusNotConnected":{"name":"notConnected","abstract":"The client/manager has never been connected. Or the client has been reset.
","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusDisconnected":{"name":"disconnected","abstract":"The client/manager was once connected, but not anymore.
","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusConnecting":{"name":"connecting","abstract":"The client/manager is in the process of connecting.
","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/c:@M@SocketIO@E@SocketIOStatus@SocketIOStatusConnected":{"name":"connected","abstract":"The client/manager is currently connected.
","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/s:8SocketIO0A8IOStatusO6activeSbvp":{"name":"active","parent_name":"SocketIOStatus"},"Enums/SocketIOStatus.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"SocketIOStatus"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO7connectyA2CmF":{"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:8SocketIO0A11ClientEventO10disconnectyA2CmF":{"name":"disconnect","abstract":"
Emitted when the socket has disconnected and will not attempt to try to reconnect.
","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO5erroryA2CmF":{"name":"error","abstract":"Emitted when an error occurs.
","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO4pingyA2CmF":{"name":"ping","abstract":"Emitted whenever the engine sends a ping.
","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO4pongyA2CmF":{"name":"pong","abstract":"Emitted whenever the engine gets a pong.
","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO9reconnectyA2CmF":{"name":"reconnect","abstract":"Emitted when the client begins the reconnection process.
","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO16reconnectAttemptyA2CmF":{"name":"reconnectAttempt","abstract":"Emitted each time the client tries to reconnect to the server.
","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO12statusChangeyA2CmF":{"name":"statusChange","abstract":"Emitted every time there is a change in the client’s status.
","parent_name":"SocketClientEvent"},"Enums/SocketClientEvent.html#/s:8SocketIO0A11ClientEventO16websocketUpgradeyA2CmF":{"name":"websocketUpgrade","abstract":"Emitted when when upgrading the http connection to a websocket connection.
","parent_name":"SocketClientEvent"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8compressyA2CmF":{"name":"compress","abstract":"If given, the WebSocket transport will attempt to use compression.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO13connectParamsyACSDySSypGcACmF":{"name":"connectParams(_:)","abstract":"A dictionary of GET parameters that will be included in the connect url.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO7cookiesyACSaySo12NSHTTPCookieCGcACmF":{"name":"cookies(_:)","abstract":"An array of cookies that will be sent during the initial connection.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO12extraHeadersyACSDyS2SGcACmF":{"name":"extraHeaders(_:)","abstract":"Any extra HTTP headers that should be sent during the initial connection.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8forceNewyACSbcACmF":{"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:8SocketIO0A14IOClientOptionO12forcePollingyACSbcACmF":{"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.
If passed true, the WebSocket stream will be configured with the enableSOCKSProxy true.
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:8SocketIO0A14IOClientOptionO3logyACSbcACmF":{"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:8SocketIO0A14IOClientOptionO4pathyACSScACmF":{"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:8SocketIO0A14IOClientOptionO10reconnectsyACSbcACmF":{"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:8SocketIO0A14IOClientOptionO17reconnectAttemptsyACSicACmF":{"name":"reconnectAttempts(_:)","abstract":"
The number of times to try and reconnect before giving up. Pass -1 to never give up.
The minimum number of seconds to wait before reconnect attempts.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO16reconnectWaitMaxyACSicACmF":{"name":"reconnectWaitMax(_:)","abstract":"The maximum number of seconds to wait before reconnect attempts.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO19randomizationFactoryACSdcACmF":{"name":"randomizationFactor(_:)","abstract":"The randomization factor for calculating reconnect jitter.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO6secureyACSbcACmF":{"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:8SocketIO0A14IOClientOptionO10selfSignedyACSbcACmF":{"name":"selfSigned(_:)","abstract":"If you’re using a self-signed set. Only use for development.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO15sessionDelegateyACSo012NSURLSessionF0_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:8SocketIO0A14IOClientOptionO11descriptionSSvp":{"name":"description","abstract":"The description of this option.
","parent_name":"SocketIOClientOption"},"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO2eeoiySbAC_ACtFZ":{"name":"==(_:_:)","abstract":"Compares whether two options are the same.
","parent_name":"SocketIOClientOption"},"Enums/SocketAckStatus.html#/s:8SocketIO0A9AckStatusO02noC0yA2CmF":{"name":"noAck","abstract":"The ack timed out.
","parent_name":"SocketAckStatus"},"Enums/SocketAckStatus.html":{"name":"SocketAckStatus","abstract":"The status of an ack.
"},"Enums/SocketIOClientOption.html":{"name":"SocketIOClientOption","abstract":"The options for a client.
"},"Enums/SocketClientEvent.html":{"name":"SocketClientEvent","abstract":"The set of events that are generated by the client.
"},"Enums/SocketIOStatus.html":{"name":"SocketIOStatus","abstract":"Represents state of a manager or client.
"},"Enums/SocketEnginePacketType.html":{"name":"SocketEnginePacketType","abstract":"Represents the type of engine.io packet types.
"},"Enums/SocketParsableError.html":{"name":"SocketParsableError","abstract":"Errors that can be thrown during parsing.
"},"Classes/SSLSecurity.html#/s:8SocketIO11SSLSecurityC8security10StarscreamABCvp":{"name":"security","abstract":"The internal Starscream SSLSecurity.
","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/c:@M@SocketIO@objc(cs)SSLSecurity(im)initWithUsePublicKeys:":{"name":"init(usePublicKeys:)","abstract":"Creates a new SSLSecurity that specifies whether to use publicKeys or certificates should be used for SSL","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:8SocketIO11SSLSecurityC5certs13usePublicKeysACSay10Starscream7SSLCertCG_Sbtcfc":{"name":"init(certs:usePublicKeys:)","abstract":"
Designated init
","parent_name":"SSLSecurity"},"Classes/SSLSecurity.html#/s:8SocketIO11SSLSecurityC7isValid_6domainSbSo11SecTrustRefa_SSSgtF":{"name":"isValid(_:domain:)","abstract":"Returns whether or not the given trust is valid.
","parent_name":"SSLSecurity"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)defaultSocket":{"name":"defaultSocket","abstract":"The socket associated with the default namespace (/
).
The URL of the socket.io server.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC6configAA0A21IOClientConfigurationVvp":{"name":"config","abstract":"The configuration for this client.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)engine":{"name":"engine","abstract":"The engine for this manager.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)forceNew":{"name":"forceNew","abstract":"If true then every time connect is called, a new engine will be created.
The queue that all interaction with the client should occur on. This is the queue that event handlers are","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)nsps":{"name":"nsps","abstract":"
The sockets in this manager indexed by namespace.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)reconnects":{"name":"reconnects","abstract":"If true, this client will try and reconnect on any disconnects.
The minimum number of seconds to wait before attempting to reconnect.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)reconnectWaitMax":{"name":"reconnectWaitMax","abstract":"The maximum number of seconds to wait before attempting to reconnect.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)randomizationFactor":{"name":"randomizationFactor","abstract":"The randomization factor for calculating reconnect jitter.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)status":{"name":"status","abstract":"The status of this manager.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC14waitingPacketsSayAA0A6PacketVGvp":{"name":"waitingPackets","abstract":"A list of packets that are waiting for binary data.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC9socketURL6configAC10Foundation0E0V_AA0A21IOClientConfigurationVtcfc":{"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":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)connect":{"name":"connect()","abstract":"
Connects the underlying transport and the default namespace socket.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)connectSocket:":{"name":"connectSocket(_:)","abstract":"Connects a socket through this manager’s engine.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)didDisconnectWithReason:":{"name":"didDisconnect(reason:)","abstract":"Called when the manager has disconnected from socket.io.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnect":{"name":"disconnect()","abstract":"Disconnects the manager and all associated sockets.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnectSocket:":{"name":"disconnectSocket(_:)","abstract":"Disconnects the given socket.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnectSocketForNamespace:":{"name":"disconnectSocket(forNamespace:)","abstract":"Disconnects the socket associated with forNamespace.
Sends a client event to all sockets in nsps
Sends an event to the server on all namespaces in this manager.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)emitAll:withItems:":{"name":"emitAll(_:withItems:)","abstract":"Sends an event to the server on all namespaces in this manager.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidCloseWithReason:":{"name":"engineDidClose(reason:)","abstract":"Called when the engine closes.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidErrorWithReason:":{"name":"engineDidError(reason:)","abstract":"Called when the engine errors.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidOpenWithReason:":{"name":"engineDidOpen(reason:)","abstract":"Called when the engine opens.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidReceivePong":{"name":"engineDidReceivePong()","abstract":"Called when the engine receives a pong message.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidSendPing":{"name":"engineDidSendPing()","abstract":"Called when the sends a ping to the server.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidWebsocketUpgradeWithHeaders:":{"name":"engineDidWebsocketUpgrade(headers:)","abstract":"Called when when upgrading the http connection to a websocket connection.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"Called when the engine has a message that must be parsed.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineBinaryData:":{"name":"parseEngineBinaryData(_:)","abstract":"Called when the engine receives binary data.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)reconnect":{"name":"reconnect()","abstract":"Tries to reconnect to the server.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)removeSocket:":{"name":"removeSocket(_:)","abstract":"Removes the socket from the manager’s control. One of the disconnect methods should be called before calling this","parent_name":"SocketManager"},"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC10setConfigsyyAA0A21IOClientConfigurationVF":{"name":"setConfigs(_:)","abstract":"
Sets manager specific configs.
","parent_name":"SocketManager"},"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)socketForNamespace:":{"name":"socket(forNamespace:)","abstract":"Returns a SocketIOClient for the given namespace. This socket shares a transport with the manager.
The queue that all engine actions take place on.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)connectParams":{"name":"connectParams","abstract":"The connect parameters sent during a connect.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(py)extraHeaders":{"name":"extraHeaders","abstract":"A dictionary of extra http headers that will be set during connection.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC8postWaitSaySS3msg_yycSg10completiontGvp":{"name":"postWait","abstract":"A queue of engine.io messages waiting for POSTing
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC14waitingForPollSbvp":{"name":"waitingForPoll","abstract":"true if there is an outstanding poll. Trying to poll before the first is done will cause socket.io to","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC14waitingForPostSbvp":{"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)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.
When true, the WebSocket stream will be configured with the enableSOCKSProxy true.
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:8SocketIO0A6EngineC6client3url6configAcA0aC6Client_p_10Foundation3URLVAA0A21IOClientConfigurationVtcfc":{"name":"init(client:url:config:)","abstract":"Creates a new engine.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)initWithClient:url:options:":{"name":"init(client:url:options:)","abstract":"Creates a new engine.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)connect":{"name":"connect()","abstract":"Starts the connection to the server.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)didErrorWithReason:":{"name":"didError(reason:)","abstract":"Called when an error happens during execution. Causes a disconnection.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)disconnectWithReason:":{"name":"disconnect(reason:)","abstract":"Disconnects from the server.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)doFastUpgrade":{"name":"doFastUpgrade()","abstract":"Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)flushWaitingForPostToWebSocket":{"name":"flushWaitingForPostToWebSocket()","abstract":"
Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineData:":{"name":"parseEngineData(_:)","abstract":"
Parses raw binary received from engine.io.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineMessage:":{"name":"parseEngineMessage(_:)","abstract":"Parses a raw engine.io packet.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC10setConfigsyyAA0A21IOClientConfigurationVF":{"name":"setConfigs(_:)","abstract":"Called when the engine should set/update its configs from a given configuration.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/c:@M@SocketIO@objc(cs)SocketEngine(im)write:withType:withData:completion:":{"name":"write(_:withType:withData:completion:)","abstract":"Writes a message to engine.io, independent of transport.
","parent_name":"SocketEngine"},"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC10URLSession7session25didBecomeInvalidWithErrorySo12NSURLSessionC_So7NSErrorCSgtF":{"name":"URLSession(session:didBecomeInvalidWithError:)","abstract":"Delegate called when the session becomes invalid.
","parent_name":"SocketEngine"},"Classes/SocketRawAckView.html#/s:8SocketIO0A10RawAckViewC4withyyAA0A4Data_pd_tF":{"name":"with(_:)","abstract":"Call to ack receiving this event.
","parent_name":"SocketRawAckView"},"Classes/SocketRawAckView.html#/c:@M@SocketIO@objc(cs)SocketRawAckView(im)with:":{"name":"with(_:)","abstract":"Call to ack receiving this event.
","parent_name":"SocketRawAckView"},"Classes/SocketRawView.html#/s:8SocketIO0A7RawViewC4emityySS_AA0A4Data_pdtF":{"name":"emit(_:_:)","abstract":"Send an event to the server, with optional data items.
","parent_name":"SocketRawView"},"Classes/SocketRawView.html#/c:@M@SocketIO@objc(cs)SocketRawView(im)emit:with:":{"name":"emit(_:with:)","abstract":"Same as emit, but meant for Objective-C
","parent_name":"SocketRawView"},"Classes/SocketRawView.html#/s:8SocketIO0A7RawViewC11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF":{"name":"emitWithAck(_:_:)","abstract":"Sends a message to the server, requesting an ack.
","parent_name":"SocketRawView"},"Classes/SocketRawView.html#/c:@M@SocketIO@objc(cs)SocketRawView(im)emitWithAck:with:":{"name":"emitWithAck(_:with:)","abstract":"Same as emitWithAck, but for Objective-C
","parent_name":"SocketRawView"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)nsp":{"name":"nsp","abstract":"The namespace that this socket is currently connected to.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)sid":{"name":"sid","abstract":"The session id of this client.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10anyHandleryAA0A8AnyEventCcSgvp":{"name":"anyHandler","abstract":"A handler that will be called on any event.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC8handlersSayAA0A12EventHandlerVGvp":{"name":"handlers","abstract":"The array of handlers for this socket.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)manager":{"name":"manager","abstract":"The manager for this socket.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)rawEmitView":{"name":"rawEmitView","abstract":"A view into this socket where emits do not check for binary data.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(py)status":{"name":"status","abstract":"The status of this client.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)initWithManager:nsp:":{"name":"init(manager:nsp:)","abstract":"Type safe way to create a new SocketIOClient. opts can be omitted.
Connect to the server. The same as calling connect(timeoutAfter:withHandler:) with a timeout of 0.
Connect to the server. If we aren’t connected after timeoutAfter seconds, then withHandler is called.
Called when the client connects to a namespace. If the client was created with a namespace upfront,","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC13didDisconnect6reasonySS_tF":{"name":"didDisconnect(reason:)","abstract":"
Called when the client has disconnected from socket.io.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)disconnect":{"name":"disconnect()","abstract":"Disconnects the socket.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC4emit__10completionySS_AA0A4Data_pdyycSgtF":{"name":"emit(_:_:completion:)","abstract":"Send an event to the server, with optional data items and optional write completion handler.
","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#/c:@M@SocketIO@objc(cs)SocketIOClient(im)emit:with:completion:":{"name":"emit(_:with:completion:)","abstract":"Same as emit, but meant for Objective-C
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC11emitWithAckyAA02OnF8CallbackCSS_AA0A4Data_pdtF":{"name":"emitWithAck(_:_:)","abstract":"Sends a message to the server, requesting an ack.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)emitWithAck:with:":{"name":"emitWithAck(_:with:)","abstract":"Same as emitWithAck, but for Objective-C
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC7emitAck_4withySi_SayypGtF":{"name":"emitAck(_:with:)","abstract":"Call when you wish to tell the server that you’ve received the event for ack.
Called when socket.io has acked one of our emits. Causes the corresponding ack callback to be called.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC17handleClientEvent_4datayAA0aeF0O_SayypGtF":{"name":"handleClientEvent(_:data:)","abstract":"Called on socket.io specific events.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)handleEvent:data:isInternalMessage:withAck:":{"name":"handleEvent(_:data:isInternalMessage:withAck:)","abstract":"Called when we get an event from socket.io.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC12handlePacketyyAA0aE0VF":{"name":"handlePacket(_:)","abstract":"Causes a client to handle a socket.io packet. The namespace for the packet must match the namespace of the","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)leaveNamespace":{"name":"leaveNamespace()","abstract":"
Call when you wish to leave a namespace and disconnect this socket.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)joinNamespace":{"name":"joinNamespace()","abstract":"Joins nsp.
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:8SocketIO0A8IOClientC2on11clientEvent8callback10Foundation4UUIDVAA0a6ClientF0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"on(clientEvent:callback:)","abstract":"Adds a handler for a client event.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC4once11clientEvent8callback10Foundation4UUIDVAA0a6ClientF0O_ySayypG_AA0A10AckEmitterCtctF":{"name":"once(clientEvent:callback:)","abstract":"Adds a single-use handler for a client event.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)once:callback:":{"name":"once(_:callback:)","abstract":"Adds a single-use handler for an event.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)onAny:":{"name":"onAny(_:)","abstract":"Adds a handler that will be called on every event.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)removeAllHandlers":{"name":"removeAllHandlers()","abstract":"Removes all handlers.
","parent_name":"SocketIOClient"},"Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)setReconnectingWithReason:":{"name":"setReconnecting(reason:)","abstract":"Puts the socket back into the connecting state.","parent_name":"SocketIOClient"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)event":{"name":"event","abstract":"
The event name.
","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)items":{"name":"items","abstract":"The data items for this event.
","parent_name":"SocketAnyEvent"},"Classes/SocketAnyEvent.html#/c:@M@SocketIO@objc(cs)SocketAnyEvent(py)description":{"name":"description","abstract":"The description of this event.
","parent_name":"SocketAnyEvent"},"Classes/OnAckCallback.html#/c:@M@SocketIO@objc(cs)OnAckCallback(im)timingOutAfter:callback:":{"name":"timingOut(after:callback:)","abstract":"Completes an emitWithAck. If this isn’t called, the emit never happens.
","parent_name":"OnAckCallback"},"Classes/SocketAckEmitter.html#/c:@M@SocketIO@objc(cs)SocketAckEmitter(py)rawEmitView":{"name":"rawEmitView","abstract":"A view into this emitter where emits do not check for binary data.
","parent_name":"SocketAckEmitter"},"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC8expectedSbvp":{"name":"expected","abstract":"If true, this handler is expecting to be acked. Call with(_: SocketData...) to ack.
Creates a new SocketAckEmitter.
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/SocketAckEmitter.html":{"name":"SocketAckEmitter","abstract":"A class that represents a waiting ack call.
"},"Classes/OnAckCallback.html":{"name":"OnAckCallback","abstract":"A class that represents an emit that will request an ack that has not yet been sent."},"Classes/SocketAnyEvent.html":{"name":"SocketAnyEvent","abstract":"
Represents some event that was received.
"},"Classes/SocketIOClient.html":{"name":"SocketIOClient","abstract":"Represents a socket.io-client.
"},"Classes/SocketRawView.html":{"name":"SocketRawView","abstract":"Class that gives a backwards compatible way to cause an emit not to recursively check for Data objects.
"},"Classes/SocketRawAckView.html":{"name":"SocketRawAckView","abstract":"Class that gives a backwards compatible way to cause an emit not to recursively check for Data objects.
"},"Classes/SocketEngine.html":{"name":"SocketEngine","abstract":"The class that handles the engine.io protocol and transports."},"Classes/SocketManager.html":{"name":"SocketManager","abstract":"
A manager for a socket.io connection.
"},"Classes/SSLSecurity.html":{"name":"SSLSecurity","abstract":"A wrapper around Starscream’s SSLSecurity that provides a minimal Objective-C interface.
"},"faq.html":{"name":"FAQ"},"12to13.html":{"name":"12to13"},"Guides.html":{"name":"Guides","abstract":"The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"},"Typealiases.html":{"name":"Type Aliases","abstract":"The following type aliases are available globally.
"}}