\");\n $input.on(\"blur.tt\", function($e) {\n var active, isActive, hasActive;\n active = document.activeElement;\n isActive = $menu.is(active);\n hasActive = $menu.has(active).length > 0;\n if (_.isMsie() && (isActive || hasActive)) {\n $e.preventDefault();\n $e.stopImmediatePropagation();\n _.defer(function() {\n $input.focus();\n });\n }\n });\n $menu.on(\"mousedown.tt\", function($e) {\n $e.preventDefault();\n });\n },\n _onSelectableClicked: function onSelectableClicked(type, $el) {\n this.select($el);\n },\n _onDatasetCleared: function onDatasetCleared() {\n this._updateHint();\n },\n _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) {\n this._updateHint();\n if (this.autoselect) {\n var cursorClass = this.selectors.cursor.substr(1);\n this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass);\n }\n this.eventBus.trigger(\"render\", suggestions, async, dataset);\n },\n _onAsyncRequested: function onAsyncRequested(type, dataset, query) {\n this.eventBus.trigger(\"asyncrequest\", query, dataset);\n },\n _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) {\n this.eventBus.trigger(\"asynccancel\", query, dataset);\n },\n _onAsyncReceived: function onAsyncReceived(type, dataset, query) {\n this.eventBus.trigger(\"asyncreceive\", query, dataset);\n },\n _onFocused: function onFocused() {\n this._minLengthMet() && this.menu.update(this.input.getQuery());\n },\n _onBlurred: function onBlurred() {\n if (this.input.hasQueryChangedSinceLastFocus()) {\n this.eventBus.trigger(\"change\", this.input.getQuery());\n }\n },\n _onEnterKeyed: function onEnterKeyed(type, $e) {\n var $selectable;\n if ($selectable = this.menu.getActiveSelectable()) {\n if (this.select($selectable)) {\n $e.preventDefault();\n $e.stopPropagation();\n }\n } else if (this.autoselect) {\n if (this.select(this.menu.getTopSelectable())) {\n $e.preventDefault();\n $e.stopPropagation();\n }\n }\n },\n _onTabKeyed: function onTabKeyed(type, $e) {\n var $selectable;\n if ($selectable = this.menu.getActiveSelectable()) {\n this.select($selectable) && $e.preventDefault();\n } else if (this.autoselect) {\n if ($selectable = this.menu.getTopSelectable()) {\n this.autocomplete($selectable) && $e.preventDefault();\n }\n }\n },\n _onEscKeyed: function onEscKeyed() {\n this.close();\n },\n _onUpKeyed: function onUpKeyed() {\n this.moveCursor(-1);\n },\n _onDownKeyed: function onDownKeyed() {\n this.moveCursor(+1);\n },\n _onLeftKeyed: function onLeftKeyed() {\n if (this.dir === \"rtl\" && this.input.isCursorAtEnd()) {\n this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable());\n }\n },\n _onRightKeyed: function onRightKeyed() {\n if (this.dir === \"ltr\" && this.input.isCursorAtEnd()) {\n this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable());\n }\n },\n _onQueryChanged: function onQueryChanged(e, query) {\n this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty();\n },\n _onWhitespaceChanged: function onWhitespaceChanged() {\n this._updateHint();\n },\n _onLangDirChanged: function onLangDirChanged(e, dir) {\n if (this.dir !== dir) {\n this.dir = dir;\n this.menu.setLanguageDirection(dir);\n }\n },\n _openIfActive: function openIfActive() {\n this.isActive() && this.open();\n },\n _minLengthMet: function minLengthMet(query) {\n query = _.isString(query) ? query : this.input.getQuery() || \"\";\n return query.length >= this.minLength;\n },\n _updateHint: function updateHint() {\n var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match;\n $selectable = this.menu.getTopSelectable();\n data = this.menu.getSelectableData($selectable);\n val = this.input.getInputValue();\n if (data && !_.isBlankString(val) && !this.input.hasOverflow()) {\n query = Input.normalizeQuery(val);\n escapedQuery = _.escapeRegExChars(query);\n frontMatchRegEx = new RegExp(\"^(?:\" + escapedQuery + \")(.+$)\", \"i\");\n match = frontMatchRegEx.exec(data.val);\n match && this.input.setHint(val + match[1]);\n } else {\n this.input.clearHint();\n }\n },\n isEnabled: function isEnabled() {\n return this.enabled;\n },\n enable: function enable() {\n this.enabled = true;\n },\n disable: function disable() {\n this.enabled = false;\n },\n isActive: function isActive() {\n return this.active;\n },\n activate: function activate() {\n if (this.isActive()) {\n return true;\n } else if (!this.isEnabled() || this.eventBus.before(\"active\")) {\n return false;\n } else {\n this.active = true;\n this.eventBus.trigger(\"active\");\n return true;\n }\n },\n deactivate: function deactivate() {\n if (!this.isActive()) {\n return true;\n } else if (this.eventBus.before(\"idle\")) {\n return false;\n } else {\n this.active = false;\n this.close();\n this.eventBus.trigger(\"idle\");\n return true;\n }\n },\n isOpen: function isOpen() {\n return this.menu.isOpen();\n },\n open: function open() {\n if (!this.isOpen() && !this.eventBus.before(\"open\")) {\n this.input.setAriaExpanded(true);\n this.menu.open();\n this._updateHint();\n this.eventBus.trigger(\"open\");\n }\n return this.isOpen();\n },\n close: function close() {\n if (this.isOpen() && !this.eventBus.before(\"close\")) {\n this.input.setAriaExpanded(false);\n this.menu.close();\n this.input.clearHint();\n this.input.resetInputValue();\n this.eventBus.trigger(\"close\");\n }\n return !this.isOpen();\n },\n setVal: function setVal(val) {\n this.input.setQuery(_.toStr(val));\n },\n getVal: function getVal() {\n return this.input.getQuery();\n },\n select: function select($selectable) {\n var data = this.menu.getSelectableData($selectable);\n if (data && !this.eventBus.before(\"select\", data.obj, data.dataset)) {\n this.input.setQuery(data.val, true);\n this.eventBus.trigger(\"select\", data.obj, data.dataset);\n this.close();\n return true;\n }\n return false;\n },\n autocomplete: function autocomplete($selectable) {\n var query, data, isValid;\n query = this.input.getQuery();\n data = this.menu.getSelectableData($selectable);\n isValid = data && query !== data.val;\n if (isValid && !this.eventBus.before(\"autocomplete\", data.obj, data.dataset)) {\n this.input.setQuery(data.val);\n this.eventBus.trigger(\"autocomplete\", data.obj, data.dataset);\n return true;\n }\n return false;\n },\n moveCursor: function moveCursor(delta) {\n var query, $candidate, data, suggestion, datasetName, cancelMove, id;\n query = this.input.getQuery();\n $candidate = this.menu.selectableRelativeToCursor(delta);\n data = this.menu.getSelectableData($candidate);\n suggestion = data ? data.obj : null;\n datasetName = data ? data.dataset : null;\n id = $candidate ? $candidate.attr(\"id\") : null;\n this.input.trigger(\"cursorchange\", id);\n cancelMove = this._minLengthMet() && this.menu.update(query);\n if (!cancelMove && !this.eventBus.before(\"cursorchange\", suggestion, datasetName)) {\n this.menu.setCursor($candidate);\n if (data) {\n if (typeof data.val === \"string\") {\n this.input.setInputValue(data.val);\n }\n } else {\n this.input.resetInputValue();\n this._updateHint();\n }\n this.eventBus.trigger(\"cursorchange\", suggestion, datasetName);\n return true;\n }\n return false;\n },\n destroy: function destroy() {\n this.input.destroy();\n this.menu.destroy();\n }\n });\n return Typeahead;\n function c(ctx) {\n var methods = [].slice.call(arguments, 1);\n return function() {\n var args = [].slice.call(arguments);\n _.each(methods, function(method) {\n return ctx[method].apply(ctx, args);\n });\n };\n }\n }();\n (function() {\n \"use strict\";\n var old, keys, methods;\n old = $.fn.typeahead;\n keys = {\n www: \"tt-www\",\n attrs: \"tt-attrs\",\n typeahead: \"tt-typeahead\"\n };\n methods = {\n initialize: function initialize(o, datasets) {\n var www;\n datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1);\n o = o || {};\n www = WWW(o.classNames);\n return this.each(attach);\n function attach() {\n var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor;\n _.each(datasets, function(d) {\n d.highlight = !!o.highlight;\n });\n $input = $(this);\n $wrapper = $(www.html.wrapper);\n $hint = $elOrNull(o.hint);\n $menu = $elOrNull(o.menu);\n defaultHint = o.hint !== false && !$hint;\n defaultMenu = o.menu !== false && !$menu;\n defaultHint && ($hint = buildHintFromInput($input, www));\n defaultMenu && ($menu = $(www.html.menu).css(www.css.menu));\n $hint && $hint.val(\"\");\n $input = prepInput($input, www);\n if (defaultHint || defaultMenu) {\n $wrapper.css(www.css.wrapper);\n $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint);\n $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null);\n }\n MenuConstructor = defaultMenu ? DefaultMenu : Menu;\n eventBus = new EventBus({\n el: $input\n });\n input = new Input({\n hint: $hint,\n input: $input,\n menu: $menu\n }, www);\n menu = new MenuConstructor({\n node: $menu,\n datasets: datasets\n }, www);\n status = new Status({\n $input: $input,\n menu: menu\n });\n typeahead = new Typeahead({\n input: input,\n menu: menu,\n eventBus: eventBus,\n minLength: o.minLength,\n autoselect: o.autoselect\n }, www);\n $input.data(keys.www, www);\n $input.data(keys.typeahead, typeahead);\n }\n },\n isEnabled: function isEnabled() {\n var enabled;\n ttEach(this.first(), function(t) {\n enabled = t.isEnabled();\n });\n return enabled;\n },\n enable: function enable() {\n ttEach(this, function(t) {\n t.enable();\n });\n return this;\n },\n disable: function disable() {\n ttEach(this, function(t) {\n t.disable();\n });\n return this;\n },\n isActive: function isActive() {\n var active;\n ttEach(this.first(), function(t) {\n active = t.isActive();\n });\n return active;\n },\n activate: function activate() {\n ttEach(this, function(t) {\n t.activate();\n });\n return this;\n },\n deactivate: function deactivate() {\n ttEach(this, function(t) {\n t.deactivate();\n });\n return this;\n },\n isOpen: function isOpen() {\n var open;\n ttEach(this.first(), function(t) {\n open = t.isOpen();\n });\n return open;\n },\n open: function open() {\n ttEach(this, function(t) {\n t.open();\n });\n return this;\n },\n close: function close() {\n ttEach(this, function(t) {\n t.close();\n });\n return this;\n },\n select: function select(el) {\n var success = false, $el = $(el);\n ttEach(this.first(), function(t) {\n success = t.select($el);\n });\n return success;\n },\n autocomplete: function autocomplete(el) {\n var success = false, $el = $(el);\n ttEach(this.first(), function(t) {\n success = t.autocomplete($el);\n });\n return success;\n },\n moveCursor: function moveCursoe(delta) {\n var success = false;\n ttEach(this.first(), function(t) {\n success = t.moveCursor(delta);\n });\n return success;\n },\n val: function val(newVal) {\n var query;\n if (!arguments.length) {\n ttEach(this.first(), function(t) {\n query = t.getVal();\n });\n return query;\n } else {\n ttEach(this, function(t) {\n t.setVal(_.toStr(newVal));\n });\n return this;\n }\n },\n destroy: function destroy() {\n ttEach(this, function(typeahead, $input) {\n revert($input);\n typeahead.destroy();\n });\n return this;\n }\n };\n $.fn.typeahead = function(method) {\n if (methods[method]) {\n return methods[method].apply(this, [].slice.call(arguments, 1));\n } else {\n return methods.initialize.apply(this, arguments);\n }\n };\n $.fn.typeahead.noConflict = function noConflict() {\n $.fn.typeahead = old;\n return this;\n };\n function ttEach($els, fn) {\n $els.each(function() {\n var $input = $(this), typeahead;\n (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input);\n });\n }\n function buildHintFromInput($input, www) {\n return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({\n readonly: true,\n required: false\n }).removeAttr(\"id name placeholder\").removeClass(\"required\").attr({\n spellcheck: \"false\",\n tabindex: -1\n });\n }\n function prepInput($input, www) {\n $input.data(keys.attrs, {\n dir: $input.attr(\"dir\"),\n autocomplete: $input.attr(\"autocomplete\"),\n spellcheck: $input.attr(\"spellcheck\"),\n style: $input.attr(\"style\")\n });\n $input.addClass(www.classes.input).attr({\n spellcheck: false\n });\n try {\n !$input.attr(\"dir\") && $input.attr(\"dir\", \"auto\");\n } catch (e) {}\n return $input;\n }\n function getBackgroundStyles($el) {\n return {\n backgroundAttachment: $el.css(\"background-attachment\"),\n backgroundClip: $el.css(\"background-clip\"),\n backgroundColor: $el.css(\"background-color\"),\n backgroundImage: $el.css(\"background-image\"),\n backgroundOrigin: $el.css(\"background-origin\"),\n backgroundPosition: $el.css(\"background-position\"),\n backgroundRepeat: $el.css(\"background-repeat\"),\n backgroundSize: $el.css(\"background-size\")\n };\n }\n function revert($input) {\n var www, $wrapper;\n www = $input.data(keys.www);\n $wrapper = $input.parent().filter(www.selectors.wrapper);\n _.each($input.data(keys.attrs), function(val, key) {\n _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val);\n });\n $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input);\n if ($wrapper.length) {\n $input.detach().insertAfter($wrapper);\n $wrapper.remove();\n }\n }\n function $elOrNull(obj) {\n var isValid, $el;\n isValid = _.isJQuery(obj) || _.isElement(obj);\n $el = isValid ? $(obj).first() : [];\n return $el.length ? $el : null;\n }\n })();\n});"
},
{
"path": "docs/search.json",
"content": "{\"Typealiases.html#/s:8SocketIO11AckCallbacka\":{\"name\":\"AckCallback\",\"abstract\":\"
A typealias for an ack callback.
\"},\"Typealiases.html#/s:8SocketIO14NormalCallbacka\":{\"name\":\"NormalCallback\",\"abstract\":\"
A typealias for a normal callback.
\"},\"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.
\",\"parent_name\":\"SocketIOClientConfiguration\"},\"Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV12makeIterators08IndexingF0VySayAA0aC6OptionOGGyF\":{\"name\":\"makeIterator()\",\"abstract\":\"
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.
\",\"parent_name\":\"SocketIOClientConfiguration\"},\"Structs/SocketEventHandler.html#/s:8SocketIO0A12EventHandlerV5eventSSvp\":{\"name\":\"event\",\"abstract\":\"
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
\"},\"Structs/SocketPacket.html\":{\"name\":\"SocketPacket\",\"abstract\":\"
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/SocketParsable.html#/s:8SocketIO0A8ParsablePA2A0A14DataBufferableRzAA0A11ManagerSpecRzrlE05parseA7MessageyAA0A6PacketVSgSSF\":{\"name\":\"parseSocketMessage(_:)\",\"parent_name\":\"SocketParsable\"},\"Protocols/SocketParsable.html#/s:8SocketIO0A8ParsablePA2A0A14DataBufferableRzAA0A11ManagerSpecRzrlE011parseBinaryD0yAA0A6PacketVSg10Foundation0D0VF\":{\"name\":\"parseBinaryData(_:)\",\"parent_name\":\"SocketParsable\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP07defaultA0AA0A8IOClientCvp\":{\"name\":\"defaultSocket\",\"abstract\":\"
Returns the socket associated with the default namespace (“/”).
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP6engineAA0a6EngineD0_pSgvp\":{\"name\":\"engine\",\"abstract\":\"
The engine for this manager.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP8forceNewSbvp\":{\"name\":\"forceNew\",\"abstract\":\"
If true then every time connect is called, a new engine will be created.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP11handleQueueSo17OS_dispatch_queueCvp\":{\"name\":\"handleQueue\",\"abstract\":\"
The queue that all interaction with the client should occur on. This is the queue that event handlers are\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP4nspsSDySSAA0A8IOClientCGvp\":{\"name\":\"nsps\",\"abstract\":\"
The sockets in this manager indexed by namespace.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP10reconnectsSbvp\":{\"name\":\"reconnects\",\"abstract\":\"
If true, this manager will try and reconnect on any disconnects.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP13reconnectWaitSivp\":{\"name\":\"reconnectWait\",\"abstract\":\"
The minimum number of seconds to wait before attempting to reconnect.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP16reconnectWaitMaxSivp\":{\"name\":\"reconnectWaitMax\",\"abstract\":\"
The maximum number of seconds to wait before attempting to reconnect.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP19randomizationFactorSdvp\":{\"name\":\"randomizationFactor\",\"abstract\":\"
The randomization factor for calculating reconnect jitter.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP9socketURL10Foundation0F0Vvp\":{\"name\":\"socketURL\",\"abstract\":\"
The URL of the socket.io server.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP6statusAA0A8IOStatusOvp\":{\"name\":\"status\",\"abstract\":\"
The status of this manager.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP7versionAA0A9IOVersionOvp\":{\"name\":\"version\",\"abstract\":\"
The version of socket.io in use.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP7connectyyF\":{\"name\":\"connect()\",\"abstract\":\"
Connects the underlying transport.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP07connectA0_11withPayloadyAA0A8IOClientC_SDySSypGSgtF\":{\"name\":\"connectSocket(_:withPayload:)\",\"abstract\":\"
Connects a socket through this manager’s engine.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP13didDisconnect6reasonySS_tF\":{\"name\":\"didDisconnect(reason:)\",\"abstract\":\"
Called when the manager has disconnected from socket.io.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP10disconnectyyF\":{\"name\":\"disconnect()\",\"abstract\":\"
Disconnects the manager and all associated sockets.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP010disconnectA0yyAA0A8IOClientCF\":{\"name\":\"disconnectSocket(_:)\",\"abstract\":\"
Disconnects the given socket.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP010disconnectA012forNamespaceySS_tF\":{\"name\":\"disconnectSocket(forNamespace:)\",\"abstract\":\"
Disconnects the socket associated with forNamespace.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP7emitAllyySS_AA0A4Data_pdtF\":{\"name\":\"emitAll(_:_:)\",\"abstract\":\"
Sends an event to the server on all namespaces in this manager.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP9reconnectyyF\":{\"name\":\"reconnect()\",\"abstract\":\"
Tries to reconnect to the server.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP06removeA0yAA0A8IOClientCSgAFF\":{\"name\":\"removeSocket(_:)\",\"abstract\":\"
Removes the socket from the manager’s control.\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketManagerSpec.html#/s:8SocketIO0A11ManagerSpecP6socket12forNamespaceAA0A8IOClientCSS_tF\":{\"name\":\"socket(forNamespace:)\",\"abstract\":\"
Returns a SocketIOClient for the given namespace. This socket shares a transport with the manager.
\",\"parent_name\":\"SocketManagerSpec\"},\"Protocols/SocketEngineWebsocket.html#/s:8SocketIO0A15EngineWebsocketP11wsConnectedSbvp\":{\"name\":\"wsConnected\",\"abstract\":\"
Whether or not the ws is connected
\",\"parent_name\":\"SocketEngineWebsocket\"},\"Protocols/SocketEngineWebsocket.html#/s:8SocketIO0A15EngineWebsocketP07sendWebA7Message_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF\":{\"name\":\"sendWebSocketMessage(_:withType:withData:completion:)\",\"abstract\":\"
Sends an engine.io message through the WebSocket transport.
\",\"parent_name\":\"SocketEngineWebsocket\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP6clientAA0aC6Client_pSgvp\":{\"name\":\"client\",\"abstract\":\"
The client for this engine.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP6closedSbvp\":{\"name\":\"closed\",\"abstract\":\"
true if this engine is closed.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP8compressSbvp\":{\"name\":\"compress\",\"abstract\":\"
If true the engine will attempt to use WebSocket compression.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP9connectedSbvp\":{\"name\":\"connected\",\"abstract\":\"
true if this engine is connected. Connected means that the initial poll connect has succeeded.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP13connectParamsSDySSypGSgvp\":{\"name\":\"connectParams\",\"abstract\":\"
The connect parameters sent during a connect.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP7cookiesSaySo12NSHTTPCookieCGSgvp\":{\"name\":\"cookies\",\"abstract\":\"
An array of HTTPCookies that are sent during the connection.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP11engineQueueSo17OS_dispatch_queueCvp\":{\"name\":\"engineQueue\",\"abstract\":\"
The queue that all engine actions take place on.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP12extraHeadersSDyS2SGSgvp\":{\"name\":\"extraHeaders\",\"abstract\":\"
A dictionary of extra http headers that will be set during connection.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP11fastUpgradeSbvp\":{\"name\":\"fastUpgrade\",\"abstract\":\"
When true, the engine is in the process of switching to WebSockets.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP12forcePollingSbvp\":{\"name\":\"forcePolling\",\"abstract\":\"
When true, the engine will only use HTTP long-polling as a transport.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP15forceWebsocketsSbvp\":{\"name\":\"forceWebsockets\",\"abstract\":\"
When true, the engine will only use WebSockets as a transport.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP7pollingSbvp\":{\"name\":\"polling\",\"abstract\":\"
If true, the engine is currently in HTTP long-polling mode.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP7probingSbvp\":{\"name\":\"probing\",\"abstract\":\"
If true, the engine is currently seeing whether it can upgrade to WebSockets.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP3sidSSvp\":{\"name\":\"sid\",\"abstract\":\"
The session id for this engine.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP10socketPathSSvp\":{\"name\":\"socketPath\",\"abstract\":\"
The path to engine.io.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP10urlPolling10Foundation3URLVvp\":{\"name\":\"urlPolling\",\"abstract\":\"
The url for polling.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP06urlWebA010Foundation3URLVvp\":{\"name\":\"urlWebSocket\",\"abstract\":\"
The url for WebSockets.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP7versionAA0A9IOVersionOvp\":{\"name\":\"version\",\"abstract\":\"
The version of engine.io being used. Default is three.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP9websocketSbvp\":{\"name\":\"websocket\",\"abstract\":\"
If true, then the engine is currently in WebSockets mode.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP2ws10Starscream03WebA0CSgvp\":{\"name\":\"ws\",\"abstract\":\"
The WebSocket for this engine.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP6client3url7optionsxAA0aC6Client_p_10Foundation3URLVSDySSypGSgtcfc\":{\"name\":\"init(client:url:options:)\",\"abstract\":\"
Creates a new engine.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP7connectyyF\":{\"name\":\"connect()\",\"abstract\":\"
Starts the connection to the server.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP8didError6reasonySS_tF\":{\"name\":\"didError(reason:)\",\"abstract\":\"
Called when an error happens during execution. Causes a disconnection.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP10disconnect6reasonySS_tF\":{\"name\":\"disconnect(reason:)\",\"abstract\":\"
Disconnects from the server.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP13doFastUpgradeyyF\":{\"name\":\"doFastUpgrade()\",\"abstract\":\"
Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP024flushWaitingForPostToWebA0yyF\":{\"name\":\"flushWaitingForPostToWebSocket()\",\"abstract\":\"
Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP05parseC4Datayy10Foundation0F0VF\":{\"name\":\"parseEngineData(_:)\",\"abstract\":\"
Parses raw binary received from engine.io.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP05parseC7MessageyySSF\":{\"name\":\"parseEngineMessage(_:)\",\"abstract\":\"
Parses a raw engine.io packet.
\",\"parent_name\":\"SocketEngineSpec\"},\"Protocols/SocketEngineSpec.html#/s:8SocketIO0A10EngineSpecP5write_8withType0F4Data10completionySS_AA0ac6PacketG0OSay10Foundation0H0VGyycSgtF\":{\"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.
\",\"parent_name\":\"SocketEnginePollable\"},\"Protocols/SocketEnginePollable.html#/s:8SocketIO0A14EnginePollableP8postWaitSaySS3msg_yycSg10completiontGvp\":{\"name\":\"postWait\",\"abstract\":\"
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)engineDidReceivePing\":{\"name\":\"engineDidReceivePing()\",\"abstract\":\"
Called when the engine receives a ping message. Only called in socket.io >3.
\",\"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. Only called in socket.io 2.
\",\"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. Only called in socket.io 2.
\",\"parent_name\":\"SocketEngineClient\"},\"Protocols/SocketEngineClient.html#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidSendPong\":{\"name\":\"engineDidSendPong()\",\"abstract\":\"
Called when the engine sends a pong to the server. Only called in socket.io >3.
\",\"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:8SocketIO0A12IOClientSpecP3sidSSSgvp\":{\"name\":\"sid\",\"abstract\":\"
The id of this socket.io connect. This is different from the sid of the engine.io connection.
\",\"parent_name\":\"SocketIOClientSpec\"},\"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP6statusAA0A8IOStatusOvp\":{\"name\":\"status\",\"abstract\":\"
The status of this client.
\",\"parent_name\":\"SocketIOClientSpec\"},\"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7connect11withPayloadySDySSypGSg_tF\":{\"name\":\"connect(withPayload:)\",\"abstract\":\"
Connect to the server. The same as calling connect(timeoutAfter:withHandler:) with a timeout of 0.
\",\"parent_name\":\"SocketIOClientSpec\"},\"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7connect11withPayload12timeoutAfter0F7HandlerySDySSypGSg_SdyycSgtF\":{\"name\":\"connect(withPayload:timeoutAfter:withHandler:)\",\"abstract\":\"
Connect to the server. If we aren’t connected after timeoutAfter seconds, then withHandler is called.
\",\"parent_name\":\"SocketIOClientSpec\"},\"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP10didConnect11toNamespace7payloadySS_SDySSypGSgtF\":{\"name\":\"didConnect(toNamespace:payload:)\",\"abstract\":\"
Called when the client connects to a namespace. If the client was created with a namespace upfront,\",\"parent_name\":\"SocketIOClientSpec\"},\"Protocols/SocketIOClientSpec.html#/s: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.
\",\"parent_name\":\"SocketIOClientSpec\"},\"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF\":{\"name\":\"emitWithAck(_:_:)\",\"abstract\":\"
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:8SocketIO0A12IOClientSpecP13joinNamespace11withPayloadySDySSypGSg_tF\":{\"name\":\"joinNamespace(withPayload:)\",\"abstract\":\"
Joins nsp. You shouldn’t need to call this directly, instead call connect.
\",\"parent_name\":\"SocketIOClientSpec\"},\"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3off11clientEventyAA0a6ClientG0O_tF\":{\"name\":\"off(clientEvent:)\",\"abstract\":\"
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
\",\"parent_name\":\"SocketIOClientSpec\"},\"Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP2on_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF\":{\"name\":\"on(_:callback:)\",\"abstract\":\"
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.
\",\"parent_name\":\"ConfigSettable\"},\"Protocols/ConfigSettable.html\":{\"name\":\"ConfigSettable\",\"abstract\":\"
Declares that a type can set configs from a SocketIOClientConfiguration.
\"},\"Protocols/SocketIOClientSpec.html\":{\"name\":\"SocketIOClientSpec\",\"abstract\":\"
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.
\"},\"Extensions.html#/s:Sa\":{\"name\":\"Array\"},\"Extensions.html#/s:Sb\":{\"name\":\"Bool\"},\"Extensions.html#/s:SD\":{\"name\":\"Dictionary\"},\"Extensions.html#/s:Sd\":{\"name\":\"Double\"},\"Extensions.html#/s:Si\":{\"name\":\"Int\"},\"Extensions.html#/c:objc(cs)NSArray\":{\"name\":\"NSArray\"},\"Extensions.html#/s:10Foundation4DataV\":{\"name\":\"Data\"},\"Extensions.html#/c:objc(cs)NSData\":{\"name\":\"NSData\"},\"Extensions.html#/c:objc(cs)NSDictionary\":{\"name\":\"NSDictionary\"},\"Extensions.html#/c:objc(cs)NSString\":{\"name\":\"NSString\"},\"Extensions.html#/c:objc(cs)NSNull\":{\"name\":\"NSNull\"},\"Extensions.html#/s:SS\":{\"name\":\"String\"},\"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.
\",\"parent_name\":\"SocketIOClientOption\"},\"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO15forceWebsocketsyACSbcACmF\":{\"name\":\"forceWebsockets(_:)\",\"abstract\":\"
If passed true, the only transport that will be used will be WebSockets.
\",\"parent_name\":\"SocketIOClientOption\"},\"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO16enableSOCKSProxyyACSbcACmF\":{\"name\":\"enableSOCKSProxy(_:)\",\"abstract\":\"
If passed true, the WebSocket stream will be configured with the enableSOCKSProxy true.
\",\"parent_name\":\"SocketIOClientOption\"},\"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO11handleQueueyACSo17OS_dispatch_queueCcACmF\":{\"name\":\"handleQueue(_:)\",\"abstract\":\"
The queue that all interaction with the client should occur on. This is the queue that event handlers are\",\"parent_name\":\"SocketIOClientOption\"},\"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO3logyACSbcACmF\":{\"name\":\"log(_:)\",\"abstract\":\"
If passed true, the client will log debug information. This should be turned off in production code.
\",\"parent_name\":\"SocketIOClientOption\"},\"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO6loggeryAcA0A6Logger_pcACmF\":{\"name\":\"logger(_:)\",\"abstract\":\"
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.
\",\"parent_name\":\"SocketIOClientOption\"},\"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO13reconnectWaityACSicACmF\":{\"name\":\"reconnectWait(_:)\",\"abstract\":\"
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.
\",\"parent_name\":\"SocketIOClientOption\"},\"Enums/SocketIOClientOption.html#/s:8SocketIO0A14IOClientOptionO8securityyAC10Starscream18CertificatePinning_pcACmF\":{\"name\":\"security(_:)\",\"abstract\":\"
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:8SocketIO0A14IOClientOptionO7versionyAcA0A9IOVersionOcACmF\":{\"name\":\"version(_:)\",\"abstract\":\"
The version of socket.io being used. This should match the server version. Default is 3.
\",\"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/SocketIOVersion.html#/s:8SocketIO0A9IOVersionO3twoyA2CmF\":{\"name\":\"two\",\"abstract\":\"
socket.io 2, engine.io 3
\",\"parent_name\":\"SocketIOVersion\"},\"Enums/SocketIOVersion.html#/s:8SocketIO0A9IOVersionO5threeyA2CmF\":{\"name\":\"three\",\"abstract\":\"
socket.io 3, engine.io 4
\",\"parent_name\":\"SocketIOVersion\"},\"Enums/SocketAckStatus.html#/s:8SocketIO0A9AckStatusO02noC0yA2CmF\":{\"name\":\"noAck\",\"abstract\":\"
The ack timed out.
\",\"parent_name\":\"SocketAckStatus\"},\"Enums/SocketAckStatus.html#/s:8SocketIO0A9AckStatusO2eeoiySbSS_ACtFZ\":{\"name\":\"==(_:_:)\",\"abstract\":\"
Tests whether a string is equal to a given SocketAckStatus
\",\"parent_name\":\"SocketAckStatus\"},\"Enums/SocketAckStatus.html#/s:8SocketIO0A9AckStatusO2eeoiySbAC_SStFZ\":{\"name\":\"==(_:_:)\",\"abstract\":\"
Tests whether a string is equal to a given SocketAckStatus
\",\"parent_name\":\"SocketAckStatus\"},\"Enums/SocketAckStatus.html\":{\"name\":\"SocketAckStatus\",\"abstract\":\"
The status of an ack.
\"},\"Enums/SocketIOVersion.html\":{\"name\":\"SocketIOVersion\",\"abstract\":\"
The socket.io version being used.
\"},\"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/SocketManager.html#/s:8SocketIO0A7ManagerC07defaultA0AA0A8IOClientCvp\":{\"name\":\"defaultSocket\",\"abstract\":\"
The socket associated with the default namespace (“/”).
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC9socketURL10Foundation0E0Vvp\":{\"name\":\"socketURL\",\"abstract\":\"
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#/s:8SocketIO0A7ManagerC6engineAA0A10EngineSpec_pSgvp\":{\"name\":\"engine\",\"abstract\":\"
The engine for this manager.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC8forceNewSbvp\":{\"name\":\"forceNew\",\"abstract\":\"
If true then every time connect is called, a new engine will be created.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC11handleQueueSo17OS_dispatch_queueCvp\":{\"name\":\"handleQueue\",\"abstract\":\"
The queue that all interaction with the client should occur on. This is the queue that event handlers are\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC4nspsSDySSAA0A8IOClientCGvp\":{\"name\":\"nsps\",\"abstract\":\"
The sockets in this manager indexed by namespace.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC10reconnectsSbvp\":{\"name\":\"reconnects\",\"abstract\":\"
If true, this client will try and reconnect on any disconnects.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC13reconnectWaitSivp\":{\"name\":\"reconnectWait\",\"abstract\":\"
The minimum number of seconds to wait before attempting to reconnect.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC16reconnectWaitMaxSivp\":{\"name\":\"reconnectWaitMax\",\"abstract\":\"
The maximum number of seconds to wait before attempting to reconnect.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC19randomizationFactorSdvp\":{\"name\":\"randomizationFactor\",\"abstract\":\"
The randomization factor for calculating reconnect jitter.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC6statusAA0A8IOStatusOvp\":{\"name\":\"status\",\"abstract\":\"
The status of this manager.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A11ManagerSpecP7versionAA0A9IOVersionOvp\":{\"name\":\"version\",\"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.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)initWithSocketURL:config:\":{\"name\":\"init(socketURL:config:)\",\"abstract\":\"
Not so type safe way to create a SocketIOClient, meant for Objective-C compatiblity.\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC7connectyyF\":{\"name\":\"connect()\",\"abstract\":\"
Connects the underlying transport and the default namespace socket.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC07connectA0_11withPayloadyAA0A8IOClientC_SDySSypGSgtF\":{\"name\":\"connectSocket(_:withPayload:)\",\"abstract\":\"
Connects a socket through this manager’s engine.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC13didDisconnect6reasonySS_tF\":{\"name\":\"didDisconnect(reason:)\",\"abstract\":\"
Called when the manager has disconnected from socket.io.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC10disconnectyyF\":{\"name\":\"disconnect()\",\"abstract\":\"
Disconnects the manager and all associated sockets.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC010disconnectA0yyAA0A8IOClientCF\":{\"name\":\"disconnectSocket(_:)\",\"abstract\":\"
Disconnects the given socket.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC010disconnectA012forNamespaceySS_tF\":{\"name\":\"disconnectSocket(forNamespace:)\",\"abstract\":\"
Disconnects the socket associated with forNamespace.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC7emitAll11clientEvent4datayAA0a6ClientG0O_SayypGtF\":{\"name\":\"emitAll(clientEvent:data:)\",\"abstract\":\"
Sends a client event to all sockets in nsps
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC7emitAllyySS_AA0A4Data_pdtF\":{\"name\":\"emitAll(_:_:)\",\"abstract\":\"
Sends an event to the server on all namespaces in this manager.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(im)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)engineDidReceivePing\":{\"name\":\"engineDidReceivePing()\",\"abstract\":\"
Called when the engine receives a ping 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)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)engineDidSendPong\":{\"name\":\"engineDidSendPong()\",\"abstract\":\"
Called when the sends a pong 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#/s:8SocketIO0A7ManagerC9reconnectyyF\":{\"name\":\"reconnect()\",\"abstract\":\"
Tries to reconnect to the server.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketManager.html#/s:8SocketIO0A7ManagerC06removeA0yAA0A8IOClientCSgAFF\":{\"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#/s:8SocketIO0A7ManagerC6socket12forNamespaceAA0A8IOClientCSS_tF\":{\"name\":\"socket(forNamespace:)\",\"abstract\":\"
Returns a SocketIOClient for the given namespace. This socket shares a transport with the manager.
\",\"parent_name\":\"SocketManager\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC11engineQueueSo17OS_dispatch_queueCvp\":{\"name\":\"engineQueue\",\"abstract\":\"
The queue that all engine actions take place on.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC13connectParamsSDySSypGSgvp\":{\"name\":\"connectParams\",\"abstract\":\"
The connect parameters sent during a connect.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC12extraHeadersSDyS2SGSgvp\":{\"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#/s:8SocketIO0A6EngineC6closedSbvp\":{\"name\":\"closed\",\"abstract\":\"
true if this engine is closed.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC8compressSbvp\":{\"name\":\"compress\",\"abstract\":\"
If true the engine will attempt to use WebSocket compression.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC9connectedSbvp\":{\"name\":\"connected\",\"abstract\":\"
true if this engine is connected. Connected means that the initial poll connect has succeeded.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC7cookiesSaySo12NSHTTPCookieCGSgvp\":{\"name\":\"cookies\",\"abstract\":\"
An array of HTTPCookies that are sent during the connection.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC11fastUpgradeSbvp\":{\"name\":\"fastUpgrade\",\"abstract\":\"
When true, the engine is in the process of switching to WebSockets.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC12forcePollingSbvp\":{\"name\":\"forcePolling\",\"abstract\":\"
When true, the engine will only use HTTP long-polling as a transport.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC15forceWebsocketsSbvp\":{\"name\":\"forceWebsockets\",\"abstract\":\"
When true, the engine will only use WebSockets as a transport.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC11invalidatedSbvp\":{\"name\":\"invalidated\",\"abstract\":\"
true If engine’s session has been invalidated.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC7pollingSbvp\":{\"name\":\"polling\",\"abstract\":\"
If true, the engine is currently in HTTP long-polling mode.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC7probingSbvp\":{\"name\":\"probing\",\"abstract\":\"
If true, the engine is currently seeing whether it can upgrade to WebSockets.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC7sessionSo12NSURLSessionCSgvp\":{\"name\":\"session\",\"abstract\":\"
The URLSession that will be used for polling.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC3sidSSvp\":{\"name\":\"sid\",\"abstract\":\"
The session id for this engine.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC10socketPathSSvp\":{\"name\":\"socketPath\",\"abstract\":\"
The path to engine.io.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC10urlPolling10Foundation3URLVvp\":{\"name\":\"urlPolling\",\"abstract\":\"
The url for polling.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC06urlWebA010Foundation3URLVvp\":{\"name\":\"urlWebSocket\",\"abstract\":\"
The url for WebSockets.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC7versionAA0A9IOVersionOvp\":{\"name\":\"version\",\"abstract\":\"
The version of engine.io being used. Default is three.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC9websocketSbvp\":{\"name\":\"websocket\",\"abstract\":\"
If true, then the engine is currently in WebSockets mode.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC16enableSOCKSProxySbvp\":{\"name\":\"enableSOCKSProxy\",\"abstract\":\"
When true, the WebSocket stream will be configured with the enableSOCKSProxy true.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC2ws10Starscream03WebA0CSgvp\":{\"name\":\"ws\",\"abstract\":\"
The WebSocket for this engine.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC11wsConnectedSbvp\":{\"name\":\"wsConnected\",\"abstract\":\"
Whether or not the WebSocket is currently connected.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC6clientAA0aC6Client_pSgvp\":{\"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#/s:8SocketIO0A6EngineC6client3url7optionsAcA0aC6Client_p_10Foundation3URLVSDySSypGSgtcfc\":{\"name\":\"init(client:url:options:)\",\"abstract\":\"
Creates a new engine.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC7connectyyF\":{\"name\":\"connect()\",\"abstract\":\"
Starts the connection to the server.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC8didError6reasonySS_tF\":{\"name\":\"didError(reason:)\",\"abstract\":\"
Called when an error happens during execution. Causes a disconnection.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC10disconnect6reasonySS_tF\":{\"name\":\"disconnect(reason:)\",\"abstract\":\"
Disconnects from the server.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC13doFastUpgradeyyF\":{\"name\":\"doFastUpgrade()\",\"abstract\":\"
Called to switch from HTTP long-polling to WebSockets. After calling this method the engine will be in\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC024flushWaitingForPostToWebA0yyF\":{\"name\":\"flushWaitingForPostToWebSocket()\",\"abstract\":\"
Causes any packets that were waiting for POSTing to be sent through the WebSocket. This happens because when\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC05parseC4Datayy10Foundation0E0VF\":{\"name\":\"parseEngineData(_:)\",\"abstract\":\"
Parses raw binary received from engine.io.
\",\"parent_name\":\"SocketEngine\"},\"Classes/SocketEngine.html#/s:8SocketIO0A6EngineC05parseC7MessageyySSF\":{\"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#/s:8SocketIO0A6EngineC5write_8withType0E4Data10completionySS_AA0ac6PacketF0OSay10Foundation0G0VGyycSgtF\":{\"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/SocketEngine.html#/s:8SocketIO0A6EngineC10didReceive5event6clienty10Starscream03WebA5EventO_AG0iA0CtF\":{\"name\":\"didReceive(event:client:)\",\"abstract\":\"
Delegate method for WebSocketDelegate.
\",\"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#/s:8SocketIO0A8IOClientC3nspSSvp\":{\"name\":\"nsp\",\"abstract\":\"
The namespace that this socket is currently connected to.
\",\"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#/s:8SocketIO0A8IOClientC7managerAA0A11ManagerSpec_pSgvp\":{\"name\":\"manager\",\"abstract\":\"
The manager for this socket.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC11rawEmitViewAA0a3RawF0Cvp\":{\"name\":\"rawEmitView\",\"abstract\":\"
A view into this socket where emits do not check for binary data.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC6statusAA0A8IOStatusOvp\":{\"name\":\"status\",\"abstract\":\"
The status of this client.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC3sidSSSgvp\":{\"name\":\"sid\",\"abstract\":\"
The id of this socket.io connect. This is different from the sid of the engine.io connection.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC7manager3nspAcA0A11ManagerSpec_p_SStcfc\":{\"name\":\"init(manager:nsp:)\",\"abstract\":\"
Type safe way to create a new SocketIOClient. opts can be omitted.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC7connect11withPayloadySDySSypGSg_tF\":{\"name\":\"connect(withPayload:)\",\"abstract\":\"
Connect to the server. The same as calling connect(timeoutAfter:withHandler:) with a timeout of 0.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC7connect11withPayload12timeoutAfter0E7HandlerySDySSypGSg_SdyycSgtF\":{\"name\":\"connect(withPayload:timeoutAfter:withHandler:)\",\"abstract\":\"
Connect to the server. If we aren’t connected after timeoutAfter seconds, then withHandler is called.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10didConnect11toNamespace7payloadySS_SDySSypGSgtF\":{\"name\":\"didConnect(toNamespace:payload:)\",\"abstract\":\"
Called when the client connects to a namespace. If the client was created with a namespace upfront,\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC13didDisconnect6reasonySS_tF\":{\"name\":\"didDisconnect(reason:)\",\"abstract\":\"
Called when the client has disconnected from socket.io.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10disconnectyyF\":{\"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#/s:8SocketIO0A8IOClientC11emitWithAckyAA02OnF8CallbackCSS_AA0A4Data_pdtF\":{\"name\":\"emitWithAck(_:_:)\",\"abstract\":\"
Sends a message to the server, requesting an ack.
\",\"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.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC9handleAck_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\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC17handleClientEvent_4datayAA0aeF0O_SayypGtF\":{\"name\":\"handleClientEvent(_:data:)\",\"abstract\":\"
Called on socket.io specific events.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC11handleEvent_4data17isInternalMessage7withAckySS_SayypGSbSitF\":{\"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#/s:8SocketIO0A8IOClientC14leaveNamespaceyyF\":{\"name\":\"leaveNamespace()\",\"abstract\":\"
Call when you wish to leave a namespace and disconnect this socket.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC13joinNamespace11withPayloadySDySSypGSg_tF\":{\"name\":\"joinNamespace(withPayload:)\",\"abstract\":\"
Joins nsp. You shouldn’t need to call this directly, instead call connect.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC3off11clientEventyAA0a6ClientF0O_tF\":{\"name\":\"off(clientEvent:)\",\"abstract\":\"
Removes handler(s) for a client event.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC3offyySSF\":{\"name\":\"off(_:)\",\"abstract\":\"
Removes handler(s) based on an event name.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC3off2idy10Foundation4UUIDV_tF\":{\"name\":\"off(id:)\",\"abstract\":\"
Removes a handler with the specified UUID gotten from an on or once
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC2on_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF\":{\"name\":\"on(_:callback:)\",\"abstract\":\"
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#/s:8SocketIO0A8IOClientC4once_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF\":{\"name\":\"once(_:callback:)\",\"abstract\":\"
Adds a single-use handler for an event.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC5onAnyyyyAA0aE5EventCcF\":{\"name\":\"onAny(_:)\",\"abstract\":\"
Adds a handler that will be called on every event.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC17removeAllHandlersyyF\":{\"name\":\"removeAllHandlers()\",\"abstract\":\"
Removes all handlers.
\",\"parent_name\":\"SocketIOClient\"},\"Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC15setReconnecting6reasonySS_tF\":{\"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.
\",\"parent_name\":\"SocketAckEmitter\"},\"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC6socket6ackNumAcA0A8IOClientC_Sitcfc\":{\"name\":\"init(socket:ackNum:)\",\"abstract\":\"
Creates a new SocketAckEmitter.
\",\"parent_name\":\"SocketAckEmitter\"},\"Classes/SocketAckEmitter.html#/s:8SocketIO0A10AckEmitterC4withyyAA0A4Data_pd_tF\":{\"name\":\"with(_:)\",\"abstract\":\"
Call to ack receiving this event.
\",\"parent_name\":\"SocketAckEmitter\"},\"Classes/SocketAckEmitter.html#/c:@M@SocketIO@objc(cs)SocketAckEmitter(im)with:\":{\"name\":\"with(_:)\",\"abstract\":\"
Call to ack receiving this event.
\",\"parent_name\":\"SocketAckEmitter\"},\"Classes/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.
\"},\"15to16.html\":{\"name\":\"15to16\"},\"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.
\"},\"Extensions.html\":{\"name\":\"Extensions\",\"abstract\":\"
The following extensions 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.
\"}}"
}
]
![](\"img/carat.png\")
\n 12to13 Reference\n ![](\"../img/carat.png\")
\n OnAckCallback Class Reference\n ![](\"../../img/carat.png\")
\n PacketType Enumeration Reference\n ![\"Build](\"https://travis-ci.org/socketio/socket.io-client-swift.svg?branch=master\")