cheykrym/socket.io-client-swift
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Start working on migration guide

Browse Source
This commit is contained in:
Erik Little 2020-11-07 19:19:06 -05:00
parent 194642314e
commit 21290f5752
No known key found for this signature in database
GPG Key ID: 62F837E56F4E9320
50 changed files with 4301 additions and 1599 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -31,56 +31,23 @@ socket.on("currentAmount") {data, ack in
socket.connect() socket.connect()
``` ```
## Objective-C Example
```objective-c
@import SocketIO;
NSURL* url = [[NSURL alloc] initWithString:@"http://localhost:8080"];
SocketManager* manager = [[SocketManager alloc] initWithSocketURL:url config:@{@"log": @YES, @"compress": @YES}];
SocketIOClient* socket = manager.defaultSocket;
[socket on:@"connect" callback:^(NSArray* data, SocketAckEmitter* ack) {
NSLog(@"socket connected");
}];
[socket on:@"currentAmount" callback:^(NSArray* data, SocketAckEmitter* ack) {
double cur = [[data objectAtIndex:0] floatValue];
[[socket emitWithAck:@"canUpdate" with:@[@(cur)]] timingOutAfter:0 callback:^(NSArray* data) {
if ([[data[0] description] isEqualToString:@"NO ACK"]) {
// Handle ack timeout
}
[socket emit:@"update" with:@[@{@"amount": @(cur + 2.50)}]];
}];
[ack with:@[@"Got your currentAmount, ", @"dude"]];
}];
[socket connect];
```
## Features ## Features
- Supports socket.io 2.0+ (For socket.io 1.0 use v9.x) - Supports socket.io 3.0+ (For socket.io 1.0 use v9.x, For socket.io 2.0 use 15.x)
- Supports binary - Supports Binary
- Supports Polling and WebSockets - Supports Polling and WebSockets
- Supports TLS/SSL - Supports TLS/SSL
- Can be used from Objective-C
## FAQS ## FAQS
Checkout the [FAQs](https://nuclearace.github.io/Socket.IO-Client-Swift/faq.html) for commonly asked questions. Checkout the [FAQs](https://nuclearace.github.io/Socket.IO-Client-Swift/faq.html) for commonly asked questions.
Checkout the [12to13](https://nuclearace.github.io/Socket.IO-Client-Swift/12to13.html) guide for migrating to v13+ from v12 below. Checkout the [12to13](https://nuclearace.github.io/Socket.IO-Client-Swift/12to13.html) guide for migrating to v13+ from v12 below.
Checkout the [15to16](https://nuclearace.github.io/Socket.IO-Client-Swift/15to16.html) guide for migrating to v16+ from v15.
## Installation ## Installation
Requires Swift 4/5 and Xcode 10.x Requires Swift 4/5 and Xcode 10.x
If you need Swift 2.3 use the [swift2.3 tag](https://github.com/socketio/socket.io-client-swift/releases/tag/swift2.3) (Pre-Swift 4 support is no longer maintained)
If you need Swift 3.x use v11.1.3.
### Swift Package Manager ### Swift Package Manager
Add the project as a dependency to your Package.swift: Add the project as a dependency to your Package.swift:
```swift ```swift

5
Source/SocketIO/Engine/SocketEngine.swift
View File

@ -681,6 +681,11 @@ enum EngineError: Error {
} }
extension SocketEngine { extension SocketEngine {
/// Delegate method for WebSocketDelegate.
///
/// - Parameters:
/// - event: WS Event
/// - _:
public func didReceive(event: WebSocketEvent, client _: WebSocket) { public func didReceive(event: WebSocketEvent, client _: WebSocket) {
switch event { switch event {
case let .connected(headers): case let .connected(headers):

3
Usage Docs/15to16.md Normal file
View File

@ -0,0 +1,3 @@
# Upgrading from v15 to v16
This guide will help you navigate the changes that were introduced in v16.

71
docs/12to13.html
View File

@ -20,7 +20,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="index.html"> <a class="header-link" href="index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -49,6 +49,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="12to13.html">12to13</a> <a class="nav-group-task-link" href="12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="faq.html">FAQ</a> <a class="nav-group-task-link" href="faq.html">FAQ</a>
</li> </li>
@ -60,9 +63,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -109,6 +109,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a> <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -183,7 +224,7 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1 id='upgrading-from-v12' class='heading'>Upgrading from v12</h1> <h1 id='upgrading-from-v12' class='heading'>Upgrading from v12</h1>
@ -195,8 +236,8 @@ the swift client now only uses one engine per connection. Previously in order to
to create multiple clients, and each client had its own engine.</p> to create multiple clients, and each client had its own engine.</p>
<p>Some v12 code might&rsquo;ve looked like this:</p> <p>Some v12 code might&rsquo;ve looked like this:</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">defaultSocket</span> <span class="o">=</span> <span class="nf">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">)</span> <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">defaultSocket</span> <span class="o">=</span> <span class="kt">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">)</span>
<span class="k">let</span> <span class="nv">namespaceSocket</span> <span class="o">=</span> <span class="nf">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">,</span> <span class="nv">config</span><span class="p">:</span> <span class="p">[</span><span class="o">.</span><span class="nf">nsp</span><span class="p">(</span><span class="s">"/swift"</span><span class="p">)])</span> <span class="k">let</span> <span class="nv">namespaceSocket</span> <span class="o">=</span> <span class="kt">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">,</span> <span class="nv">config</span><span class="p">:</span> <span class="p">[</span><span class="o">.</span><span class="nf">nsp</span><span class="p">(</span><span class="s">"/swift"</span><span class="p">)])</span>
<span class="c1">// add handlers for sockets and connect</span> <span class="c1">// add handlers for sockets and connect</span>
@ -205,7 +246,7 @@ to create multiple clients, and each client had its own engine.</p>
<p>In v12 this would have opened two connections to the socket.io.</p> <p>In v12 this would have opened two connections to the socket.io.</p>
<p>In v13 the same code would look like this:</p> <p>In v13 the same code would look like this:</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="nf">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">)</span> <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="kt">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">)</span>
<span class="k">let</span> <span class="nv">defaultSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span> <span class="k">let</span> <span class="nv">defaultSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span>
<span class="k">let</span> <span class="nv">namespaceSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span> <span class="k">let</span> <span class="nv">namespaceSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span>
@ -236,9 +277,9 @@ associated with that namespace.</p></li>
<p>You should know that <code><a href="Classes/SocketIOClient.html">SocketIOClient</a></code>s no longer need to be held around in properties, but the <code><a href="Classes/SocketManager.html">SocketManager</a></code> should.</p> <p>You should know that <code><a href="Classes/SocketIOClient.html">SocketIOClient</a></code>s no longer need to be held around in properties, but the <code><a href="Classes/SocketManager.html">SocketManager</a></code> should.</p>
<p>One of the most common mistakes people made is not maintaining a strong reference to the client.</p> <p>One of the most common mistakes people made is not maintaining a strong reference to the client.</p>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="nf">Manager</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">Manager</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">addHandlers</span><span class="p">()</span> <span class="p">{</span> <span class="kd">func</span> <span class="nf">addHandlers</span><span class="p">()</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">socket</span> <span class="o">=</span> <span class="nf">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">,</span> <span class="nv">config</span><span class="p">:</span> <span class="p">[</span><span class="o">.</span><span class="nf">nsp</span><span class="p">(</span><span class="s">"/swift"</span><span class="p">)])</span> <span class="k">let</span> <span class="nv">socket</span> <span class="o">=</span> <span class="kt">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">,</span> <span class="nv">config</span><span class="p">:</span> <span class="p">[</span><span class="o">.</span><span class="nf">nsp</span><span class="p">(</span><span class="s">"/swift"</span><span class="p">)])</span>
<span class="c1">// Add handlers</span> <span class="c1">// Add handlers</span>
<span class="p">}</span> <span class="p">}</span>
@ -248,8 +289,8 @@ associated with that namespace.</p></li>
<p>This would have resulted in the client being released and no handlers being called.</p> <p>This would have resulted in the client being released and no handlers being called.</p>
<p>A <em>correct</em> equivalent would be:</p> <p>A <em>correct</em> equivalent would be:</p>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="nf">Manager</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">Manager</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">socketManager</span> <span class="o">=</span> <span class="nf">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">someURL</span><span class="p">)</span> <span class="k">let</span> <span class="nv">socketManager</span> <span class="o">=</span> <span class="kt">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">someURL</span><span class="p">)</span>
<span class="kd">func</span> <span class="nf">addHandlers</span><span class="p">()</span> <span class="p">{</span> <span class="kd">func</span> <span class="nf">addHandlers</span><span class="p">()</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">socket</span> <span class="o">=</span> <span class="n">socketManager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span> <span class="k">let</span> <span class="nv">socket</span> <span class="o">=</span> <span class="n">socketManager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span>
@ -268,7 +309,7 @@ multiple managers.</strong></p>
<h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2> <h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2>
<p>Connect can either be called on the manager directly, or on one of the sockets made from it. In either case, if the manager <p>Connect can either be called on the manager directly, or on one of the sockets made from it. In either case, if the manager
was not already connected to the server, a connection will be made. Also in both cases the default socket (namespace <q>/</q>) was not already connected to the server, a connection will be made. Also in both cases the default socket (namespace &ldquo;/&rdquo;)
will fire a <code>connect</code> event. </p> will fire a <code>connect</code> event. </p>
<p>The difference is that if <code>connect()</code> is just called on the manager, then any sockets for that manager that are not the default <p>The difference is that if <code>connect()</code> is just called on the manager, then any sockets for that manager that are not the default
@ -283,8 +324,8 @@ and a <code>connect</code> event fired.</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

245
docs/15to16.html Normal file
View File

@ -0,0 +1,245 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>15to16 Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset="utf-8">
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a title="15to16 Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
SocketIO 16.0.0-beta2 Docs
</a>
(100% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">SocketIO Reference</a>
<img class="carat" src="img/carat.png" />
15to16 Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Guides.html">Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="12to13.html">12to13</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="15to16.html">15to16</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="faq.html">FAQ</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAnyEvent.html">SocketAnyEvent</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketEngine.html">SocketEngine</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketIOClient.html">SocketIOClient</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketManager.html">SocketManager</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketRawAckView.html">SocketRawAckView</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketRawView.html">SocketRawView</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketAckStatus.html">SocketAckStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketClientEvent.html">SocketClientEvent</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketEnginePacketType.html">SocketEnginePacketType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketIOClientOption.html">SocketIOClientOption</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketIOStatus.html">SocketIOStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketParsableError.html">SocketParsableError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ConfigSettable.html">ConfigSettable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketData.html">SocketData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketDataBufferable.html">SocketDataBufferable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketEngineClient.html">SocketEngineClient</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketEnginePollable.html">SocketEnginePollable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketEngineSpec.html">SocketEngineSpec</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketEngineWebsocket.html">SocketEngineWebsocket</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketIOClientSpec.html">SocketIOClientSpec</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketLogger.html">SocketLogger</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketManagerSpec.html">SocketManagerSpec</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketParsable.html">SocketParsable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SocketEventHandler.html">SocketEventHandler</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SocketIOClientConfiguration.html">SocketIOClientConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SocketPacket.html">SocketPacket</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SocketPacket/PacketType.html">– PacketType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:8SocketIO11AckCallbacka">AckCallback</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:8SocketIO14NormalCallbacka">NormalCallback</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:8SocketIO4Posta">Post</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1 id='upgrading-from-v15-to-v16' class='heading'>Upgrading from v15 to v16</h1>
<p>This guide will help you navigate the changes that were introduced in v16.</p>
</div>
</section>
</article>
</div>
<section class="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>

114
docs/Classes.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="index.html"> <a class="header-link" href="index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="12to13.html">12to13</a> <a class="nav-group-task-link" href="12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="faq.html">FAQ</a> <a class="nav-group-task-link" href="faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a> <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,7 +225,7 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>Classes</h1> <h1>Classes</h1>
<p>The following classes are available globally.</p> <p>The following classes are available globally.</p>
@ -259,10 +300,6 @@ Example:</p>
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -291,10 +328,6 @@ Example:</p>
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -334,10 +367,6 @@ Example:</p>
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -402,10 +431,6 @@ Example:</p>
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -428,17 +453,14 @@ See <code><a href="Protocols/SocketEnginePollable.html">SocketEnginePollable</a>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">SocketEngine</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">URLSessionDelegate</span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketEnginePollable.html">SocketEnginePollable</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketEngineWebsocket.html">SocketEngineWebsocket</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/ConfigSettable.html">ConfigSettable</a></span></code></pre> <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">SocketEngine</span><span class="p">:</span>
<span class="kt">NSObject</span><span class="p">,</span> <span class="kt">WebSocketDelegate</span><span class="p">,</span> <span class="kt">URLSessionDelegate</span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketEnginePollable.html">SocketEnginePollable</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketEngineWebsocket.html">SocketEngineWebsocket</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/ConfigSettable.html">ConfigSettable</a></span></code></pre>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -457,7 +479,7 @@ See <code><a href="Protocols/SocketEnginePollable.html">SocketEnginePollable</a>
<p>A <code>SocketManager</code> is responsible for multiplexing multiple namespaces through a single <code><a href="Protocols/SocketEngineSpec.html">SocketEngineSpec</a></code>.</p> <p>A <code>SocketManager</code> is responsible for multiplexing multiple namespaces through a single <code><a href="Protocols/SocketEngineSpec.html">SocketEngineSpec</a></code>.</p>
<p>Example:</p> <p>Example:</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="nf">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="nf">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span><span class="s">"http://localhost:8080/"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span> <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="kt">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span><span class="s">"http://localhost:8080/"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span>
<span class="k">let</span> <span class="nv">defaultNamespaceSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span> <span class="k">let</span> <span class="nv">defaultNamespaceSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span>
<span class="k">let</span> <span class="nv">swiftSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span> <span class="k">let</span> <span class="nv">swiftSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span>
@ -467,7 +489,7 @@ See <code><a href="Protocols/SocketEnginePollable.html">SocketEnginePollable</a>
<p>Sockets created through the manager are retained by the manager. So at the very least, a single strong reference <p>Sockets created through the manager are retained by the manager. So at the very least, a single strong reference
to the manager must be maintained to keep sockets alive.</p> to the manager must be maintained to keep sockets alive.</p>
<p>To disconnect a socket and remove it from the manager, either call <code><a href="Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)disconnect">SocketIOClient.disconnect()</a></code> on the socket, <p>To disconnect a socket and remove it from the manager, either call <code><a href="Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10disconnectyyF">SocketIOClient.disconnect()</a></code> on the socket,
or call one of the <code>disconnectSocket</code> methods on this class.</p> or call one of the <code>disconnectSocket</code> methods on this class.</p>
<p><strong>NOTE</strong>: The manager is not thread/queue safe, all interaction with the manager should be done on the <code>handleQueue</code></p> <p><strong>NOTE</strong>: The manager is not thread/queue safe, all interaction with the manager should be done on the <code>handleQueue</code></p>
@ -487,46 +509,14 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
</li> </li>
</ul> </ul>
</div> </div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/c:@M@SocketIO@objc(cs)SSLSecurity"></a>
<a name="//apple_ref/swift/Class/SSLSecurity" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SSLSecurity">SSLSecurity</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A wrapper around Starscream&rsquo;s SSLSecurity that provides a minimal Objective-C interface.</p>
<a href="Classes/SSLSecurity.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">SSLSecurity</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div> </div>
</section> </section>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

66
docs/Classes/OnAckCallback.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>OnAckCallback</h1> <h1>OnAckCallback</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">OnAckCallback</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">OnAckCallback</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div> </div>
@ -209,9 +251,11 @@ Example:</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -219,7 +263,7 @@ Example:</p>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)OnAckCallback(im)timingOutAfter:callback:"></a> <a name="/c:@M@SocketIO@objc(cs)OnAckCallback(im)timingOutAfter:callback:"></a>
<a name="//apple_ref/swift/Method/timingOut(after:callback:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/timingOut(after:callback:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)OnAckCallback(im)timingOutAfter:callback:">timingOut(after:callback:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)OnAckCallback(im)timingOutAfter:callback:">timingOut(after:<wbr>callback:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -282,8 +326,8 @@ Example:</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

90
docs/Classes/SocketAckEmitter.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketAckEmitter</h1> <h1>SocketAckEmitter</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketAckEmitter</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketAckEmitter</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div> </div>
@ -230,7 +272,7 @@
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span> <pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">rawEmitView</span><span class="p">:</span> <span class="nf">SocketRawAckView</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">rawEmitView</span><span class="p">:</span> <span class="kt"><a href="../Classes/SocketRawAckView.html">SocketRawAckView</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -243,9 +285,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -268,7 +312,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">expected</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">expected</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -281,9 +325,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Initializers"></a> <a name="/Initializers"></a>
<a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a>
<a href="#/Initializers"> <div class="section-name-container">
<h3 class="section-name">Initializers</h3> <a class="section-name-link" href="#/Initializers"></a>
</a> <h3 class="section-name"><p>Initializers</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -291,7 +337,7 @@
<code> <code>
<a name="/s:8SocketIO0A10AckEmitterC6socket6ackNumAcA0A8IOClientC_Sitcfc"></a> <a name="/s:8SocketIO0A10AckEmitterC6socket6ackNumAcA0A8IOClientC_Sitcfc"></a>
<a name="//apple_ref/swift/Method/init(socket:ackNum:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/init(socket:ackNum:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A10AckEmitterC6socket6ackNumAcA0A8IOClientC_Sitcfc">init(socket:ackNum:)</a> <a class="token" href="#/s:8SocketIO0A10AckEmitterC6socket6ackNumAcA0A8IOClientC_Sitcfc">init(socket:<wbr>ackNum:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -350,9 +396,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -360,7 +408,7 @@
<code> <code>
<a name="/s:8SocketIO0A10AckEmitterC4withyyAA0A4Data_pd_tF"></a> <a name="/s:8SocketIO0A10AckEmitterC4withyyAA0A4Data_pd_tF"></a>
<a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A10AckEmitterC4withyyAA0A4Data_pd_tF">with(_:)</a> <a class="token" href="#/s:8SocketIO0A10AckEmitterC4withyyAA0A4Data_pd_tF">with(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -409,7 +457,7 @@ will be emitted. The structure of the error data is <code>[ackNum, items, theErr
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketAckEmitter(im)with:"></a> <a name="/c:@M@SocketIO@objc(cs)SocketAckEmitter(im)with:"></a>
<a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketAckEmitter(im)with:">with(_:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketAckEmitter(im)with:">with(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -459,8 +507,8 @@ will be emitted. The structure of the error data is <code>[ackNum, items, theErr
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

66
docs/Classes/SocketAnyEvent.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketAnyEvent</h1> <h1>SocketAnyEvent</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketAnyEvent</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketAnyEvent</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -284,7 +328,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">override</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">override</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -299,8 +343,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

374
docs/Classes/SocketEngine.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,11 +225,13 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketEngine</h1> <h1>SocketEngine</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">SocketEngine</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">URLSessionDelegate</span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketEnginePollable.html">SocketEnginePollable</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketEngineWebsocket.html">SocketEngineWebsocket</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/ConfigSettable.html">ConfigSettable</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">SocketEngine</span><span class="p">:</span>
<span class="kt">NSObject</span><span class="p">,</span> <span class="kt">WebSocketDelegate</span><span class="p">,</span> <span class="kt">URLSessionDelegate</span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketEnginePollable.html">SocketEnginePollable</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketEngineWebsocket.html">SocketEngineWebsocket</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/ConfigSettable.html">ConfigSettable</a></span></code></pre>
</div> </div>
</div> </div>
@ -204,17 +247,19 @@ See <code><a href="../Protocols/SocketEnginePollable.html">SocketEnginePollable<
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)engineQueue"></a> <a name="/s:8SocketIO0A6EngineC11engineQueueSo17OS_dispatch_queueCvp"></a>
<a name="//apple_ref/swift/Property/engineQueue" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/engineQueue" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)engineQueue">engineQueue</a> <a class="token" href="#/s:8SocketIO0A6EngineC11engineQueueSo17OS_dispatch_queueCvp">engineQueue</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -239,9 +284,9 @@ See <code><a href="../Protocols/SocketEnginePollable.html">SocketEnginePollable<
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)connectParams"></a> <a name="/s:8SocketIO0A6EngineC13connectParamsSDySSypGSgvp"></a>
<a name="//apple_ref/swift/Property/connectParams" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/connectParams" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)connectParams">connectParams</a> <a class="token" href="#/s:8SocketIO0A6EngineC13connectParamsSDySSypGSgvp">connectParams</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -266,9 +311,9 @@ See <code><a href="../Protocols/SocketEnginePollable.html">SocketEnginePollable<
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)extraHeaders"></a> <a name="/s:8SocketIO0A6EngineC12extraHeadersSDyS2SGSgvp"></a>
<a name="//apple_ref/swift/Property/extraHeaders" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/extraHeaders" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)extraHeaders">extraHeaders</a> <a class="token" href="#/s:8SocketIO0A6EngineC12extraHeadersSDyS2SGSgvp">extraHeaders</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -382,9 +427,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)closed"></a> <a name="/s:8SocketIO0A6EngineC6closedSbvp"></a>
<a name="//apple_ref/swift/Property/closed" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/closed" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)closed">closed</a> <a class="token" href="#/s:8SocketIO0A6EngineC6closedSbvp">closed</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -399,9 +444,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">closed</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">closed</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -411,9 +454,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)compress"></a> <a name="/s:8SocketIO0A6EngineC8compressSbvp"></a>
<a name="//apple_ref/swift/Property/compress" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/compress" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)compress">compress</a> <a class="token" href="#/s:8SocketIO0A6EngineC8compressSbvp">compress</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -428,9 +471,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">compress</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">compress</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -440,9 +481,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)connected"></a> <a name="/s:8SocketIO0A6EngineC9connectedSbvp"></a>
<a name="//apple_ref/swift/Property/connected" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/connected" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)connected">connected</a> <a class="token" href="#/s:8SocketIO0A6EngineC9connectedSbvp">connected</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -457,9 +498,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">connected</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">connected</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -469,9 +508,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)cookies"></a> <a name="/s:8SocketIO0A6EngineC7cookiesSaySo12NSHTTPCookieCGSgvp"></a>
<a name="//apple_ref/swift/Property/cookies" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/cookies" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)cookies">cookies</a> <a class="token" href="#/s:8SocketIO0A6EngineC7cookiesSaySo12NSHTTPCookieCGSgvp">cookies</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -486,9 +525,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">cookies</span><span class="p">:</span> <span class="p">[</span><span class="kt">HTTPCookie</span><span class="p">]?</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">cookies</span><span class="p">:</span> <span class="p">[</span><span class="kt">HTTPCookie</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -498,9 +535,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)fastUpgrade"></a> <a name="/s:8SocketIO0A6EngineC11fastUpgradeSbvp"></a>
<a name="//apple_ref/swift/Property/fastUpgrade" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/fastUpgrade" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)fastUpgrade">fastUpgrade</a> <a class="token" href="#/s:8SocketIO0A6EngineC11fastUpgradeSbvp">fastUpgrade</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -517,9 +554,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">fastUpgrade</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">fastUpgrade</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -529,9 +564,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)forcePolling"></a> <a name="/s:8SocketIO0A6EngineC12forcePollingSbvp"></a>
<a name="//apple_ref/swift/Property/forcePolling" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/forcePolling" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)forcePolling">forcePolling</a> <a class="token" href="#/s:8SocketIO0A6EngineC12forcePollingSbvp">forcePolling</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -546,9 +581,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">forcePolling</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">forcePolling</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -558,9 +591,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)forceWebsockets"></a> <a name="/s:8SocketIO0A6EngineC15forceWebsocketsSbvp"></a>
<a name="//apple_ref/swift/Property/forceWebsockets" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/forceWebsockets" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)forceWebsockets">forceWebsockets</a> <a class="token" href="#/s:8SocketIO0A6EngineC15forceWebsocketsSbvp">forceWebsockets</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -575,9 +608,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">forceWebsockets</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">forceWebsockets</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -604,9 +635,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">invalidated</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">invalidated</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -616,9 +645,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)polling"></a> <a name="/s:8SocketIO0A6EngineC7pollingSbvp"></a>
<a name="//apple_ref/swift/Property/polling" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/polling" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)polling">polling</a> <a class="token" href="#/s:8SocketIO0A6EngineC7pollingSbvp">polling</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -633,9 +662,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">polling</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">polling</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -645,9 +672,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)probing"></a> <a name="/s:8SocketIO0A6EngineC7probingSbvp"></a>
<a name="//apple_ref/swift/Property/probing" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/probing" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)probing">probing</a> <a class="token" href="#/s:8SocketIO0A6EngineC7probingSbvp">probing</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -662,9 +689,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">probing</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">probing</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -691,9 +716,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">session</span><span class="p">:</span> <span class="nf">URLSession</span><span class="p">?</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -703,9 +726,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)sid"></a> <a name="/s:8SocketIO0A6EngineC3sidSSvp"></a>
<a name="//apple_ref/swift/Property/sid" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/sid" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)sid">sid</a> <a class="token" href="#/s:8SocketIO0A6EngineC3sidSSvp">sid</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -720,9 +743,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">sid</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">sid</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -732,9 +753,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)socketPath"></a> <a name="/s:8SocketIO0A6EngineC10socketPathSSvp"></a>
<a name="//apple_ref/swift/Property/socketPath" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/socketPath" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)socketPath">socketPath</a> <a class="token" href="#/s:8SocketIO0A6EngineC10socketPathSSvp">socketPath</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -749,9 +770,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">socketPath</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">socketPath</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -761,9 +780,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)urlPolling"></a> <a name="/s:8SocketIO0A6EngineC10urlPolling10Foundation3URLVvp"></a>
<a name="//apple_ref/swift/Property/urlPolling" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/urlPolling" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)urlPolling">urlPolling</a> <a class="token" href="#/s:8SocketIO0A6EngineC10urlPolling10Foundation3URLVvp">urlPolling</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -778,9 +797,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">urlPolling</span><span class="p">:</span> <span class="nf">URL</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">urlPolling</span><span class="p">:</span> <span class="kt">URL</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -790,9 +807,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)urlWebSocket"></a> <a name="/s:8SocketIO0A6EngineC06urlWebA010Foundation3URLVvp"></a>
<a name="//apple_ref/swift/Property/urlWebSocket" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/urlWebSocket" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)urlWebSocket">urlWebSocket</a> <a class="token" href="#/s:8SocketIO0A6EngineC06urlWebA010Foundation3URLVvp">urlWebSocket</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -807,9 +824,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">urlWebSocket</span><span class="p">:</span> <span class="nf">URL</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">urlWebSocket</span><span class="p">:</span> <span class="kt">URL</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -819,9 +834,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)websocket"></a> <a name="/s:8SocketIO0A6EngineC9websocketSbvp"></a>
<a name="//apple_ref/swift/Property/websocket" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/websocket" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)websocket">websocket</a> <a class="token" href="#/s:8SocketIO0A6EngineC9websocketSbvp">websocket</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -836,10 +851,8 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@available(*, deprecated, message: "No longer needed, if we're not polling, then we must be doing websockets")</span> <pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"No longer needed, if we're not polling, then we must be doing websockets"</span><span class="p">)</span>
<span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">websocket</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">websocket</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -866,9 +879,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">enableSOCKSProxy</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">enableSOCKSProxy</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -878,9 +889,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)ws"></a> <a name="/s:8SocketIO0A6EngineC2ws10Starscream03WebA0CSgvp"></a>
<a name="//apple_ref/swift/Property/ws" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/ws" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)ws">ws</a> <a class="token" href="#/s:8SocketIO0A6EngineC2ws10Starscream03WebA0CSgvp">ws</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -895,9 +906,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">ws</span><span class="p">:</span> <span class="nf">WebSocket</span><span class="p">?</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">ws</span><span class="p">:</span> <span class="kt">WebSocket</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -907,9 +916,36 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(py)client"></a> <a name="/s:8SocketIO0A6EngineC11wsConnectedSbvp"></a>
<a name="//apple_ref/swift/Property/wsConnected" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A6EngineC11wsConnectedSbvp">wsConnected</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether or not the WebSocket is currently connected.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">wsConnected</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8SocketIO0A6EngineC6clientAA0aC6Client_pSgvp"></a>
<a name="//apple_ref/swift/Property/client" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/client" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(py)client">client</a> <a class="token" href="#/s:8SocketIO0A6EngineC6clientAA0aC6Client_pSgvp">client</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -924,7 +960,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">weak</span> <span class="k">var</span> <span class="nv">client</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">?</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">weak</span> <span class="k">var</span> <span class="nv">client</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineClient.html">SocketEngineClient</a></span></code></pre>
</div> </div>
</div> </div>
@ -937,9 +973,11 @@ disconnect us.</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/Initializers"></a> <a name="/Initializers"></a>
<a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a>
<a href="#/Initializers"> <div class="section-name-container">
<h3 class="section-name">Initializers</h3> <a class="section-name-link" href="#/Initializers"></a>
</a> <h3 class="section-name"><p>Initializers</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -947,7 +985,7 @@ disconnect us.</p>
<code> <code>
<a name="/s:8SocketIO0A6EngineC6client3url6configAcA0aC6Client_p_10Foundation3URLVAA0A21IOClientConfigurationVtcfc"></a> <a name="/s:8SocketIO0A6EngineC6client3url6configAcA0aC6Client_p_10Foundation3URLVAA0A21IOClientConfigurationVtcfc"></a>
<a name="//apple_ref/swift/Method/init(client:url:config:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/init(client:url:config:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A6EngineC6client3url6configAcA0aC6Client_p_10Foundation3URLVAA0A21IOClientConfigurationVtcfc">init(client:url:config:)</a> <a class="token" href="#/s:8SocketIO0A6EngineC6client3url6configAcA0aC6Client_p_10Foundation3URLVAA0A21IOClientConfigurationVtcfc">init(client:<wbr>url:<wbr>config:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1015,9 +1053,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(im)initWithClient:url:options:"></a> <a name="/s:8SocketIO0A6EngineC6client3url7optionsAcA0aC6Client_p_10Foundation3URLVSDySSypGSgtcfc"></a>
<a name="//apple_ref/swift/Method/init(client:url:options:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/init(client:url:options:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(im)initWithClient:url:options:">init(client:url:options:)</a> <a class="token" href="#/s:8SocketIO0A6EngineC6client3url7optionsAcA0aC6Client_p_10Foundation3URLVSDySSypGSgtcfc">init(client:<wbr>url:<wbr>options:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1032,7 +1070,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">required</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">,</span> <span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?)</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">required</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">client</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">,</span> <span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="nv">options</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?)</span></code></pre>
</div> </div>
</div> </div>
@ -1088,17 +1126,19 @@ disconnect us.</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(im)connect"></a> <a name="/s:8SocketIO0A6EngineC7connectyyF"></a>
<a name="//apple_ref/swift/Method/connect()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/connect()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(im)connect">connect()</a> <a class="token" href="#/s:8SocketIO0A6EngineC7connectyyF">connect()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1123,9 +1163,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(im)didErrorWithReason:"></a> <a name="/s:8SocketIO0A6EngineC8didError6reasonySS_tF"></a>
<a name="//apple_ref/swift/Method/didError(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/didError(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(im)didErrorWithReason:">didError(reason:)</a> <a class="token" href="#/s:8SocketIO0A6EngineC8didError6reasonySS_tF">didError(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1150,9 +1190,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(im)disconnectWithReason:"></a> <a name="/s:8SocketIO0A6EngineC10disconnect6reasonySS_tF"></a>
<a name="//apple_ref/swift/Method/disconnect(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/disconnect(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(im)disconnectWithReason:">disconnect(reason:)</a> <a class="token" href="#/s:8SocketIO0A6EngineC10disconnect6reasonySS_tF">disconnect(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1196,9 +1236,9 @@ disconnect us.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(im)doFastUpgrade"></a> <a name="/s:8SocketIO0A6EngineC13doFastUpgradeyyF"></a>
<a name="//apple_ref/swift/Method/doFastUpgrade()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/doFastUpgrade()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(im)doFastUpgrade">doFastUpgrade()</a> <a class="token" href="#/s:8SocketIO0A6EngineC13doFastUpgradeyyF">doFastUpgrade()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1226,9 +1266,9 @@ WebSocket mode.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(im)flushWaitingForPostToWebSocket"></a> <a name="/s:8SocketIO0A6EngineC024flushWaitingForPostToWebA0yyF"></a>
<a name="//apple_ref/swift/Method/flushWaitingForPostToWebSocket()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/flushWaitingForPostToWebSocket()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(im)flushWaitingForPostToWebSocket">flushWaitingForPostToWebSocket()</a> <a class="token" href="#/s:8SocketIO0A6EngineC024flushWaitingForPostToWebA0yyF">flushWaitingForPostToWebSocket()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1256,9 +1296,9 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineData:"></a> <a name="/s:8SocketIO0A6EngineC05parseC4Datayy10Foundation0E0VF"></a>
<a name="//apple_ref/swift/Method/parseEngineData(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/parseEngineData(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineData:">parseEngineData(_:)</a> <a class="token" href="#/s:8SocketIO0A6EngineC05parseC4Datayy10Foundation0E0VF">parseEngineData(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1302,9 +1342,9 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineMessage:"></a> <a name="/s:8SocketIO0A6EngineC05parseC7MessageyySSF"></a>
<a name="//apple_ref/swift/Method/parseEngineMessage(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/parseEngineMessage(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(im)parseEngineMessage:">parseEngineMessage(_:)</a> <a class="token" href="#/s:8SocketIO0A6EngineC05parseC7MessageyySSF">parseEngineMessage(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1350,7 +1390,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
<code> <code>
<a name="/s:8SocketIO0A6EngineC10setConfigsyyAA0A21IOClientConfigurationVF"></a> <a name="/s:8SocketIO0A6EngineC10setConfigsyyAA0A21IOClientConfigurationVF"></a>
<a name="//apple_ref/swift/Method/setConfigs(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/setConfigs(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A6EngineC10setConfigsyyAA0A21IOClientConfigurationVF">setConfigs(_:)</a> <a class="token" href="#/s:8SocketIO0A6EngineC10setConfigsyyAA0A21IOClientConfigurationVF">setConfigs(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1377,9 +1417,9 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(im)write:withType:withData:completion:"></a> <a name="/s:8SocketIO0A6EngineC5write_8withType0E4Data10completionySS_AA0ac6PacketF0OSay10Foundation0G0VGyycSgtF"></a>
<a name="//apple_ref/swift/Method/write(_:withType:withData:completion:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/write(_:withType:withData:completion:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(im)write:withType:withData:completion:">write(_:withType:withData:completion:)</a> <a class="token" href="#/s:8SocketIO0A6EngineC5write_8withType0E4Data10completionySS_AA0ac6PacketF0OSay10Foundation0G0VGyycSgtF">write(_:<wbr>withType:<wbr>withData:<wbr>completion:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1462,9 +1502,11 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/URLSessionDelegate%20methods"></a> <a name="/URLSessionDelegate%20methods"></a>
<a name="//apple_ref/swift/Section/URLSessionDelegate methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/URLSessionDelegate methods" class="dashAnchor"></a>
<a href="#/URLSessionDelegate%20methods"> <div class="section-name-container">
<h3 class="section-name">URLSessionDelegate methods</h3> <a class="section-name-link" href="#/URLSessionDelegate%20methods"></a>
</a> <h3 class="section-name"><p>URLSessionDelegate methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -1472,7 +1514,7 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
<code> <code>
<a name="/s:8SocketIO0A6EngineC10URLSession7session25didBecomeInvalidWithErrorySo12NSURLSessionC_So7NSErrorCSgtF"></a> <a name="/s:8SocketIO0A6EngineC10URLSession7session25didBecomeInvalidWithErrorySo12NSURLSessionC_So7NSErrorCSgtF"></a>
<a name="//apple_ref/swift/Method/URLSession(session:didBecomeInvalidWithError:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/URLSession(session:didBecomeInvalidWithError:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A6EngineC10URLSession7session25didBecomeInvalidWithErrorySo12NSURLSessionC_So7NSErrorCSgtF">URLSession(session:didBecomeInvalidWithError:)</a> <a class="token" href="#/s:8SocketIO0A6EngineC10URLSession7session25didBecomeInvalidWithErrorySo12NSURLSessionC_So7NSErrorCSgtF">URLSession(session:<wbr>didBecomeInvalidWithError:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1487,13 +1529,71 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">URLSession</span><span class="p">(</span><span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span><span class="p">,</span> <span class="n">didBecomeInvalidWithError</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="kt">URLSession</span><span class="p">(</span><span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span><span class="p">,</span> <span class="n">didBecomeInvalidWithError</span> <span class="nv">error</span><span class="p">:</span> <span class="kt">NSError</span><span class="p">?)</span></code></pre>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
</li> </li>
<li class="item">
<div>
<code>
<a name="/s:8SocketIO0A6EngineC10didReceive5event6clienty10Starscream03WebA5EventO_AG0iA0CtF"></a>
<a name="//apple_ref/swift/Method/didReceive(event:client:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A6EngineC10didReceive5event6clienty10Starscream03WebA5EventO_AG0iA0CtF">didReceive(event:<wbr>client:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Delegate method for WebSocketDelegate.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">didReceive</span><span class="p">(</span><span class="nv">event</span><span class="p">:</span> <span class="kt">WebSocketEvent</span><span class="p">,</span> <span class="n"><a href="../Classes/SocketEngine.html#/s:8SocketIO0A6EngineC6clientAA0aC6Client_pSgvp">client</a></span> <span class="nv">_</span><span class="p">:</span> <span class="kt">WebSocket</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>event</em>
</code>
</td>
<td>
<div>
<p>WS Event</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>_</em>
</code>
</td>
<td>
<div>
<p></p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul> </ul>
</div> </div>
</div> </div>
@ -1502,8 +1602,8 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

575
docs/Classes/SocketIOClient.html
View File

File diff suppressed because it is too large Load Diff

294
docs/Classes/SocketManager.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketManager</h1> <h1>SocketManager</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">SocketManager</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketManagerSpec.html">SocketManagerSpec</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketParsable.html">SocketParsable</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketDataBufferable.html">SocketDataBufferable</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/ConfigSettable.html">ConfigSettable</a></span></code></pre> <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">SocketManager</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketManagerSpec.html">SocketManagerSpec</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketParsable.html">SocketParsable</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketDataBufferable.html">SocketDataBufferable</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/ConfigSettable.html">ConfigSettable</a></span></code></pre>
</div> </div>
@ -197,7 +239,7 @@
<p>A <code>SocketManager</code> is responsible for multiplexing multiple namespaces through a single <code><a href="../Protocols/SocketEngineSpec.html">SocketEngineSpec</a></code>.</p> <p>A <code>SocketManager</code> is responsible for multiplexing multiple namespaces through a single <code><a href="../Protocols/SocketEngineSpec.html">SocketEngineSpec</a></code>.</p>
<p>Example:</p> <p>Example:</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="nf">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="nf">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span><span class="s">"http://localhost:8080/"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span> <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="kt">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span><span class="s">"http://localhost:8080/"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span>
<span class="k">let</span> <span class="nv">defaultNamespaceSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span> <span class="k">let</span> <span class="nv">defaultNamespaceSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span>
<span class="k">let</span> <span class="nv">swiftSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span> <span class="k">let</span> <span class="nv">swiftSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span>
@ -207,7 +249,7 @@
<p>Sockets created through the manager are retained by the manager. So at the very least, a single strong reference <p>Sockets created through the manager are retained by the manager. So at the very least, a single strong reference
to the manager must be maintained to keep sockets alive.</p> to the manager must be maintained to keep sockets alive.</p>
<p>To disconnect a socket and remove it from the manager, either call <code><a href="../Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)disconnect">SocketIOClient.disconnect()</a></code> on the socket, <p>To disconnect a socket and remove it from the manager, either call <code><a href="../Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10disconnectyyF">SocketIOClient.disconnect()</a></code> on the socket,
or call one of the <code>disconnectSocket</code> methods on this class.</p> or call one of the <code>disconnectSocket</code> methods on this class.</p>
<p><strong>NOTE</strong>: The manager is not thread/queue safe, all interaction with the manager should be done on the <code>handleQueue</code></p> <p><strong>NOTE</strong>: The manager is not thread/queue safe, all interaction with the manager should be done on the <code>handleQueue</code></p>
@ -221,17 +263,19 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)defaultSocket"></a> <a name="/s:8SocketIO0A7ManagerC07defaultA0AA0A8IOClientCvp"></a>
<a name="//apple_ref/swift/Property/defaultSocket" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/defaultSocket" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)defaultSocket">defaultSocket</a> <a class="token" href="#/s:8SocketIO0A7ManagerC07defaultA0AA0A8IOClientCvp">defaultSocket</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -239,14 +283,14 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<section class="section"> <section class="section">
<div class="pointer"></div> <div class="pointer"></div>
<div class="abstract"> <div class="abstract">
<p>The socket associated with the default namespace (<q>/</q>).</p> <p>The socket associated with the default namespace (&ldquo;/&rdquo;).</p>
</div> </div>
<div class="declaration"> <div class="declaration">
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">defaultSocket</span><span class="p">:</span> <span class="nf">SocketIOClient</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">defaultSocket</span><span class="p">:</span> <span class="kt"><a href="../Classes/SocketIOClient.html">SocketIOClient</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -256,9 +300,9 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)socketURL"></a> <a name="/s:8SocketIO0A7ManagerC9socketURL10Foundation0E0Vvp"></a>
<a name="//apple_ref/swift/Property/socketURL" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/socketURL" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)socketURL">socketURL</a> <a class="token" href="#/s:8SocketIO0A7ManagerC9socketURL10Foundation0E0Vvp">socketURL</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -268,7 +312,7 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<div class="abstract"> <div class="abstract">
<p>The URL of the socket.io server.</p> <p>The URL of the socket.io server.</p>
<p>If changed after calling <code>init</code>, <code><a href="../Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)forceNew">forceNew</a></code> must be set to <code>true</code>, or it will only connect to the url set in the <p>If changed after calling <code>init</code>, <code><a href="../Classes/SocketManager.html#/s:8SocketIO0A7ManagerC8forceNewSbvp">forceNew</a></code> must be set to <code>true</code>, or it will only connect to the url set in the
init.</p> init.</p>
</div> </div>
@ -305,7 +349,7 @@ init.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">config</span><span class="p">:</span> <span class="nf">SocketIOClientConfiguration</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">config</span><span class="p">:</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html">SocketIOClientConfiguration</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -315,9 +359,9 @@ init.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)engine"></a> <a name="/s:8SocketIO0A7ManagerC6engineAA0A10EngineSpec_pSgvp"></a>
<a name="//apple_ref/swift/Property/engine" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/engine" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)engine">engine</a> <a class="token" href="#/s:8SocketIO0A7ManagerC6engineAA0A10EngineSpec_pSgvp">engine</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -342,9 +386,9 @@ init.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)forceNew"></a> <a name="/s:8SocketIO0A7ManagerC8forceNewSbvp"></a>
<a name="//apple_ref/swift/Property/forceNew" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/forceNew" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)forceNew">forceNew</a> <a class="token" href="#/s:8SocketIO0A7ManagerC8forceNewSbvp">forceNew</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -369,9 +413,9 @@ init.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)handleQueue"></a> <a name="/s:8SocketIO0A7ManagerC11handleQueueSo17OS_dispatch_queueCvp"></a>
<a name="//apple_ref/swift/Property/handleQueue" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/handleQueue" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)handleQueue">handleQueue</a> <a class="token" href="#/s:8SocketIO0A7ManagerC11handleQueueSo17OS_dispatch_queueCvp">handleQueue</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -399,9 +443,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)nsps"></a> <a name="/s:8SocketIO0A7ManagerC4nspsSDySSAA0A8IOClientCGvp"></a>
<a name="//apple_ref/swift/Property/nsps" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/nsps" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)nsps">nsps</a> <a class="token" href="#/s:8SocketIO0A7ManagerC4nspsSDySSAA0A8IOClientCGvp">nsps</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -426,9 +470,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)reconnects"></a> <a name="/s:8SocketIO0A7ManagerC10reconnectsSbvp"></a>
<a name="//apple_ref/swift/Property/reconnects" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/reconnects" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)reconnects">reconnects</a> <a class="token" href="#/s:8SocketIO0A7ManagerC10reconnectsSbvp">reconnects</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -453,9 +497,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)reconnectWait"></a> <a name="/s:8SocketIO0A7ManagerC13reconnectWaitSivp"></a>
<a name="//apple_ref/swift/Property/reconnectWait" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/reconnectWait" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)reconnectWait">reconnectWait</a> <a class="token" href="#/s:8SocketIO0A7ManagerC13reconnectWaitSivp">reconnectWait</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -480,9 +524,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)reconnectWaitMax"></a> <a name="/s:8SocketIO0A7ManagerC16reconnectWaitMaxSivp"></a>
<a name="//apple_ref/swift/Property/reconnectWaitMax" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/reconnectWaitMax" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)reconnectWaitMax">reconnectWaitMax</a> <a class="token" href="#/s:8SocketIO0A7ManagerC16reconnectWaitMaxSivp">reconnectWaitMax</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -507,9 +551,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)randomizationFactor"></a> <a name="/s:8SocketIO0A7ManagerC19randomizationFactorSdvp"></a>
<a name="//apple_ref/swift/Property/randomizationFactor" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/randomizationFactor" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)randomizationFactor">randomizationFactor</a> <a class="token" href="#/s:8SocketIO0A7ManagerC19randomizationFactorSdvp">randomizationFactor</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -534,9 +578,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(py)status"></a> <a name="/s:8SocketIO0A7ManagerC6statusAA0A8IOStatusOvp"></a>
<a name="//apple_ref/swift/Property/status" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/status" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(py)status">status</a> <a class="token" href="#/s:8SocketIO0A7ManagerC6statusAA0A8IOStatusOvp">status</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -551,7 +595,7 @@ called on.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">status</span><span class="p">:</span> <span class="nf">SocketIOStatus</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">status</span><span class="p">:</span> <span class="kt"><a href="../Enums/SocketIOStatus.html">SocketIOStatus</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -596,9 +640,11 @@ So this should ideally be an array of one packet waiting for data.</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/Initializers"></a> <a name="/Initializers"></a>
<a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a>
<a href="#/Initializers"> <div class="section-name-container">
<h3 class="section-name">Initializers</h3> <a class="section-name-link" href="#/Initializers"></a>
</a> <h3 class="section-name"><p>Initializers</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -606,7 +652,7 @@ So this should ideally be an array of one packet waiting for data.</p>
<code> <code>
<a name="/s:8SocketIO0A7ManagerC9socketURL6configAC10Foundation0E0V_AA0A21IOClientConfigurationVtcfc"></a> <a name="/s:8SocketIO0A7ManagerC9socketURL6configAC10Foundation0E0V_AA0A21IOClientConfigurationVtcfc"></a>
<a name="//apple_ref/swift/Method/init(socketURL:config:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/init(socketURL:config:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A7ManagerC9socketURL6configAC10Foundation0E0V_AA0A21IOClientConfigurationVtcfc">init(socketURL:config:)</a> <a class="token" href="#/s:8SocketIO0A7ManagerC9socketURL6configAC10Foundation0E0V_AA0A21IOClientConfigurationVtcfc">init(socketURL:<wbr>config:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -664,7 +710,7 @@ So this should ideally be an array of one packet waiting for data.</p>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)initWithSocketURL:config:"></a> <a name="/c:@M@SocketIO@objc(cs)SocketManager(im)initWithSocketURL:config:"></a>
<a name="//apple_ref/swift/Method/init(socketURL:config:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/init(socketURL:config:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)initWithSocketURL:config:">init(socketURL:config:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)initWithSocketURL:config:">init(socketURL:<wbr>config:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -681,7 +727,7 @@ If using Swift it&rsquo;s recommended to use <code>init(socketURL: NSURL, option
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span> <pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="nv">config</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?)</span></code></pre> <span class="kd">public</span> <span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span> <span class="nv">config</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?)</span></code></pre>
</div> </div>
</div> </div>
@ -725,17 +771,19 @@ If using Swift it&rsquo;s recommended to use <code>init(socketURL: NSURL, option
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)connect"></a> <a name="/s:8SocketIO0A7ManagerC7connectyyF"></a>
<a name="//apple_ref/swift/Method/connect()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/connect()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)connect">connect()</a> <a class="token" href="#/s:8SocketIO0A7ManagerC7connectyyF">connect()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -762,9 +810,9 @@ If using Swift it&rsquo;s recommended to use <code>init(socketURL: NSURL, option
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)connectSocket:"></a> <a name="/s:8SocketIO0A7ManagerC07connectA0_11withPayloadyAA0A8IOClientC_SDySSypGSgtF"></a>
<a name="//apple_ref/swift/Method/connectSocket(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/connectSocket(_:withPayload:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)connectSocket:">connectSocket(_:)</a> <a class="token" href="#/s:8SocketIO0A7ManagerC07connectA0_11withPayloadyAA0A8IOClientC_SDySSypGSgtF">connectSocket(_:<wbr>withPayload:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -779,7 +827,7 @@ If using Swift it&rsquo;s recommended to use <code>init(socketURL: NSURL, option
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">connectSocket</span><span class="p">(</span><span class="n">_</span> <span class="nv">socket</span><span class="p">:</span> <span class="kt"><a href="../Classes/SocketIOClient.html">SocketIOClient</a></span><span class="p">)</span></code></pre> <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">connectSocket</span><span class="p">(</span><span class="n">_</span> <span class="nv">socket</span><span class="p">:</span> <span class="kt"><a href="../Classes/SocketIOClient.html">SocketIOClient</a></span><span class="p">,</span> <span class="n">withPayload</span> <span class="nv">payload</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
</div> </div>
</div> </div>
@ -799,6 +847,18 @@ If using Swift it&rsquo;s recommended to use <code>init(socketURL: NSURL, option
</div> </div>
</td> </td>
</tr> </tr>
<tr>
<td>
<code>
<em>withPayload</em>
</code>
</td>
<td>
<div>
<p>Optional payload to send on connect</p>
</div>
</td>
</tr>
</tbody> </tbody>
</table> </table>
</div> </div>
@ -808,9 +868,9 @@ If using Swift it&rsquo;s recommended to use <code>init(socketURL: NSURL, option
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)didDisconnectWithReason:"></a> <a name="/s:8SocketIO0A7ManagerC13didDisconnect6reasonySS_tF"></a>
<a name="//apple_ref/swift/Method/didDisconnect(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/didDisconnect(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)didDisconnectWithReason:">didDisconnect(reason:)</a> <a class="token" href="#/s:8SocketIO0A7ManagerC13didDisconnect6reasonySS_tF">didDisconnect(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -854,9 +914,9 @@ If using Swift it&rsquo;s recommended to use <code>init(socketURL: NSURL, option
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)disconnect"></a> <a name="/s:8SocketIO0A7ManagerC10disconnectyyF"></a>
<a name="//apple_ref/swift/Method/disconnect()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/disconnect()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnect">disconnect()</a> <a class="token" href="#/s:8SocketIO0A7ManagerC10disconnectyyF">disconnect()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -881,9 +941,9 @@ If using Swift it&rsquo;s recommended to use <code>init(socketURL: NSURL, option
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)disconnectSocket:"></a> <a name="/s:8SocketIO0A7ManagerC010disconnectA0yyAA0A8IOClientCF"></a>
<a name="//apple_ref/swift/Method/disconnectSocket(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/disconnectSocket(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnectSocket:">disconnectSocket(_:)</a> <a class="token" href="#/s:8SocketIO0A7ManagerC010disconnectA0yyAA0A8IOClientCF">disconnectSocket(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -930,9 +990,9 @@ releasing.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)disconnectSocketForNamespace:"></a> <a name="/s:8SocketIO0A7ManagerC010disconnectA012forNamespaceySS_tF"></a>
<a name="//apple_ref/swift/Method/disconnectSocket(forNamespace:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/disconnectSocket(forNamespace:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)disconnectSocketForNamespace:">disconnectSocket(forNamespace:)</a> <a class="token" href="#/s:8SocketIO0A7ManagerC010disconnectA012forNamespaceySS_tF">disconnectSocket(forNamespace:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -981,7 +1041,7 @@ releasing.</p>
<code> <code>
<a name="/s:8SocketIO0A7ManagerC7emitAll11clientEvent4datayAA0a6ClientG0O_SayypGtF"></a> <a name="/s:8SocketIO0A7ManagerC7emitAll11clientEvent4datayAA0a6ClientG0O_SayypGtF"></a>
<a name="//apple_ref/swift/Method/emitAll(clientEvent:data:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/emitAll(clientEvent:data:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A7ManagerC7emitAll11clientEvent4datayAA0a6ClientG0O_SayypGtF">emitAll(clientEvent:data:)</a> <a class="token" href="#/s:8SocketIO0A7ManagerC7emitAll11clientEvent4datayAA0a6ClientG0O_SayypGtF">emitAll(clientEvent:<wbr>data:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -989,7 +1049,7 @@ releasing.</p>
<section class="section"> <section class="section">
<div class="pointer"></div> <div class="pointer"></div>
<div class="abstract"> <div class="abstract">
<p>Sends a client event to all sockets in <code><a href="../Classes/SocketManager.html#/c:@M@SocketIO@objc(cs)SocketManager(py)nsps">nsps</a></code></p> <p>Sends a client event to all sockets in <code><a href="../Classes/SocketManager.html#/s:8SocketIO0A7ManagerC4nspsSDySSAA0A8IOClientCGvp">nsps</a></code></p>
</div> </div>
<div class="declaration"> <div class="declaration">
@ -1027,7 +1087,7 @@ releasing.</p>
<code> <code>
<a name="/s:8SocketIO0A7ManagerC7emitAllyySS_AA0A4Data_pdtF"></a> <a name="/s:8SocketIO0A7ManagerC7emitAllyySS_AA0A4Data_pdtF"></a>
<a name="//apple_ref/swift/Method/emitAll(_:_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/emitAll(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A7ManagerC7emitAllyySS_AA0A4Data_pdtF">emitAll(_:_:)</a> <a class="token" href="#/s:8SocketIO0A7ManagerC7emitAllyySS_AA0A4Data_pdtF">emitAll(_:<wbr>_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1080,72 +1140,12 @@ releasing.</p>
</section> </section>
</div> </div>
</li> </li>
<li class="item">
<div>
<code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)emitAll:withItems:"></a>
<a name="//apple_ref/swift/Method/emitAll(_:withItems:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)emitAll:withItems:">emitAll(_:withItems:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Sends an event to the server on all namespaces in this manager.</p>
<p>Same as <code><a href="../Classes/SocketManager.html#/s:8SocketIO0A7ManagerC7emitAllyySS_AA0A4Data_pdtF">emitAll(_:_:)</a></code>, but meant for Objective-C.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">emitAll</span><span class="p">(</span><span class="n">_</span> <span class="nv">event</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">withItems</span> <span class="nv">items</span><span class="p">:</span> <span class="p">[</span><span class="kt">Any</span><span class="p">])</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>event</em>
</code>
</td>
<td>
<div>
<p>The event to send.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>items</em>
</code>
</td>
<td>
<div>
<p>The data to send with this event.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidCloseWithReason:"></a> <a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidCloseWithReason:"></a>
<a name="//apple_ref/swift/Method/engineDidClose(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidClose(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidCloseWithReason:">engineDidClose(reason:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidCloseWithReason:">engineDidClose(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1191,7 +1191,7 @@ releasing.</p>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidErrorWithReason:"></a> <a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidErrorWithReason:"></a>
<a name="//apple_ref/swift/Method/engineDidError(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidError(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidErrorWithReason:">engineDidError(reason:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidErrorWithReason:">engineDidError(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1237,7 +1237,7 @@ releasing.</p>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidOpenWithReason:"></a> <a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidOpenWithReason:"></a>
<a name="//apple_ref/swift/Method/engineDidOpen(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidOpen(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidOpenWithReason:">engineDidOpen(reason:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidOpenWithReason:">engineDidOpen(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1281,9 +1281,9 @@ releasing.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidReceivePong"></a> <a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidReceivePing"></a>
<a name="//apple_ref/swift/Method/engineDidReceivePong()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidReceivePing()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidReceivePong">engineDidReceivePong()</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidReceivePing">engineDidReceivePing()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1298,7 +1298,7 @@ releasing.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">engineDidReceivePong</span><span class="p">()</span></code></pre> <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">engineDidReceivePing</span><span class="p">()</span></code></pre>
</div> </div>
</div> </div>
@ -1308,9 +1308,9 @@ releasing.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidSendPing"></a> <a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidSendPong"></a>
<a name="//apple_ref/swift/Method/engineDidSendPing()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidSendPong()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidSendPing">engineDidSendPing()</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidSendPong">engineDidSendPong()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1325,7 +1325,7 @@ releasing.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">engineDidSendPing</span><span class="p">()</span></code></pre> <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">engineDidSendPong</span><span class="p">()</span></code></pre>
</div> </div>
</div> </div>
@ -1337,7 +1337,7 @@ releasing.</p>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidWebsocketUpgradeWithHeaders:"></a> <a name="/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidWebsocketUpgradeWithHeaders:"></a>
<a name="//apple_ref/swift/Method/engineDidWebsocketUpgrade(headers:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidWebsocketUpgrade(headers:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidWebsocketUpgradeWithHeaders:">engineDidWebsocketUpgrade(headers:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)engineDidWebsocketUpgradeWithHeaders:">engineDidWebsocketUpgrade(headers:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1383,7 +1383,7 @@ releasing.</p>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineMessage:"></a> <a name="/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineMessage:"></a>
<a name="//apple_ref/swift/Method/parseEngineMessage(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/parseEngineMessage(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineMessage:">parseEngineMessage(_:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineMessage:">parseEngineMessage(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1429,7 +1429,7 @@ releasing.</p>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineBinaryData:"></a> <a name="/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineBinaryData:"></a>
<a name="//apple_ref/swift/Method/parseEngineBinaryData(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/parseEngineBinaryData(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineBinaryData:">parseEngineBinaryData(_:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)parseEngineBinaryData:">parseEngineBinaryData(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1473,9 +1473,9 @@ releasing.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)reconnect"></a> <a name="/s:8SocketIO0A7ManagerC9reconnectyyF"></a>
<a name="//apple_ref/swift/Method/reconnect()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/reconnect()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)reconnect">reconnect()</a> <a class="token" href="#/s:8SocketIO0A7ManagerC9reconnectyyF">reconnect()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1503,9 +1503,9 @@ releasing.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)removeSocket:"></a> <a name="/s:8SocketIO0A7ManagerC06removeA0yAA0A8IOClientCSgAFF"></a>
<a name="//apple_ref/swift/Method/removeSocket(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/removeSocket(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)removeSocket:">removeSocket(_:)</a> <a class="token" href="#/s:8SocketIO0A7ManagerC06removeA0yAA0A8IOClientCSgAFF">removeSocket(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1559,7 +1559,7 @@ method.</p>
<code> <code>
<a name="/s:8SocketIO0A7ManagerC10setConfigsyyAA0A21IOClientConfigurationVF"></a> <a name="/s:8SocketIO0A7ManagerC10setConfigsyyAA0A21IOClientConfigurationVF"></a>
<a name="//apple_ref/swift/Method/setConfigs(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/setConfigs(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A7ManagerC10setConfigsyyAA0A21IOClientConfigurationVF">setConfigs(_:)</a> <a class="token" href="#/s:8SocketIO0A7ManagerC10setConfigsyyAA0A21IOClientConfigurationVF">setConfigs(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1586,9 +1586,9 @@ method.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)socketForNamespace:"></a> <a name="/s:8SocketIO0A7ManagerC6socket12forNamespaceAA0A8IOClientCSS_tF"></a>
<a name="//apple_ref/swift/Method/socket(forNamespace:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/socket(forNamespace:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)socketForNamespace:">socket(forNamespace:)</a> <a class="token" href="#/s:8SocketIO0A7ManagerC6socket12forNamespaceAA0A8IOClientCSS_tF">socket(forNamespace:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1602,7 +1602,7 @@ method.</p>
<p>Sockets created from this method are retained by the manager. <p>Sockets created from this method are retained by the manager.
Call one of the <code>disconnectSocket</code> methods on this class to remove the socket from manager control. Call one of the <code>disconnectSocket</code> methods on this class to remove the socket from manager control.
Or call <code><a href="../Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)disconnect">SocketIOClient.disconnect()</a></code> on the client.</p> Or call <code><a href="../Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10disconnectyyF">SocketIOClient.disconnect()</a></code> on the client.</p>
</div> </div>
<div class="declaration"> <div class="declaration">
@ -1647,8 +1647,8 @@ Or call <code><a href="../Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)Soc
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

60
docs/Classes/SocketRawAckView.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketRawAckView</h1> <h1>SocketRawAckView</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketRawAckView</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketRawAckView</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div> </div>
@ -210,7 +252,7 @@
<code> <code>
<a name="/s:8SocketIO0A10RawAckViewC4withyyAA0A4Data_pd_tF"></a> <a name="/s:8SocketIO0A10RawAckViewC4withyyAA0A4Data_pd_tF"></a>
<a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A10RawAckViewC4withyyAA0A4Data_pd_tF">with(_:)</a> <a class="token" href="#/s:8SocketIO0A10RawAckViewC4withyyAA0A4Data_pd_tF">with(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -259,7 +301,7 @@ will be emitted. The structure of the error data is <code>[ackNum, items, theErr
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketRawAckView(im)with:"></a> <a name="/c:@M@SocketIO@objc(cs)SocketRawAckView(im)with:"></a>
<a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketRawAckView(im)with:">with(_:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketRawAckView(im)with:">with(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -309,8 +351,8 @@ will be emitted. The structure of the error data is <code>[ackNum, items, theErr
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

64
docs/Classes/SocketRawView.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketRawView</h1> <h1>SocketRawView</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketRawView</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SocketRawView</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div> </div>
@ -210,7 +252,7 @@
<code> <code>
<a name="/s:8SocketIO0A7RawViewC4emityySS_AA0A4Data_pdtF"></a> <a name="/s:8SocketIO0A7RawViewC4emityySS_AA0A4Data_pdtF"></a>
<a name="//apple_ref/swift/Method/emit(_:_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/emit(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A7RawViewC4emityySS_AA0A4Data_pdtF">emit(_:_:)</a> <a class="token" href="#/s:8SocketIO0A7RawViewC4emityySS_AA0A4Data_pdtF">emit(_:<wbr>_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -271,7 +313,7 @@ will be emitted. The structure of the error data is <code>[eventName, items, the
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketRawView(im)emit:with:"></a> <a name="/c:@M@SocketIO@objc(cs)SocketRawView(im)emit:with:"></a>
<a name="//apple_ref/swift/Method/emit(_:with:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/emit(_:with:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketRawView(im)emit:with:">emit(_:with:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketRawView(im)emit:with:">emit(_:<wbr>with:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -330,7 +372,7 @@ will be emitted. The structure of the error data is <code>[eventName, items, the
<code> <code>
<a name="/s:8SocketIO0A7RawViewC11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF"></a> <a name="/s:8SocketIO0A7RawViewC11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF"></a>
<a name="//apple_ref/swift/Method/emitWithAck(_:_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/emitWithAck(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A7RawViewC11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF">emitWithAck(_:_:)</a> <a class="token" href="#/s:8SocketIO0A7RawViewC11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF">emitWithAck(_:<wbr>_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -404,7 +446,7 @@ will be emitted. The structure of the error data is <code>[eventName, items, the
<code> <code>
<a name="/c:@M@SocketIO@objc(cs)SocketRawView(im)emitWithAck:with:"></a> <a name="/c:@M@SocketIO@objc(cs)SocketRawView(im)emitWithAck:with:"></a>
<a name="//apple_ref/swift/Method/emitWithAck(_:with:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/emitWithAck(_:with:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketRawView(im)emitWithAck:with:">emitWithAck(_:with:)</a> <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketRawView(im)emitWithAck:with:">emitWithAck(_:<wbr>with:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -479,8 +521,8 @@ Check that your server&rsquo;s api will ack the event being sent.</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

75
docs/Enums.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="index.html"> <a class="header-link" href="index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="12to13.html">12to13</a> <a class="nav-group-task-link" href="12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="faq.html">FAQ</a> <a class="nav-group-task-link" href="faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a> <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,7 +225,7 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>Enumerations</h1> <h1>Enumerations</h1>
<p>The following enumerations are available globally.</p> <p>The following enumerations are available globally.</p>
@ -223,10 +264,6 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -255,10 +292,6 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -287,10 +320,6 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -320,10 +349,6 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -353,10 +378,6 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -393,8 +414,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

118
docs/Enums/SocketAckStatus.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketAckStatus</h1> <h1>SocketAckStatus</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketAckStatus</span> <span class="p">:</span> <span class="kt">String</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketAckStatus</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Cases"></a> <a name="/Cases"></a>
<a name="//apple_ref/swift/Section/Cases" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Cases" class="dashAnchor"></a>
<a href="#/Cases"> <div class="section-name-container">
<h3 class="section-name">Cases</h3> <a class="section-name-link" href="#/Cases"></a>
</a> <h3 class="section-name"><p>Cases</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -235,6 +279,60 @@
</section> </section>
</div> </div>
</li> </li>
<li class="item">
<div>
<code>
<a name="/s:8SocketIO0A9AckStatusO2eeoiySbSS_ACtFZ"></a>
<a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A9AckStatusO2eeoiySbSS_ACtFZ">==(_:<wbr>_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Tests whether a string is equal to a given SocketAckStatus</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="o">==</span> <span class="p">(</span><span class="nv">lhs</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">rhs</span><span class="p">:</span> <span class="kt">SocketAckStatus</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8SocketIO0A9AckStatusO2eeoiySbAC_SStFZ"></a>
<a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A9AckStatusO2eeoiySbAC_SStFZ">==(_:<wbr>_:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Tests whether a string is equal to a given SocketAckStatus</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="o">==</span> <span class="p">(</span><span class="nv">lhs</span><span class="p">:</span> <span class="kt">SocketAckStatus</span><span class="p">,</span> <span class="nv">rhs</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul> </ul>
</div> </div>
</div> </div>
@ -243,8 +341,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

66
docs/Enums/SocketClientEvent.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketClientEvent</h1> <h1>SocketClientEvent</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketClientEvent</span> <span class="p">:</span> <span class="kt">String</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketClientEvent</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Cases"></a> <a name="/Cases"></a>
<a name="//apple_ref/swift/Section/Cases" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Cases" class="dashAnchor"></a>
<a href="#/Cases"> <div class="section-name-container">
<h3 class="section-name">Cases</h3> <a class="section-name-link" href="#/Cases"></a>
</a> <h3 class="section-name"><p>Cases</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -224,7 +268,7 @@
<p>Emitted when the client connects. This is also called on a successful reconnection. A connect event gets one <p>Emitted when the client connects. This is also called on a successful reconnection. A connect event gets one
data item: the namespace that was connected to.</p> data item: the namespace that was connected to.</p>
<pre class="highlight swift"><code><span class="n">socket</span><span class="o">.</span><span class="nf">on</span><span class="p">(</span><span class="nv">clientEvent</span><span class="p">:</span> <span class="o">.</span><span class="n">connect</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span><span class="p">,</span> <span class="n">ack</span> <span class="k">in</span> <pre class="highlight swift"><code><span class="n">socket</span><span class="o">.</span><span class="nf">on</span><span class="p">(</span><span class="nv">clientEvent</span><span class="p">:</span> <span class="o">.</span><span class="n">connect</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span><span class="p">,</span> <span class="n">ack</span> <span class="k">in</span>
<span class="k">guard</span> <span class="k">let</span> <span class="nv">nsp</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">String</span> <span class="nf">else</span> <span class="p">{</span> <span class="k">return</span> <span class="p">}</span> <span class="k">guard</span> <span class="k">let</span> <span class="nv">nsp</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">String</span> <span class="k">else</span> <span class="p">{</span> <span class="k">return</span> <span class="p">}</span>
<span class="c1">// Some logic using the nsp</span> <span class="c1">// Some logic using the nsp</span>
<span class="p">}</span> <span class="p">}</span>
</code></pre> </code></pre>
@ -517,8 +561,8 @@ if you are working in Objective-C.</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

56
docs/Enums/SocketEnginePacketType.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketEnginePacketType</h1> <h1>SocketEnginePacketType</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">@objc</span> <pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketEnginePacketType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketEnginePacketType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
@ -399,8 +441,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

120
docs/Enums/SocketIOClientOption.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketIOClientOption</h1> <h1>SocketIOClientOption</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketIOClientOption</span> <span class="p">:</span> <span class="kt">ClientOption</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketIOClientOption</span> <span class="p">:</span> <span class="kt">ClientOption</span></code></pre>
</div> </div>
@ -233,7 +275,7 @@
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO13connectParamsyACSDySSypGcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO13connectParamsyACSDySSypGcACmF"></a>
<a name="//apple_ref/swift/Element/connectParams(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/connectParams(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO13connectParamsyACSDySSypGcACmF">connectParams(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO13connectParamsyACSDySSypGcACmF">connectParams(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -260,7 +302,7 @@
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO7cookiesyACSaySo12NSHTTPCookieCGcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO7cookiesyACSaySo12NSHTTPCookieCGcACmF"></a>
<a name="//apple_ref/swift/Element/cookies(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/cookies(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO7cookiesyACSaySo12NSHTTPCookieCGcACmF">cookies(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO7cookiesyACSaySo12NSHTTPCookieCGcACmF">cookies(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -287,7 +329,7 @@
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO12extraHeadersyACSDyS2SGcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO12extraHeadersyACSDyS2SGcACmF"></a>
<a name="//apple_ref/swift/Element/extraHeaders(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/extraHeaders(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO12extraHeadersyACSDyS2SGcACmF">extraHeaders(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO12extraHeadersyACSDyS2SGcACmF">extraHeaders(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -314,7 +356,7 @@
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO8forceNewyACSbcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO8forceNewyACSbcACmF"></a>
<a name="//apple_ref/swift/Element/forceNew(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/forceNew(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO8forceNewyACSbcACmF">forceNew(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO8forceNewyACSbcACmF">forceNew(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -342,7 +384,7 @@ or when you want to be sure no state from previous engines is being carried over
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO12forcePollingyACSbcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO12forcePollingyACSbcACmF"></a>
<a name="//apple_ref/swift/Element/forcePolling(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/forcePolling(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO12forcePollingyACSbcACmF">forcePolling(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO12forcePollingyACSbcACmF">forcePolling(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -369,7 +411,7 @@ or when you want to be sure no state from previous engines is being carried over
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO15forceWebsocketsyACSbcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO15forceWebsocketsyACSbcACmF"></a>
<a name="//apple_ref/swift/Element/forceWebsockets(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/forceWebsockets(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO15forceWebsocketsyACSbcACmF">forceWebsockets(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO15forceWebsocketsyACSbcACmF">forceWebsockets(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -396,7 +438,7 @@ or when you want to be sure no state from previous engines is being carried over
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO16enableSOCKSProxyyACSbcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO16enableSOCKSProxyyACSbcACmF"></a>
<a name="//apple_ref/swift/Element/enableSOCKSProxy(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/enableSOCKSProxy(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO16enableSOCKSProxyyACSbcACmF">enableSOCKSProxy(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO16enableSOCKSProxyyACSbcACmF">enableSOCKSProxy(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -423,7 +465,7 @@ or when you want to be sure no state from previous engines is being carried over
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO11handleQueueyACSo17OS_dispatch_queueCcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO11handleQueueyACSo17OS_dispatch_queueCcACmF"></a>
<a name="//apple_ref/swift/Element/handleQueue(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/handleQueue(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO11handleQueueyACSo17OS_dispatch_queueCcACmF">handleQueue(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO11handleQueueyACSo17OS_dispatch_queueCcACmF">handleQueue(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -453,7 +495,7 @@ called on.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO3logyACSbcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO3logyACSbcACmF"></a>
<a name="//apple_ref/swift/Element/log(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/log(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO3logyACSbcACmF">log(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO3logyACSbcACmF">log(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -480,7 +522,7 @@ called on.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO6loggeryAcA0A6Logger_pcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO6loggeryAcA0A6Logger_pcACmF"></a>
<a name="//apple_ref/swift/Element/logger(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/logger(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO6loggeryAcA0A6Logger_pcACmF">logger(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO6loggeryAcA0A6Logger_pcACmF">logger(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -507,7 +549,7 @@ called on.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO4pathyACSScACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO4pathyACSScACmF"></a>
<a name="//apple_ref/swift/Element/path(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/path(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO4pathyACSScACmF">path(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO4pathyACSScACmF">path(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -534,7 +576,7 @@ called on.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO10reconnectsyACSbcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO10reconnectsyACSbcACmF"></a>
<a name="//apple_ref/swift/Element/reconnects(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/reconnects(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO10reconnectsyACSbcACmF">reconnects(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO10reconnectsyACSbcACmF">reconnects(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -562,7 +604,7 @@ over when reconnects happen.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO17reconnectAttemptsyACSicACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO17reconnectAttemptsyACSicACmF"></a>
<a name="//apple_ref/swift/Element/reconnectAttempts(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/reconnectAttempts(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO17reconnectAttemptsyACSicACmF">reconnectAttempts(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO17reconnectAttemptsyACSicACmF">reconnectAttempts(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -589,7 +631,7 @@ over when reconnects happen.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO13reconnectWaityACSicACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO13reconnectWaityACSicACmF"></a>
<a name="//apple_ref/swift/Element/reconnectWait(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/reconnectWait(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO13reconnectWaityACSicACmF">reconnectWait(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO13reconnectWaityACSicACmF">reconnectWait(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -616,7 +658,7 @@ over when reconnects happen.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO16reconnectWaitMaxyACSicACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO16reconnectWaitMaxyACSicACmF"></a>
<a name="//apple_ref/swift/Element/reconnectWaitMax(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/reconnectWaitMax(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO16reconnectWaitMaxyACSicACmF">reconnectWaitMax(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO16reconnectWaitMaxyACSicACmF">reconnectWaitMax(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -643,7 +685,7 @@ over when reconnects happen.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO19randomizationFactoryACSdcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO19randomizationFactoryACSdcACmF"></a>
<a name="//apple_ref/swift/Element/randomizationFactor(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/randomizationFactor(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO19randomizationFactoryACSdcACmF">randomizationFactor(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO19randomizationFactoryACSdcACmF">randomizationFactor(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -670,7 +712,7 @@ over when reconnects happen.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO6secureyACSbcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO6secureyACSbcACmF"></a>
<a name="//apple_ref/swift/Element/secure(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/secure(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO6secureyACSbcACmF">secure(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO6secureyACSbcACmF">secure(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -695,9 +737,9 @@ over when reconnects happen.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO8securityyAcA11SSLSecurityCcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO8securityyAC10Starscream18CertificatePinning_pcACmF"></a>
<a name="//apple_ref/swift/Element/security(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/security(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO8securityyAcA11SSLSecurityCcACmF">security(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO8securityyAC10Starscream18CertificatePinning_pcACmF">security(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -712,7 +754,7 @@ over when reconnects happen.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">case</span> <span class="nf">security</span><span class="p">(</span><span class="kt"><a href="../Classes/SSLSecurity.html">SSLSecurity</a></span><span class="p">)</span></code></pre> <pre class="highlight swift"><code><span class="k">case</span> <span class="nf">security</span><span class="p">(</span><span class="kt">CertificatePinning</span><span class="p">)</span></code></pre>
</div> </div>
</div> </div>
@ -724,7 +766,7 @@ over when reconnects happen.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO10selfSignedyACSbcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO10selfSignedyACSbcACmF"></a>
<a name="//apple_ref/swift/Element/selfSigned(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/selfSigned(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO10selfSignedyACSbcACmF">selfSigned(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO10selfSignedyACSbcACmF">selfSigned(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -751,7 +793,7 @@ over when reconnects happen.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO15sessionDelegateyACSo012NSURLSessionF0_pcACmF"></a> <a name="/s:8SocketIO0A14IOClientOptionO15sessionDelegateyACSo012NSURLSessionF0_pcACmF"></a>
<a name="//apple_ref/swift/Element/sessionDelegate(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Element/sessionDelegate(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO15sessionDelegateyACSo012NSURLSessionF0_pcACmF">sessionDelegate(_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO15sessionDelegateyACSo012NSURLSessionF0_pcACmF">sessionDelegate(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -779,9 +821,11 @@ over when reconnects happen.</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -804,7 +848,7 @@ over when reconnects happen.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -817,9 +861,11 @@ over when reconnects happen.</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/Operators"></a> <a name="/Operators"></a>
<a name="//apple_ref/swift/Section/Operators" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Operators" class="dashAnchor"></a>
<a href="#/Operators"> <div class="section-name-container">
<h3 class="section-name">Operators</h3> <a class="section-name-link" href="#/Operators"></a>
</a> <h3 class="section-name"><p>Operators</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -827,7 +873,7 @@ over when reconnects happen.</p>
<code> <code>
<a name="/s:8SocketIO0A14IOClientOptionO2eeoiySbAC_ACtFZ"></a> <a name="/s:8SocketIO0A14IOClientOptionO2eeoiySbAC_ACtFZ"></a>
<a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/==(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14IOClientOptionO2eeoiySbAC_ACtFZ">==(_:_:)</a> <a class="token" href="#/s:8SocketIO0A14IOClientOptionO2eeoiySbAC_ACtFZ">==(_:<wbr>_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -892,8 +938,8 @@ over when reconnects happen.</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

76
docs/Enums/SocketIOStatus.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketIOStatus</h1> <h1>SocketIOStatus</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">@objc</span> <pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketIOStatus</span> <span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="kt">CustomStringConvertible</span></code></pre> <span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketIOStatus</span> <span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="kt">CustomStringConvertible</span></code></pre>
@ -204,9 +246,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Cases"></a> <a name="/Cases"></a>
<a name="//apple_ref/swift/Section/Cases" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Cases" class="dashAnchor"></a>
<a href="#/Cases"> <div class="section-name-container">
<h3 class="section-name">Cases</h3> <a class="section-name-link" href="#/Cases"></a>
</a> <h3 class="section-name"><p>Cases</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -323,9 +367,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -347,7 +393,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">active</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">active</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -377,7 +423,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -392,8 +438,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

64
docs/Enums/SocketParsableError.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketParsableError</h1> <h1>SocketParsableError</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketParsableError</span> <span class="p">:</span> <span class="kt">Error</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SocketParsableError</span> <span class="p">:</span> <span class="kt">Error</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Cases"></a> <a name="/Cases"></a>
<a name="//apple_ref/swift/Section/Cases" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Cases" class="dashAnchor"></a>
<a href="#/Cases"> <div class="section-name-container">
<h3 class="section-name">Cases</h3> <a class="section-name-link" href="#/Cases"></a>
</a> <h3 class="section-name"><p>Cases</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -297,8 +341,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

564
docs/Extensions.html Normal file
View File

@ -0,0 +1,564 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Extensions Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset="utf-8">
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Extensions" class="dashAnchor"></a>
<a title="Extensions Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
SocketIO 16.0.0-beta2 Docs
</a>
(100% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">SocketIO Reference</a>
<img class="carat" src="img/carat.png" />
Extensions Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Guides.html">Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="12to13.html">12to13</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="15to16.html">15to16</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="faq.html">FAQ</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAnyEvent.html">SocketAnyEvent</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketEngine.html">SocketEngine</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketIOClient.html">SocketIOClient</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketManager.html">SocketManager</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketRawAckView.html">SocketRawAckView</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketRawView.html">SocketRawView</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketAckStatus.html">SocketAckStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketClientEvent.html">SocketClientEvent</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketEnginePacketType.html">SocketEnginePacketType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketIOClientOption.html">SocketIOClientOption</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketIOStatus.html">SocketIOStatus</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SocketParsableError.html">SocketParsableError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ConfigSettable.html">ConfigSettable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketData.html">SocketData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketDataBufferable.html">SocketDataBufferable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketEngineClient.html">SocketEngineClient</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketEnginePollable.html">SocketEnginePollable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketEngineSpec.html">SocketEngineSpec</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketEngineWebsocket.html">SocketEngineWebsocket</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketIOClientSpec.html">SocketIOClientSpec</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketLogger.html">SocketLogger</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketManagerSpec.html">SocketManagerSpec</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SocketParsable.html">SocketParsable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SocketEventHandler.html">SocketEventHandler</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SocketIOClientConfiguration.html">SocketIOClientConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SocketPacket.html">SocketPacket</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SocketPacket/PacketType.html">– PacketType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:8SocketIO11AckCallbacka">AckCallback</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:8SocketIO14NormalCallbacka">NormalCallback</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Typealiases.html#/s:8SocketIO4Posta">Post</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>Extensions</h1>
<p>The following extensions are available globally.</p>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:Sa"></a>
<a name="//apple_ref/swift/Extension/Array" class="dashAnchor"></a>
<a class="token" href="#/s:Sa">Array</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Array</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:Sb"></a>
<a name="//apple_ref/swift/Extension/Bool" class="dashAnchor"></a>
<a class="token" href="#/s:Sb">Bool</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Bool</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:SD"></a>
<a name="//apple_ref/swift/Extension/Dictionary" class="dashAnchor"></a>
<a class="token" href="#/s:SD">Dictionary</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Dictionary</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:Sd"></a>
<a name="//apple_ref/swift/Extension/Double" class="dashAnchor"></a>
<a class="token" href="#/s:Sd">Double</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Double</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:Si"></a>
<a name="//apple_ref/swift/Extension/Int" class="dashAnchor"></a>
<a class="token" href="#/s:Si">Int</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Int</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSArray"></a>
<a name="//apple_ref/swift/Extension/NSArray" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSArray">NSArray</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">NSArray</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:10Foundation4DataV"></a>
<a name="//apple_ref/swift/Extension/Data" class="dashAnchor"></a>
<a class="token" href="#/s:10Foundation4DataV">Data</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Data</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSData"></a>
<a name="//apple_ref/swift/Extension/NSData" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSData">NSData</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">NSData</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSDictionary"></a>
<a name="//apple_ref/swift/Extension/NSDictionary" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSDictionary">NSDictionary</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">NSDictionary</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSString"></a>
<a name="//apple_ref/swift/Extension/NSString" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSString">NSString</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">NSString</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSNull"></a>
<a name="//apple_ref/swift/Extension/NSNull" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSNull">NSNull</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">NSNull</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:SS"></a>
<a name="//apple_ref/swift/Extension/String" class="dashAnchor"></a>
<a class="token" href="#/s:SS">String</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">String</span> <span class="p">:</span> <span class="kt"><a href="Protocols/SocketData.html">SocketData</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>

86
docs/Guides.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="index.html"> <a class="header-link" href="index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="12to13.html">12to13</a> <a class="nav-group-task-link" href="12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="faq.html">FAQ</a> <a class="nav-group-task-link" href="faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a> <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,7 +225,7 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>Guides</h1> <h1>Guides</h1>
<p>The following guides are available globally.</p> <p>The following guides are available globally.</p>
@ -193,14 +234,45 @@
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/documentation.15to16"></a>
<a name="//apple_ref/swift/Guide/15to16" class="dashAnchor"></a>
<a class="direct-link" href="15to16.html">15to16</a>
</code>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/documentation.FAQ"></a>
<a name="//apple_ref/swift/Guide/FAQ" class="dashAnchor"></a>
<a class="direct-link" href="faq.html">FAQ</a>
</code>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/documentation.12to13"></a>
<a name="//apple_ref/swift/Guide/12to13" class="dashAnchor"></a>
<a class="direct-link" href="12to13.html">12to13</a>
</code>
</div>
</li>
</ul>
</div>
</div> </div>
</section> </section>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

115
docs/Protocols.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="index.html"> <a class="header-link" href="index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="12to13.html">12to13</a> <a class="nav-group-task-link" href="12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="faq.html">FAQ</a> <a class="nav-group-task-link" href="faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a> <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,7 +225,7 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>Protocols</h1> <h1>Protocols</h1>
<p>The following protocols are available globally.</p> <p>The following protocols are available globally.</p>
@ -223,10 +264,6 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -255,10 +292,6 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -288,10 +321,6 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -320,16 +349,12 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec"></a> <a name="/s:8SocketIO0A10EngineSpecP"></a>
<a name="//apple_ref/swift/Protocol/SocketEngineSpec" class="dashAnchor"></a> <a name="//apple_ref/swift/Protocol/SocketEngineSpec" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec">SocketEngineSpec</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP">SocketEngineSpec</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -345,18 +370,13 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketEngineSpec</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
<span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketEngineSpec</span></code></pre>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -385,16 +405,12 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec"></a> <a name="/s:8SocketIO0A11ManagerSpecP"></a>
<a name="//apple_ref/swift/Protocol/SocketManagerSpec" class="dashAnchor"></a> <a name="//apple_ref/swift/Protocol/SocketManagerSpec" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec">SocketManagerSpec</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP">SocketManagerSpec</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -407,7 +423,7 @@
<p>A <code>SocketManagerSpec</code> is responsible for multiplexing multiple namespaces through a single <code><a href="Protocols/SocketEngineSpec.html">SocketEngineSpec</a></code>.</p> <p>A <code>SocketManagerSpec</code> is responsible for multiplexing multiple namespaces through a single <code><a href="Protocols/SocketEngineSpec.html">SocketEngineSpec</a></code>.</p>
<p>Example with <code><a href="Classes/SocketManager.html">SocketManager</a></code>:</p> <p>Example with <code><a href="Classes/SocketManager.html">SocketManager</a></code>:</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="nf">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="nf">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span><span class="s">"http://localhost:8080/"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span> <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="kt">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span><span class="s">"http://localhost:8080/"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span>
<span class="k">let</span> <span class="nv">defaultNamespaceSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span> <span class="k">let</span> <span class="nv">defaultNamespaceSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span>
<span class="k">let</span> <span class="nv">swiftSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span> <span class="k">let</span> <span class="nv">swiftSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span>
@ -417,7 +433,7 @@
<p>Sockets created through the manager are retained by the manager. So at the very least, a single strong reference <p>Sockets created through the manager are retained by the manager. So at the very least, a single strong reference
to the manager must be maintained to keep sockets alive.</p> to the manager must be maintained to keep sockets alive.</p>
<p>To disconnect a socket and remove it from the manager, either call <code><a href="Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)disconnect">SocketIOClient.disconnect()</a></code> on the socket, <p>To disconnect a socket and remove it from the manager, either call <code><a href="Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10disconnectyyF">SocketIOClient.disconnect()</a></code> on the socket,
or call one of the <code>disconnectSocket</code> methods on this class.</p> or call one of the <code>disconnectSocket</code> methods on this class.</p>
<a href="Protocols/SocketManagerSpec.html" class="slightly-smaller">See more</a> <a href="Protocols/SocketManagerSpec.html" class="slightly-smaller">See more</a>
@ -426,18 +442,13 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@objc</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketManagerSpec</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketEngineClient.html">SocketEngineClient</a></span></code></pre>
<span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketManagerSpec</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">,</span> <span class="kt"><a href="Protocols/SocketEngineClient.html">SocketEngineClient</a></span></code></pre>
</div> </div>
</div> </div>
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -494,10 +505,6 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -526,10 +533,6 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -546,16 +549,16 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<p>A marking protocol that says a type can be represented in a socket.io packet.</p> <p>A marking protocol that says a type can be represented in a socket.io packet.</p>
<p>Example:</p> <p>Example:</p>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">CustomData</span> <span class="p">:</span> <span class="nf">SocketData</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">CustomData</span> <span class="p">:</span> <span class="kt">SocketData</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span> <span class="k">let</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span>
<span class="k">let</span> <span class="nv">age</span><span class="p">:</span> <span class="kt">Int</span> <span class="k">let</span> <span class="nv">age</span><span class="p">:</span> <span class="kt">Int</span>
<span class="kd">func</span> <span class="nf">socketRepresentation</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nf">SocketData</span> <span class="p">{</span> <span class="kd">func</span> <span class="nf">socketRepresentation</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SocketData</span> <span class="p">{</span>
<span class="k">return</span> <span class="p">[</span><span class="s">"name"</span><span class="p">:</span> <span class="n">name</span><span class="p">,</span> <span class="s">"age"</span><span class="p">:</span> <span class="n">age</span><span class="p">]</span> <span class="k">return</span> <span class="p">[</span><span class="s">"name"</span><span class="p">:</span> <span class="n">name</span><span class="p">,</span> <span class="s">"age"</span><span class="p">:</span> <span class="n">age</span><span class="p">]</span>
<span class="p">}</span> <span class="p">}</span>
<span class="p">}</span> <span class="p">}</span>
<span class="n">socket</span><span class="o">.</span><span class="nf">emit</span><span class="p">(</span><span class="s">"myEvent"</span><span class="p">,</span> <span class="nf">CustomData</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="s">"Erik"</span><span class="p">,</span> <span class="nv">age</span><span class="p">:</span> <span class="mi">24</span><span class="p">))</span> <span class="n">socket</span><span class="o">.</span><span class="nf">emit</span><span class="p">(</span><span class="s">"myEvent"</span><span class="p">,</span> <span class="kt">CustomData</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="s">"Erik"</span><span class="p">,</span> <span class="nv">age</span><span class="p">:</span> <span class="mi">24</span><span class="p">))</span>
</code></pre> </code></pre>
<a href="Protocols/SocketData.html" class="slightly-smaller">See more</a> <a href="Protocols/SocketData.html" class="slightly-smaller">See more</a>
@ -579,8 +582,8 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

66
docs/Protocols/ConfigSettable.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>ConfigSettable</h1> <h1>ConfigSettable</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ConfigSettable</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">ConfigSettable</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -213,7 +257,7 @@
<code> <code>
<a name="/s:8SocketIO14ConfigSettableP10setConfigsyyAA0A21IOClientConfigurationVF"></a> <a name="/s:8SocketIO14ConfigSettableP10setConfigsyyAA0A21IOClientConfigurationVF"></a>
<a name="//apple_ref/swift/Method/setConfigs(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/setConfigs(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO14ConfigSettableP10setConfigsyyAA0A21IOClientConfigurationVF">setConfigs(_:)</a> <a class="token" href="#/s:8SocketIO14ConfigSettableP10setConfigsyyAA0A21IOClientConfigurationVF">setConfigs(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -262,8 +306,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

70
docs/Protocols/SocketData.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketData</h1> <h1>SocketData</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketData</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketData</span></code></pre>
</div> </div>
@ -195,16 +237,16 @@
<p>A marking protocol that says a type can be represented in a socket.io packet.</p> <p>A marking protocol that says a type can be represented in a socket.io packet.</p>
<p>Example:</p> <p>Example:</p>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">CustomData</span> <span class="p">:</span> <span class="nf">SocketData</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">CustomData</span> <span class="p">:</span> <span class="kt">SocketData</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span> <span class="k">let</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span>
<span class="k">let</span> <span class="nv">age</span><span class="p">:</span> <span class="kt">Int</span> <span class="k">let</span> <span class="nv">age</span><span class="p">:</span> <span class="kt">Int</span>
<span class="kd">func</span> <span class="nf">socketRepresentation</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nf">SocketData</span> <span class="p">{</span> <span class="kd">func</span> <span class="nf">socketRepresentation</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SocketData</span> <span class="p">{</span>
<span class="k">return</span> <span class="p">[</span><span class="s">"name"</span><span class="p">:</span> <span class="n">name</span><span class="p">,</span> <span class="s">"age"</span><span class="p">:</span> <span class="n">age</span><span class="p">]</span> <span class="k">return</span> <span class="p">[</span><span class="s">"name"</span><span class="p">:</span> <span class="n">name</span><span class="p">,</span> <span class="s">"age"</span><span class="p">:</span> <span class="n">age</span><span class="p">]</span>
<span class="p">}</span> <span class="p">}</span>
<span class="p">}</span> <span class="p">}</span>
<span class="n">socket</span><span class="o">.</span><span class="nf">emit</span><span class="p">(</span><span class="s">"myEvent"</span><span class="p">,</span> <span class="nf">CustomData</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="s">"Erik"</span><span class="p">,</span> <span class="nv">age</span><span class="p">:</span> <span class="mi">24</span><span class="p">))</span> <span class="n">socket</span><span class="o">.</span><span class="nf">emit</span><span class="p">(</span><span class="s">"myEvent"</span><span class="p">,</span> <span class="kt">CustomData</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="s">"Erik"</span><span class="p">,</span> <span class="nv">age</span><span class="p">:</span> <span class="mi">24</span><span class="p">))</span>
</code></pre> </code></pre>
</div> </div>
@ -216,9 +258,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -264,8 +308,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

64
docs/Protocols/SocketDataBufferable.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketDataBufferable</h1> <h1>SocketDataBufferable</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketDataBufferable</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketDataBufferable</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -248,8 +292,8 @@ So this should ideally be an array of one packet waiting for data.</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

96
docs/Protocols/SocketEngineClient.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketEngineClient</h1> <h1>SocketEngineClient</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">@objc</span> <pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketEngineClient</span></code></pre> <span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketEngineClient</span></code></pre>
@ -204,9 +246,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -214,7 +258,7 @@
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidErrorWithReason:"></a> <a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidErrorWithReason:"></a>
<a name="//apple_ref/swift/Method/engineDidError(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidError(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidErrorWithReason:">engineDidError(reason:)</a> <a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidErrorWithReason:">engineDidError(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -260,7 +304,7 @@
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidCloseWithReason:"></a> <a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidCloseWithReason:"></a>
<a name="//apple_ref/swift/Method/engineDidClose(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidClose(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidCloseWithReason:">engineDidClose(reason:)</a> <a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidCloseWithReason:">engineDidClose(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -306,7 +350,7 @@
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidOpenWithReason:"></a> <a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidOpenWithReason:"></a>
<a name="//apple_ref/swift/Method/engineDidOpen(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidOpen(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidOpenWithReason:">engineDidOpen(reason:)</a> <a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidOpenWithReason:">engineDidOpen(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -350,9 +394,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidReceivePong"></a> <a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidReceivePing"></a>
<a name="//apple_ref/swift/Method/engineDidReceivePong()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidReceivePing()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidReceivePong">engineDidReceivePong()</a> <a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidReceivePing">engineDidReceivePing()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -360,14 +404,14 @@
<section class="section"> <section class="section">
<div class="pointer"></div> <div class="pointer"></div>
<div class="abstract"> <div class="abstract">
<p>Called when the engine receives a pong message.</p> <p>Called when the engine receives a ping message.</p>
</div> </div>
<div class="declaration"> <div class="declaration">
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">engineDidReceivePong</span><span class="p">()</span></code></pre> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">engineDidReceivePing</span><span class="p">()</span></code></pre>
</div> </div>
</div> </div>
@ -377,9 +421,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidSendPing"></a> <a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidSendPong"></a>
<a name="//apple_ref/swift/Method/engineDidSendPing()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidSendPong()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidSendPing">engineDidSendPing()</a> <a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidSendPong">engineDidSendPong()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -387,14 +431,14 @@
<section class="section"> <section class="section">
<div class="pointer"></div> <div class="pointer"></div>
<div class="abstract"> <div class="abstract">
<p>Called when the engine sends a ping to the server.</p> <p>Called when the engine sends a pong to the server.</p>
</div> </div>
<div class="declaration"> <div class="declaration">
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">engineDidSendPing</span><span class="p">()</span></code></pre> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">engineDidSendPong</span><span class="p">()</span></code></pre>
</div> </div>
</div> </div>
@ -406,7 +450,7 @@
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineMessage:"></a> <a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineMessage:"></a>
<a name="//apple_ref/swift/Method/parseEngineMessage(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/parseEngineMessage(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineMessage:">parseEngineMessage(_:)</a> <a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineMessage:">parseEngineMessage(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -452,7 +496,7 @@
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineBinaryData:"></a> <a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineBinaryData:"></a>
<a name="//apple_ref/swift/Method/parseEngineBinaryData(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/parseEngineBinaryData(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineBinaryData:">parseEngineBinaryData(_:)</a> <a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)parseEngineBinaryData:">parseEngineBinaryData(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -498,7 +542,7 @@
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidWebsocketUpgradeWithHeaders:"></a> <a name="/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidWebsocketUpgradeWithHeaders:"></a>
<a name="//apple_ref/swift/Method/engineDidWebsocketUpgrade(headers:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/engineDidWebsocketUpgrade(headers:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidWebsocketUpgradeWithHeaders:">engineDidWebsocketUpgrade(headers:)</a> <a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineClient(im)engineDidWebsocketUpgradeWithHeaders:">engineDidWebsocketUpgrade(headers:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -547,8 +591,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

82
docs/Protocols/SocketEnginePollable.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketEnginePollable</h1> <h1>SocketEnginePollable</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketEnginePollable</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineSpec.html">SocketEngineSpec</a></span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketEnginePollable</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineSpec.html">SocketEngineSpec</a></span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -228,7 +272,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">invalidated</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">invalidated</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -284,7 +328,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">session</span><span class="p">:</span> <span class="nf">URLSession</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">session</span><span class="p">:</span> <span class="kt">URLSession</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -314,7 +358,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">waitingForPoll</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">waitingForPoll</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -344,7 +388,7 @@ disconnect us.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">waitingForPost</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">waitingForPost</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -357,9 +401,11 @@ disconnect us.</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -406,7 +452,7 @@ disconnect us.</p>
<code> <code>
<a name="/s:8SocketIO0A14EnginePollableP15sendPollMessage_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF"></a> <a name="/s:8SocketIO0A14EnginePollableP15sendPollMessage_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF"></a>
<a name="//apple_ref/swift/Method/sendPollMessage(_:withType:withData:completion:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/sendPollMessage(_:withType:withData:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A14EnginePollableP15sendPollMessage_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF">sendPollMessage(_:withType:withData:completion:)</a> <a class="token" href="#/s:8SocketIO0A14EnginePollableP15sendPollMessage_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF">sendPollMessage(_:<wbr>withType:<wbr>withData:<wbr>completion:<wbr>)</a>
</code> </code>
<span class="declaration-note"> <span class="declaration-note">
Default implementation Default implementation
@ -526,8 +572,8 @@ disconnect us.</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

229
docs/Protocols/SocketEngineSpec.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,12 +225,12 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketEngineSpec</h1> <h1>SocketEngineSpec</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketEngineSpec</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketEngineSpec</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div> </div>
</div> </div>
@ -204,17 +245,19 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)client"></a> <a name="/s:8SocketIO0A10EngineSpecP6clientAA0aC6Client_pSgvp"></a>
<a name="//apple_ref/swift/Property/client" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/client" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)client">client</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP6clientAA0aC6Client_pSgvp">client</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -229,7 +272,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">client</span><span class="p">:</span> <span class="nf">SocketEngineClient</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">client</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineClient.html">SocketEngineClient</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -239,9 +282,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)closed"></a> <a name="/s:8SocketIO0A10EngineSpecP6closedSbvp"></a>
<a name="//apple_ref/swift/Property/closed" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/closed" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)closed">closed</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP6closedSbvp">closed</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -256,7 +299,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">closed</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">closed</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -266,9 +309,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)compress"></a> <a name="/s:8SocketIO0A10EngineSpecP8compressSbvp"></a>
<a name="//apple_ref/swift/Property/compress" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/compress" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)compress">compress</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP8compressSbvp">compress</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -283,7 +326,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">compress</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">compress</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -293,9 +336,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)connected"></a> <a name="/s:8SocketIO0A10EngineSpecP9connectedSbvp"></a>
<a name="//apple_ref/swift/Property/connected" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/connected" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)connected">connected</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP9connectedSbvp">connected</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -310,7 +353,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">connected</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">connected</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -320,9 +363,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)connectParams"></a> <a name="/s:8SocketIO0A10EngineSpecP13connectParamsSDySSypGSgvp"></a>
<a name="//apple_ref/swift/Property/connectParams" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/connectParams" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)connectParams">connectParams</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP13connectParamsSDySSypGSgvp">connectParams</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -347,9 +390,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)cookies"></a> <a name="/s:8SocketIO0A10EngineSpecP7cookiesSaySo12NSHTTPCookieCGSgvp"></a>
<a name="//apple_ref/swift/Property/cookies" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/cookies" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)cookies">cookies</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP7cookiesSaySo12NSHTTPCookieCGSgvp">cookies</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -374,9 +417,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)engineQueue"></a> <a name="/s:8SocketIO0A10EngineSpecP11engineQueueSo17OS_dispatch_queueCvp"></a>
<a name="//apple_ref/swift/Property/engineQueue" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/engineQueue" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)engineQueue">engineQueue</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP11engineQueueSo17OS_dispatch_queueCvp">engineQueue</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -391,7 +434,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">engineQueue</span><span class="p">:</span> <span class="nf">DispatchQueue</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">engineQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -401,9 +444,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)extraHeaders"></a> <a name="/s:8SocketIO0A10EngineSpecP12extraHeadersSDyS2SGSgvp"></a>
<a name="//apple_ref/swift/Property/extraHeaders" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/extraHeaders" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)extraHeaders">extraHeaders</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP12extraHeadersSDyS2SGSgvp">extraHeaders</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -428,9 +471,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)fastUpgrade"></a> <a name="/s:8SocketIO0A10EngineSpecP11fastUpgradeSbvp"></a>
<a name="//apple_ref/swift/Property/fastUpgrade" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/fastUpgrade" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)fastUpgrade">fastUpgrade</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP11fastUpgradeSbvp">fastUpgrade</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -445,7 +488,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">fastUpgrade</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">fastUpgrade</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -455,9 +498,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)forcePolling"></a> <a name="/s:8SocketIO0A10EngineSpecP12forcePollingSbvp"></a>
<a name="//apple_ref/swift/Property/forcePolling" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/forcePolling" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)forcePolling">forcePolling</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP12forcePollingSbvp">forcePolling</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -472,7 +515,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">forcePolling</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">forcePolling</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -482,9 +525,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)forceWebsockets"></a> <a name="/s:8SocketIO0A10EngineSpecP15forceWebsocketsSbvp"></a>
<a name="//apple_ref/swift/Property/forceWebsockets" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/forceWebsockets" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)forceWebsockets">forceWebsockets</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP15forceWebsocketsSbvp">forceWebsockets</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -499,7 +542,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">forceWebsockets</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">forceWebsockets</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -509,9 +552,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)polling"></a> <a name="/s:8SocketIO0A10EngineSpecP7pollingSbvp"></a>
<a name="//apple_ref/swift/Property/polling" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/polling" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)polling">polling</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP7pollingSbvp">polling</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -526,7 +569,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">polling</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">polling</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -536,9 +579,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)probing"></a> <a name="/s:8SocketIO0A10EngineSpecP7probingSbvp"></a>
<a name="//apple_ref/swift/Property/probing" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/probing" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)probing">probing</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP7probingSbvp">probing</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -553,7 +596,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">probing</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">probing</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -563,9 +606,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)sid"></a> <a name="/s:8SocketIO0A10EngineSpecP3sidSSvp"></a>
<a name="//apple_ref/swift/Property/sid" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/sid" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)sid">sid</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP3sidSSvp">sid</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -580,7 +623,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">sid</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">sid</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -590,9 +633,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)socketPath"></a> <a name="/s:8SocketIO0A10EngineSpecP10socketPathSSvp"></a>
<a name="//apple_ref/swift/Property/socketPath" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/socketPath" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)socketPath">socketPath</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP10socketPathSSvp">socketPath</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -607,7 +650,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">socketPath</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">socketPath</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -617,9 +660,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)urlPolling"></a> <a name="/s:8SocketIO0A10EngineSpecP10urlPolling10Foundation3URLVvp"></a>
<a name="//apple_ref/swift/Property/urlPolling" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/urlPolling" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)urlPolling">urlPolling</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP10urlPolling10Foundation3URLVvp">urlPolling</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -634,7 +677,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">urlPolling</span><span class="p">:</span> <span class="nf">URL</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">urlPolling</span><span class="p">:</span> <span class="kt">URL</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -644,9 +687,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)urlWebSocket"></a> <a name="/s:8SocketIO0A10EngineSpecP06urlWebA010Foundation3URLVvp"></a>
<a name="//apple_ref/swift/Property/urlWebSocket" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/urlWebSocket" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)urlWebSocket">urlWebSocket</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP06urlWebA010Foundation3URLVvp">urlWebSocket</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -661,7 +704,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">urlWebSocket</span><span class="p">:</span> <span class="nf">URL</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">urlWebSocket</span><span class="p">:</span> <span class="kt">URL</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -671,9 +714,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)websocket"></a> <a name="/s:8SocketIO0A10EngineSpecP9websocketSbvp"></a>
<a name="//apple_ref/swift/Property/websocket" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/websocket" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)websocket">websocket</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP9websocketSbvp">websocket</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -688,8 +731,8 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@available(*, deprecated, message: "No longer needed, if we're not polling, then we must be doing websockets")</span> <pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"No longer needed, if we're not polling, then we must be doing websockets"</span><span class="p">)</span>
<span class="k">var</span> <span class="nv">websocket</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <span class="k">var</span> <span class="nv">websocket</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -699,9 +742,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)ws"></a> <a name="/s:8SocketIO0A10EngineSpecP2ws10Starscream03WebA0CSgvp"></a>
<a name="//apple_ref/swift/Property/ws" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/ws" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(py)ws">ws</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP2ws10Starscream03WebA0CSgvp">ws</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -716,7 +759,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">ws</span><span class="p">:</span> <span class="nf">WebSocket</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">ws</span><span class="p">:</span> <span class="kt">WebSocket</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -729,17 +772,19 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Initializers"></a> <a name="/Initializers"></a>
<a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a>
<a href="#/Initializers"> <div class="section-name-container">
<h3 class="section-name">Initializers</h3> <a class="section-name-link" href="#/Initializers"></a>
</a> <h3 class="section-name"><p>Initializers</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)initWithClient:url:options:"></a> <a name="/s:8SocketIO0A10EngineSpecP6client3url7optionsxAA0aC6Client_p_10Foundation3URLVSDySSypGSgtcfc"></a>
<a name="//apple_ref/swift/Method/init(client:url:options:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/init(client:url:options:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)initWithClient:url:options:">init(client:url:options:)</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP6client3url7optionsxAA0aC6Client_p_10Foundation3URLVSDySSypGSgtcfc">init(client:<wbr>url:<wbr>options:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -810,17 +855,19 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)connect"></a> <a name="/s:8SocketIO0A10EngineSpecP7connectyyF"></a>
<a name="//apple_ref/swift/Method/connect()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/connect()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)connect">connect()</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP7connectyyF">connect()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -845,9 +892,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)didErrorWithReason:"></a> <a name="/s:8SocketIO0A10EngineSpecP8didError6reasonySS_tF"></a>
<a name="//apple_ref/swift/Method/didError(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/didError(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)didErrorWithReason:">didError(reason:)</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP8didError6reasonySS_tF">didError(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -872,9 +919,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)disconnectWithReason:"></a> <a name="/s:8SocketIO0A10EngineSpecP10disconnect6reasonySS_tF"></a>
<a name="//apple_ref/swift/Method/disconnect(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/disconnect(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)disconnectWithReason:">disconnect(reason:)</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP10disconnect6reasonySS_tF">disconnect(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -918,9 +965,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)doFastUpgrade"></a> <a name="/s:8SocketIO0A10EngineSpecP13doFastUpgradeyyF"></a>
<a name="//apple_ref/swift/Method/doFastUpgrade()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/doFastUpgrade()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)doFastUpgrade">doFastUpgrade()</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP13doFastUpgradeyyF">doFastUpgrade()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -948,9 +995,9 @@ WebSocket mode.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)flushWaitingForPostToWebSocket"></a> <a name="/s:8SocketIO0A10EngineSpecP024flushWaitingForPostToWebA0yyF"></a>
<a name="//apple_ref/swift/Method/flushWaitingForPostToWebSocket()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/flushWaitingForPostToWebSocket()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)flushWaitingForPostToWebSocket">flushWaitingForPostToWebSocket()</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP024flushWaitingForPostToWebA0yyF">flushWaitingForPostToWebSocket()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -978,9 +1025,9 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)parseEngineData:"></a> <a name="/s:8SocketIO0A10EngineSpecP05parseC4Datayy10Foundation0F0VF"></a>
<a name="//apple_ref/swift/Method/parseEngineData(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/parseEngineData(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)parseEngineData:">parseEngineData(_:)</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP05parseC4Datayy10Foundation0F0VF">parseEngineData(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1024,9 +1071,9 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)parseEngineMessage:"></a> <a name="/s:8SocketIO0A10EngineSpecP05parseC7MessageyySSF"></a>
<a name="//apple_ref/swift/Method/parseEngineMessage(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/parseEngineMessage(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)parseEngineMessage:">parseEngineMessage(_:)</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP05parseC7MessageyySSF">parseEngineMessage(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1070,9 +1117,9 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)write:withType:withData:completion:"></a> <a name="/s:8SocketIO0A10EngineSpecP5write_8withType0F4Data10completionySS_AA0ac6PacketG0OSay10Foundation0H0VGyycSgtF"></a>
<a name="//apple_ref/swift/Method/write(_:withType:withData:completion:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/write(_:withType:withData:completion:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketEngineSpec(im)write:withType:withData:completion:">write(_:withType:withData:completion:)</a> <a class="token" href="#/s:8SocketIO0A10EngineSpecP5write_8withType0F4Data10completionySS_AA0ac6PacketG0OSay10Foundation0H0VGyycSgtF">write(_:<wbr>withType:<wbr>withData:<wbr>completion:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1157,8 +1204,8 @@ the engine is attempting to upgrade to WebSocket it does not do any POSTing.</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

111
docs/Protocols/SocketEngineWebsocket.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketEngineWebsocket</h1> <h1>SocketEngineWebsocket</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketEngineWebsocket</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineSpec.html">SocketEngineSpec</a></span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketEngineWebsocket</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineSpec.html">SocketEngineSpec</a></span></code></pre>
</div> </div>
@ -199,13 +241,55 @@
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content">
<div class="task-group">
<div class="task-name-container">
<a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/Properties"></a>
<h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:8SocketIO0A15EngineWebsocketP11wsConnectedSbvp"></a>
<a name="//apple_ref/swift/Property/wsConnected" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A15EngineWebsocketP11wsConnectedSbvp">wsConnected</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether or not the ws is connected</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">wsConnected</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group"> <div class="task-group">
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -213,7 +297,7 @@
<code> <code>
<a name="/s:8SocketIO0A15EngineWebsocketP07sendWebA7Message_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF"></a> <a name="/s:8SocketIO0A15EngineWebsocketP07sendWebA7Message_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF"></a>
<a name="//apple_ref/swift/Method/sendWebSocketMessage(_:withType:withData:completion:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/sendWebSocketMessage(_:withType:withData:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A15EngineWebsocketP07sendWebA7Message_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF">sendWebSocketMessage(_:withType:withData:completion:)</a> <a class="token" href="#/s:8SocketIO0A15EngineWebsocketP07sendWebA7Message_8withType0H4Data10completionySS_AA0ac6PacketI0OSay10Foundation0J0VGyycSgtF">sendWebSocketMessage(_:<wbr>withType:<wbr>withData:<wbr>completion:<wbr>)</a>
</code> </code>
<span class="declaration-note"> <span class="declaration-note">
Default implementation Default implementation
@ -240,7 +324,10 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendWebSocketMessage</span><span class="p">(</span><span class="n">_</span> <span class="nv">str</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">withType</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Enums/SocketEnginePacketType.html">SocketEnginePacketType</a></span><span class="p">,</span> <span class="n">withData</span> <span class="nv">datas</span><span class="p">:</span> <span class="p">[</span><span class="kt">Data</span><span class="p">],</span> <span class="nv">completion</span><span class="p">:</span> <span class="p">(()</span> <span class="o">-&gt;</span> <span class="p">())?)</span></code></pre> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendWebSocketMessage</span><span class="p">(</span><span class="n">_</span> <span class="nv">str</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
<span class="n">withType</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Enums/SocketEnginePacketType.html">SocketEnginePacketType</a></span><span class="p">,</span>
<span class="n">withData</span> <span class="nv">datas</span><span class="p">:</span> <span class="p">[</span><span class="kt">Data</span><span class="p">],</span>
<span class="nv">completion</span><span class="p">:</span> <span class="p">(()</span> <span class="o">-&gt;</span> <span class="p">())?)</span></code></pre>
</div> </div>
</div> </div>
@ -310,8 +397,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

229
docs/Protocols/SocketIOClientSpec.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketIOClientSpec</h1> <h1>SocketIOClientSpec</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketIOClientSpec</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketIOClientSpec</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -282,7 +326,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">manager</span><span class="p">:</span> <span class="nf">SocketManagerSpec</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">manager</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SocketManagerSpec.html">SocketManagerSpec</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -311,7 +355,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">nsp</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">nsp</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -344,7 +388,34 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">rawEmitView</span><span class="p">:</span> <span class="nf">SocketRawView</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">rawEmitView</span><span class="p">:</span> <span class="kt"><a href="../Classes/SocketRawView.html">SocketRawView</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8SocketIO0A12IOClientSpecP3sidSSSgvp"></a>
<a name="//apple_ref/swift/Property/sid" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP3sidSSSgvp">sid</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The id of this socket.io connect. This is different from the sid of the engine.io connection.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">sid</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -371,7 +442,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">status</span><span class="p">:</span> <span class="nf">SocketIOStatus</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">status</span><span class="p">:</span> <span class="kt"><a href="../Enums/SocketIOStatus.html">SocketIOStatus</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -384,17 +455,19 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP7connectyyF"></a> <a name="/s:8SocketIO0A12IOClientSpecP7connect11withPayloadySDySSypGSg_tF"></a>
<a name="//apple_ref/swift/Method/connect()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/connect(withPayload:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP7connectyyF">connect()</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP7connect11withPayloadySDySSypGSg_tF">connect(withPayload:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -402,7 +475,7 @@
<section class="section"> <section class="section">
<div class="pointer"></div> <div class="pointer"></div>
<div class="abstract"> <div class="abstract">
<p>Connect to the server. The same as calling <code><a href="../Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP7connect12timeoutAfter11withHandlerySd_yycSgtF">connect(timeoutAfter:withHandler:)</a></code> with a timeout of 0.</p> <p>Connect to the server. The same as calling <code>connect(timeoutAfter:withHandler:)</code> with a timeout of 0.</p>
<p>Only call after adding your event listeners, unless you know what you&rsquo;re doing.</p> <p>Only call after adding your event listeners, unless you know what you&rsquo;re doing.</p>
@ -411,19 +484,38 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">connect</span><span class="p">()</span></code></pre> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">connect</span><span class="p">(</span><span class="n">withPayload</span> <span class="nv">payload</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?)</span></code></pre>
</div> </div>
</div> </div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>payload</em>
</code>
</td>
<td>
<div>
<p>An optional payload sent on connect</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section> </section>
</div> </div>
</li> </li>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP7connect12timeoutAfter11withHandlerySd_yycSgtF"></a> <a name="/s:8SocketIO0A12IOClientSpecP7connect11withPayload12timeoutAfter0F7HandlerySDySSypGSg_SdyycSgtF"></a>
<a name="//apple_ref/swift/Method/connect(timeoutAfter:withHandler:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/connect(withPayload:timeoutAfter:withHandler:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP7connect12timeoutAfter11withHandlerySd_yycSgtF">connect(timeoutAfter:withHandler:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP7connect11withPayload12timeoutAfter0F7HandlerySDySSypGSg_SdyycSgtF">connect(withPayload:<wbr>timeoutAfter:<wbr>withHandler:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -440,7 +532,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">connect</span><span class="p">(</span><span class="nv">timeoutAfter</span><span class="p">:</span> <span class="kt">Double</span><span class="p">,</span> <span class="n">withHandler</span> <span class="nv">handler</span><span class="p">:</span> <span class="p">(()</span> <span class="o">-&gt;</span> <span class="p">())?)</span></code></pre> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">connect</span><span class="p">(</span><span class="n">withPayload</span> <span class="nv">payload</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?,</span> <span class="nv">timeoutAfter</span><span class="p">:</span> <span class="kt">Double</span><span class="p">,</span> <span class="n">withHandler</span> <span class="nv">handler</span><span class="p">:</span> <span class="p">(()</span> <span class="o">-&gt;</span> <span class="p">())?)</span></code></pre>
</div> </div>
</div> </div>
@ -448,6 +540,18 @@
<h4>Parameters</h4> <h4>Parameters</h4>
<table class="graybox"> <table class="graybox">
<tbody> <tbody>
<tr>
<td>
<code>
<em>withPayload</em>
</code>
</td>
<td>
<div>
<p>An optional payload sent on connect</p>
</div>
</td>
</tr>
<tr> <tr>
<td> <td>
<code> <code>
@ -482,9 +586,9 @@
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP10didConnect11toNamespaceySS_tF"></a> <a name="/s:8SocketIO0A12IOClientSpecP10didConnect11toNamespace7payloadySS_SDySSypGSgtF"></a>
<a name="//apple_ref/swift/Method/didConnect(toNamespace:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/didConnect(toNamespace:payload:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP10didConnect11toNamespaceySS_tF">didConnect(toNamespace:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP10didConnect11toNamespace7payloadySS_SDySSypGSgtF">didConnect(toNamespace:<wbr>payload:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -500,7 +604,7 @@ then this is only called when the client connects to that namespace.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">didConnect</span><span class="p">(</span><span class="n">toNamespace</span> <span class="nv">namespace</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">didConnect</span><span class="p">(</span><span class="n">toNamespace</span> <span class="nv">namespace</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">payload</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?)</span></code></pre>
</div> </div>
</div> </div>
@ -531,7 +635,7 @@ then this is only called when the client connects to that namespace.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP13didDisconnect6reasonySS_tF"></a> <a name="/s:8SocketIO0A12IOClientSpecP13didDisconnect6reasonySS_tF"></a>
<a name="//apple_ref/swift/Method/didDisconnect(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/didDisconnect(reason:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP13didDisconnect6reasonySS_tF">didDisconnect(reason:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP13didDisconnect6reasonySS_tF">didDisconnect(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -577,7 +681,7 @@ then this is only called when the client connects to that namespace.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP8didError6reasonySS_tF"></a> <a name="/s:8SocketIO0A12IOClientSpecP8didError6reasonySS_tF"></a>
<a name="//apple_ref/swift/Method/didError(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/didError(reason:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP8didError6reasonySS_tF">didError(reason:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP8didError6reasonySS_tF">didError(reason:<wbr>)</a>
</code> </code>
<span class="declaration-note"> <span class="declaration-note">
Default implementation Default implementation
@ -658,7 +762,7 @@ then this is only called when the client connects to that namespace.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP4emit__10completionySS_AA0A4Data_pdyycSgtF"></a> <a name="/s:8SocketIO0A12IOClientSpecP4emit__10completionySS_AA0A4Data_pdyycSgtF"></a>
<a name="//apple_ref/swift/Method/emit(_:_:completion:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/emit(_:_:completion:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP4emit__10completionySS_AA0A4Data_pdyycSgtF">emit(_:_:completion:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP4emit__10completionySS_AA0A4Data_pdyycSgtF">emit(_:<wbr>_:<wbr>completion:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -731,7 +835,7 @@ will be emitted. The structure of the error data is <code>[eventName, items, the
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP7emitAck_4withySi_SayypGtF"></a> <a name="/s:8SocketIO0A12IOClientSpecP7emitAck_4withySi_SayypGtF"></a>
<a name="//apple_ref/swift/Method/emitAck(_:with:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/emitAck(_:with:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP7emitAck_4withySi_SayypGtF">emitAck(_:with:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP7emitAck_4withySi_SayypGtF">emitAck(_:<wbr>with:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -789,7 +893,7 @@ will be emitted. The structure of the error data is <code>[eventName, items, the
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF"></a> <a name="/s:8SocketIO0A12IOClientSpecP11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF"></a>
<a name="//apple_ref/swift/Method/emitWithAck(_:_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/emitWithAck(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF">emitWithAck(_:_:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP11emitWithAckyAA02OnG8CallbackCSS_AA0A4Data_pdtF">emitWithAck(_:<wbr>_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -863,7 +967,7 @@ will be emitted. The structure of the error data is <code>[eventName, items, the
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP9handleAck_4dataySi_SayypGtF"></a> <a name="/s:8SocketIO0A12IOClientSpecP9handleAck_4dataySi_SayypGtF"></a>
<a name="//apple_ref/swift/Method/handleAck(_:data:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/handleAck(_:data:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP9handleAck_4dataySi_SayypGtF">handleAck(_:data:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP9handleAck_4dataySi_SayypGtF">handleAck(_:<wbr>data:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -921,7 +1025,7 @@ will be emitted. The structure of the error data is <code>[eventName, items, the
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP17handleClientEvent_4datayAA0afG0O_SayypGtF"></a> <a name="/s:8SocketIO0A12IOClientSpecP17handleClientEvent_4datayAA0afG0O_SayypGtF"></a>
<a name="//apple_ref/swift/Method/handleClientEvent(_:data:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/handleClientEvent(_:data:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP17handleClientEvent_4datayAA0afG0O_SayypGtF">handleClientEvent(_:data:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP17handleClientEvent_4datayAA0afG0O_SayypGtF">handleClientEvent(_:<wbr>data:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -979,7 +1083,7 @@ will be emitted. The structure of the error data is <code>[eventName, items, the
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP11handleEvent_4data17isInternalMessage7withAckySS_SayypGSbSitF"></a> <a name="/s:8SocketIO0A12IOClientSpecP11handleEvent_4data17isInternalMessage7withAckySS_SayypGSbSitF"></a>
<a name="//apple_ref/swift/Method/handleEvent(_:data:isInternalMessage:withAck:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/handleEvent(_:data:isInternalMessage:withAck:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP11handleEvent_4data17isInternalMessage7withAckySS_SayypGSbSitF">handleEvent(_:data:isInternalMessage:withAck:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP11handleEvent_4data17isInternalMessage7withAckySS_SayypGSbSitF">handleEvent(_:<wbr>data:<wbr>isInternalMessage:<wbr>withAck:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1061,7 +1165,7 @@ will be emitted. The structure of the error data is <code>[eventName, items, the
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP12handlePacketyyAA0aF0VF"></a> <a name="/s:8SocketIO0A12IOClientSpecP12handlePacketyyAA0aF0VF"></a>
<a name="//apple_ref/swift/Method/handlePacket(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/handlePacket(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP12handlePacketyyAA0aF0VF">handlePacket(_:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP12handlePacketyyAA0aF0VF">handlePacket(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1133,9 +1237,9 @@ socket.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP13joinNamespaceyyF"></a> <a name="/s:8SocketIO0A12IOClientSpecP13joinNamespace11withPayloadySDySSypGSg_tF"></a>
<a name="//apple_ref/swift/Method/joinNamespace()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/joinNamespace(withPayload:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP13joinNamespaceyyF">joinNamespace()</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP13joinNamespace11withPayloadySDySSypGSg_tF">joinNamespace(withPayload:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1143,17 +1247,36 @@ socket.</p>
<section class="section"> <section class="section">
<div class="pointer"></div> <div class="pointer"></div>
<div class="abstract"> <div class="abstract">
<p>Joins <code><a href="../Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3nspSSvp">nsp</a></code>.</p> <p>Joins <code><a href="../Protocols/SocketIOClientSpec.html#/s:8SocketIO0A12IOClientSpecP3nspSSvp">nsp</a></code>. You shouldn&rsquo;t need to call this directly, instead call <code>connect</code>.</p>
</div> </div>
<div class="declaration"> <div class="declaration">
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">joinNamespace</span><span class="p">()</span></code></pre> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">joinNamespace</span><span class="p">(</span><span class="n">withPayload</span> <span class="nv">payload</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?)</span></code></pre>
</div> </div>
</div> </div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>withPayload</em>
</code>
</td>
<td>
<div>
<p>The payload to connect when joining this namespace</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section> </section>
</div> </div>
</li> </li>
@ -1162,7 +1285,7 @@ socket.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP3off11clientEventyAA0a6ClientG0O_tF"></a> <a name="/s:8SocketIO0A12IOClientSpecP3off11clientEventyAA0a6ClientG0O_tF"></a>
<a name="//apple_ref/swift/Method/off(clientEvent:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/off(clientEvent:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP3off11clientEventyAA0a6ClientG0O_tF">off(clientEvent:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP3off11clientEventyAA0a6ClientG0O_tF">off(clientEvent:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1210,7 +1333,7 @@ socket.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP3offyySSF"></a> <a name="/s:8SocketIO0A12IOClientSpecP3offyySSF"></a>
<a name="//apple_ref/swift/Method/off(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/off(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP3offyySSF">off(_:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP3offyySSF">off(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1258,7 +1381,7 @@ socket.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP3off2idy10Foundation4UUIDV_tF"></a> <a name="/s:8SocketIO0A12IOClientSpecP3off2idy10Foundation4UUIDV_tF"></a>
<a name="//apple_ref/swift/Method/off(id:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/off(id:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP3off2idy10Foundation4UUIDV_tF">off(id:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP3off2idy10Foundation4UUIDV_tF">off(id:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1306,7 +1429,7 @@ socket.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP2on_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF"></a> <a name="/s:8SocketIO0A12IOClientSpecP2on_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF"></a>
<a name="//apple_ref/swift/Method/on(_:callback:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/on(_:callback:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP2on_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF">on(_:callback:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP2on_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF">on(_:<wbr>callback:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1368,7 +1491,7 @@ socket.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP2on11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF"></a> <a name="/s:8SocketIO0A12IOClientSpecP2on11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF"></a>
<a name="//apple_ref/swift/Method/on(clientEvent:callback:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/on(clientEvent:callback:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP2on11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF">on(clientEvent:callback:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP2on11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF">on(clientEvent:<wbr>callback:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1436,7 +1559,7 @@ socket.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP4once11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF"></a> <a name="/s:8SocketIO0A12IOClientSpecP4once11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF"></a>
<a name="//apple_ref/swift/Method/once(clientEvent:callback:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/once(clientEvent:callback:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP4once11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF">once(clientEvent:callback:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP4once11clientEvent8callback10Foundation4UUIDVAA0a6ClientG0O_ySayypG_AA0A10AckEmitterCtctF">once(clientEvent:<wbr>callback:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1498,7 +1621,7 @@ socket.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP4once_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF"></a> <a name="/s:8SocketIO0A12IOClientSpecP4once_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF"></a>
<a name="//apple_ref/swift/Method/once(_:callback:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/once(_:callback:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP4once_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF">once(_:callback:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP4once_8callback10Foundation4UUIDVSS_ySayypG_AA0A10AckEmitterCtctF">once(_:<wbr>callback:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1560,7 +1683,7 @@ socket.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP5onAnyyyyAA0aF5EventCcF"></a> <a name="/s:8SocketIO0A12IOClientSpecP5onAnyyyyAA0aF5EventCcF"></a>
<a name="//apple_ref/swift/Method/onAny(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/onAny(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP5onAnyyyyAA0aF5EventCcF">onAny(_:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP5onAnyyyyAA0aF5EventCcF">onAny(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1635,7 +1758,7 @@ socket.</p>
<code> <code>
<a name="/s:8SocketIO0A12IOClientSpecP15setReconnecting6reasonySS_tF"></a> <a name="/s:8SocketIO0A12IOClientSpecP15setReconnecting6reasonySS_tF"></a>
<a name="//apple_ref/swift/Method/setReconnecting(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/setReconnecting(reason:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12IOClientSpecP15setReconnecting6reasonySS_tF">setReconnecting(reason:)</a> <a class="token" href="#/s:8SocketIO0A12IOClientSpecP15setReconnecting6reasonySS_tF">setReconnecting(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -1668,8 +1791,8 @@ Called when the manager detects a broken connection, or when a manual reconnect
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

78
docs/Protocols/SocketLogger.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketLogger</h1> <h1>SocketLogger</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketLogger</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketLogger</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -228,7 +272,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">log</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">log</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -241,9 +285,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -251,7 +297,7 @@
<code> <code>
<a name="/s:8SocketIO0A6LoggerP3log_4typeySSyXK_SStF"></a> <a name="/s:8SocketIO0A6LoggerP3log_4typeySSyXK_SStF"></a>
<a name="//apple_ref/swift/Method/log(_:type:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/log(_:type:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A6LoggerP3log_4typeySSyXK_SStF">log(_:type:)</a> <a class="token" href="#/s:8SocketIO0A6LoggerP3log_4typeySSyXK_SStF">log(_:<wbr>type:<wbr>)</a>
</code> </code>
<span class="declaration-note"> <span class="declaration-note">
Default implementation Default implementation
@ -329,7 +375,7 @@
<code> <code>
<a name="/s:8SocketIO0A6LoggerP5error_4typeySSyXK_SStF"></a> <a name="/s:8SocketIO0A6LoggerP5error_4typeySSyXK_SStF"></a>
<a name="//apple_ref/swift/Method/error(_:type:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/error(_:type:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A6LoggerP5error_4typeySSyXK_SStF">error(_:type:)</a> <a class="token" href="#/s:8SocketIO0A6LoggerP5error_4typeySSyXK_SStF">error(_:<wbr>type:<wbr>)</a>
</code> </code>
<span class="declaration-note"> <span class="declaration-note">
Default implementation Default implementation
@ -410,8 +456,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

207
docs/Protocols/SocketManagerSpec.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,12 +225,12 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketManagerSpec</h1> <h1>SocketManagerSpec</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">@objc</span>
<span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketManagerSpec</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketEngineClient.html">SocketEngineClient</a></span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketManagerSpec</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">,</span> <span class="kt"><a href="../Protocols/SocketEngineClient.html">SocketEngineClient</a></span></code></pre>
</div> </div>
</div> </div>
@ -198,7 +239,7 @@
<p>A <code>SocketManagerSpec</code> is responsible for multiplexing multiple namespaces through a single <code><a href="../Protocols/SocketEngineSpec.html">SocketEngineSpec</a></code>.</p> <p>A <code>SocketManagerSpec</code> is responsible for multiplexing multiple namespaces through a single <code><a href="../Protocols/SocketEngineSpec.html">SocketEngineSpec</a></code>.</p>
<p>Example with <code><a href="../Classes/SocketManager.html">SocketManager</a></code>:</p> <p>Example with <code><a href="../Classes/SocketManager.html">SocketManager</a></code>:</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="nf">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="nf">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span><span class="s">"http://localhost:8080/"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span> <pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="kt">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span><span class="s">"http://localhost:8080/"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span>
<span class="k">let</span> <span class="nv">defaultNamespaceSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span> <span class="k">let</span> <span class="nv">defaultNamespaceSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span>
<span class="k">let</span> <span class="nv">swiftSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span> <span class="k">let</span> <span class="nv">swiftSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span>
@ -208,7 +249,7 @@
<p>Sockets created through the manager are retained by the manager. So at the very least, a single strong reference <p>Sockets created through the manager are retained by the manager. So at the very least, a single strong reference
to the manager must be maintained to keep sockets alive.</p> to the manager must be maintained to keep sockets alive.</p>
<p>To disconnect a socket and remove it from the manager, either call <code><a href="../Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)disconnect">SocketIOClient.disconnect()</a></code> on the socket, <p>To disconnect a socket and remove it from the manager, either call <code><a href="../Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10disconnectyyF">SocketIOClient.disconnect()</a></code> on the socket,
or call one of the <code>disconnectSocket</code> methods on this class.</p> or call one of the <code>disconnectSocket</code> methods on this class.</p>
</div> </div>
@ -220,17 +261,19 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)defaultSocket"></a> <a name="/s:8SocketIO0A11ManagerSpecP07defaultA0AA0A8IOClientCvp"></a>
<a name="//apple_ref/swift/Property/defaultSocket" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/defaultSocket" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)defaultSocket">defaultSocket</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP07defaultA0AA0A8IOClientCvp">defaultSocket</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -238,14 +281,14 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<section class="section"> <section class="section">
<div class="pointer"></div> <div class="pointer"></div>
<div class="abstract"> <div class="abstract">
<p>Returns the socket associated with the default namespace (<q>/</q>).</p> <p>Returns the socket associated with the default namespace (&ldquo;/&rdquo;).</p>
</div> </div>
<div class="declaration"> <div class="declaration">
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">defaultSocket</span><span class="p">:</span> <span class="nf">SocketIOClient</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">defaultSocket</span><span class="p">:</span> <span class="kt"><a href="../Classes/SocketIOClient.html">SocketIOClient</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -255,9 +298,9 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)engine"></a> <a name="/s:8SocketIO0A11ManagerSpecP6engineAA0a6EngineD0_pSgvp"></a>
<a name="//apple_ref/swift/Property/engine" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/engine" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)engine">engine</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP6engineAA0a6EngineD0_pSgvp">engine</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -272,7 +315,7 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">engine</span><span class="p">:</span> <span class="nf">SocketEngineSpec</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">engine</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SocketEngineSpec.html">SocketEngineSpec</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -282,9 +325,9 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)forceNew"></a> <a name="/s:8SocketIO0A11ManagerSpecP8forceNewSbvp"></a>
<a name="//apple_ref/swift/Property/forceNew" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/forceNew" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)forceNew">forceNew</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP8forceNewSbvp">forceNew</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -299,7 +342,7 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">forceNew</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">forceNew</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -309,9 +352,9 @@ or call one of the <code>disconnectSocket</code> methods on this class.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)handleQueue"></a> <a name="/s:8SocketIO0A11ManagerSpecP11handleQueueSo17OS_dispatch_queueCvp"></a>
<a name="//apple_ref/swift/Property/handleQueue" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/handleQueue" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)handleQueue">handleQueue</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP11handleQueueSo17OS_dispatch_queueCvp">handleQueue</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -327,7 +370,7 @@ called on.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">handleQueue</span><span class="p">:</span> <span class="nf">DispatchQueue</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">handleQueue</span><span class="p">:</span> <span class="kt">DispatchQueue</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -337,9 +380,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)nsps"></a> <a name="/s:8SocketIO0A11ManagerSpecP4nspsSDySSAA0A8IOClientCGvp"></a>
<a name="//apple_ref/swift/Property/nsps" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/nsps" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)nsps">nsps</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP4nspsSDySSAA0A8IOClientCGvp">nsps</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -364,9 +407,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnects"></a> <a name="/s:8SocketIO0A11ManagerSpecP10reconnectsSbvp"></a>
<a name="//apple_ref/swift/Property/reconnects" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/reconnects" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnects">reconnects</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP10reconnectsSbvp">reconnects</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -381,7 +424,7 @@ called on.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">reconnects</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">reconnects</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -391,9 +434,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnectWait"></a> <a name="/s:8SocketIO0A11ManagerSpecP13reconnectWaitSivp"></a>
<a name="//apple_ref/swift/Property/reconnectWait" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/reconnectWait" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnectWait">reconnectWait</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP13reconnectWaitSivp">reconnectWait</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -408,7 +451,7 @@ called on.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">reconnectWait</span><span class="p">:</span> <span class="nf">Int</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">reconnectWait</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -418,9 +461,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnectWaitMax"></a> <a name="/s:8SocketIO0A11ManagerSpecP16reconnectWaitMaxSivp"></a>
<a name="//apple_ref/swift/Property/reconnectWaitMax" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/reconnectWaitMax" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)reconnectWaitMax">reconnectWaitMax</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP16reconnectWaitMaxSivp">reconnectWaitMax</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -435,7 +478,7 @@ called on.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">reconnectWaitMax</span><span class="p">:</span> <span class="nf">Int</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">reconnectWaitMax</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -445,9 +488,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)randomizationFactor"></a> <a name="/s:8SocketIO0A11ManagerSpecP19randomizationFactorSdvp"></a>
<a name="//apple_ref/swift/Property/randomizationFactor" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/randomizationFactor" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)randomizationFactor">randomizationFactor</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP19randomizationFactorSdvp">randomizationFactor</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -462,7 +505,7 @@ called on.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">randomizationFactor</span><span class="p">:</span> <span class="nf">Double</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">randomizationFactor</span><span class="p">:</span> <span class="kt">Double</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -472,9 +515,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)socketURL"></a> <a name="/s:8SocketIO0A11ManagerSpecP9socketURL10Foundation0F0Vvp"></a>
<a name="//apple_ref/swift/Property/socketURL" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/socketURL" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)socketURL">socketURL</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP9socketURL10Foundation0F0Vvp">socketURL</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -489,7 +532,7 @@ called on.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">socketURL</span><span class="p">:</span> <span class="nf">URL</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -499,9 +542,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)status"></a> <a name="/s:8SocketIO0A11ManagerSpecP6statusAA0A8IOStatusOvp"></a>
<a name="//apple_ref/swift/Property/status" class="dashAnchor"></a> <a name="//apple_ref/swift/Property/status" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(py)status">status</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP6statusAA0A8IOStatusOvp">status</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -516,7 +559,7 @@ called on.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">status</span><span class="p">:</span> <span class="nf">SocketIOStatus</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">status</span><span class="p">:</span> <span class="kt"><a href="../Enums/SocketIOStatus.html">SocketIOStatus</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -529,17 +572,19 @@ called on.</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)connect"></a> <a name="/s:8SocketIO0A11ManagerSpecP7connectyyF"></a>
<a name="//apple_ref/swift/Method/connect()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/connect()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)connect">connect()</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP7connectyyF">connect()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -564,9 +609,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)connectSocket:"></a> <a name="/s:8SocketIO0A11ManagerSpecP07connectA0_11withPayloadyAA0A8IOClientC_SDySSypGSgtF"></a>
<a name="//apple_ref/swift/Method/connectSocket(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/connectSocket(_:withPayload:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)connectSocket:">connectSocket(_:)</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP07connectA0_11withPayloadyAA0A8IOClientC_SDySSypGSgtF">connectSocket(_:<wbr>withPayload:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -581,7 +626,7 @@ called on.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">connectSocket</span><span class="p">(</span><span class="n">_</span> <span class="nv">socket</span><span class="p">:</span> <span class="kt"><a href="../Classes/SocketIOClient.html">SocketIOClient</a></span><span class="p">)</span></code></pre> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">connectSocket</span><span class="p">(</span><span class="n">_</span> <span class="nv">socket</span><span class="p">:</span> <span class="kt"><a href="../Classes/SocketIOClient.html">SocketIOClient</a></span><span class="p">,</span> <span class="nv">withPayload</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?)</span></code></pre>
</div> </div>
</div> </div>
@ -601,6 +646,18 @@ called on.</p>
</div> </div>
</td> </td>
</tr> </tr>
<tr>
<td>
<code>
<em>withPayload</em>
</code>
</td>
<td>
<div>
<p>Optional payload to send on connect</p>
</div>
</td>
</tr>
</tbody> </tbody>
</table> </table>
</div> </div>
@ -610,9 +667,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)didDisconnectWithReason:"></a> <a name="/s:8SocketIO0A11ManagerSpecP13didDisconnect6reasonySS_tF"></a>
<a name="//apple_ref/swift/Method/didDisconnect(reason:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/didDisconnect(reason:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)didDisconnectWithReason:">didDisconnect(reason:)</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP13didDisconnect6reasonySS_tF">didDisconnect(reason:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -656,9 +713,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnect"></a> <a name="/s:8SocketIO0A11ManagerSpecP10disconnectyyF"></a>
<a name="//apple_ref/swift/Method/disconnect()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/disconnect()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnect">disconnect()</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP10disconnectyyF">disconnect()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -683,9 +740,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnectSocket:"></a> <a name="/s:8SocketIO0A11ManagerSpecP010disconnectA0yyAA0A8IOClientCF"></a>
<a name="//apple_ref/swift/Method/disconnectSocket(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/disconnectSocket(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnectSocket:">disconnectSocket(_:)</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP010disconnectA0yyAA0A8IOClientCF">disconnectSocket(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -729,9 +786,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnectSocketForNamespace:"></a> <a name="/s:8SocketIO0A11ManagerSpecP010disconnectA012forNamespaceySS_tF"></a>
<a name="//apple_ref/swift/Method/disconnectSocket(forNamespace:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/disconnectSocket(forNamespace:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)disconnectSocketForNamespace:">disconnectSocket(forNamespace:)</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP010disconnectA012forNamespaceySS_tF">disconnectSocket(forNamespace:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -775,9 +832,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)emitAll:withItems:"></a> <a name="/s:8SocketIO0A11ManagerSpecP7emitAllyySS_AA0A4Data_pdtF"></a>
<a name="//apple_ref/swift/Method/emitAll(_:withItems:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/emitAll(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)emitAll:withItems:">emitAll(_:withItems:)</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP7emitAllyySS_AA0A4Data_pdtF">emitAll(_:<wbr>_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -792,7 +849,7 @@ called on.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">emitAll</span><span class="p">(</span><span class="n">_</span> <span class="nv">event</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">withItems</span> <span class="nv">items</span><span class="p">:</span> <span class="p">[</span><span class="kt">Any</span><span class="p">])</span></code></pre> <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">emitAll</span><span class="p">(</span><span class="n">_</span> <span class="nv">event</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">_</span> <span class="nv">items</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SocketData.html">SocketData</a></span><span class="o">...</span><span class="p">)</span></code></pre>
</div> </div>
</div> </div>
@ -833,9 +890,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)reconnect"></a> <a name="/s:8SocketIO0A11ManagerSpecP9reconnectyyF"></a>
<a name="//apple_ref/swift/Method/reconnect()" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/reconnect()" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)reconnect">reconnect()</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP9reconnectyyF">reconnect()</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -862,9 +919,9 @@ called on.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)removeSocket:"></a> <a name="/s:8SocketIO0A11ManagerSpecP06removeA0yAA0A8IOClientCSgAFF"></a>
<a name="//apple_ref/swift/Method/removeSocket(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/removeSocket(_:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)removeSocket:">removeSocket(_:)</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP06removeA0yAA0A8IOClientCSgAFF">removeSocket(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -914,9 +971,9 @@ After calling this method the socket should no longer be considered usable.</p>
<li class="item"> <li class="item">
<div> <div>
<code> <code>
<a name="/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)socketForNamespace:"></a> <a name="/s:8SocketIO0A11ManagerSpecP6socket12forNamespaceAA0A8IOClientCSS_tF"></a>
<a name="//apple_ref/swift/Method/socket(forNamespace:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/socket(forNamespace:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@SocketIO@objc(pl)SocketManagerSpec(im)socketForNamespace:">socket(forNamespace:)</a> <a class="token" href="#/s:8SocketIO0A11ManagerSpecP6socket12forNamespaceAA0A8IOClientCSS_tF">socket(forNamespace:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -930,7 +987,7 @@ After calling this method the socket should no longer be considered usable.</p>
<p>Sockets created from this method are retained by the manager. <p>Sockets created from this method are retained by the manager.
Call one of the <code>disconnectSocket</code> methods on the implementing class to remove the socket from manager control. Call one of the <code>disconnectSocket</code> methods on the implementing class to remove the socket from manager control.
Or call <code><a href="../Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)SocketIOClient(im)disconnect">SocketIOClient.disconnect()</a></code> on the client.</p> Or call <code><a href="../Classes/SocketIOClient.html#/s:8SocketIO0A8IOClientC10disconnectyyF">SocketIOClient.disconnect()</a></code> on the client.</p>
</div> </div>
<div class="declaration"> <div class="declaration">
@ -975,8 +1032,8 @@ Or call <code><a href="../Classes/SocketIOClient.html#/c:@M@SocketIO@objc(cs)Soc
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

219
docs/Protocols/SocketParsable.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketParsable</h1> <h1>SocketParsable</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketParsable</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">SocketParsable</span> <span class="p">:</span> <span class="kt">AnyObject</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -213,11 +257,8 @@
<code> <code>
<a name="/s:8SocketIO0A8ParsableP15parseBinaryDatayAA0A6PacketVSg10Foundation0F0VF"></a> <a name="/s:8SocketIO0A8ParsableP15parseBinaryDatayAA0A6PacketVSg10Foundation0F0VF"></a>
<a name="//apple_ref/swift/Method/parseBinaryData(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/parseBinaryData(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A8ParsableP15parseBinaryDatayAA0A6PacketVSg10Foundation0F0VF">parseBinaryData(_:)</a> <a class="token" href="#/s:8SocketIO0A8ParsableP15parseBinaryDatayAA0A6PacketVSg10Foundation0F0VF">parseBinaryData(_:<wbr>)</a>
</code> </code>
<span class="declaration-note">
Default implementation
</span>
</div> </div>
<div class="height-container"> <div class="height-container">
<div class="pointer-container"></div> <div class="pointer-container"></div>
@ -226,15 +267,6 @@
<div class="abstract"> <div class="abstract">
<p>Called when the engine has received some binary data that should be attached to a packet.</p> <p>Called when the engine has received some binary data that should be attached to a packet.</p>
<p>Packets binary data should be sent directly after the packet that expects it, so there&rsquo;s confusion over
where the data should go. Data should be received in the order it is sent, so that the correct data is put
into the correct placeholder.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
<p>Called when the engine has received some binary data that should be attached to a packet.</p>
<p>Packets binary data should be sent directly after the packet that expects it, so there&rsquo;s confusion over <p>Packets binary data should be sent directly after the packet that expects it, so there&rsquo;s confusion over
where the data should go. Data should be received in the order it is sent, so that the correct data is put where the data should go. Data should be received in the order it is sent, so that the correct data is put
into the correct placeholder.</p> into the correct placeholder.</p>
@ -275,11 +307,8 @@ into the correct placeholder.</p>
<code> <code>
<a name="/s:8SocketIO0A8ParsableP05parseA7MessageyAA0A6PacketVSgSSF"></a> <a name="/s:8SocketIO0A8ParsableP05parseA7MessageyAA0A6PacketVSgSSF"></a>
<a name="//apple_ref/swift/Method/parseSocketMessage(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/parseSocketMessage(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A8ParsableP05parseA7MessageyAA0A6PacketVSgSSF">parseSocketMessage(_:)</a> <a class="token" href="#/s:8SocketIO0A8ParsableP05parseA7MessageyAA0A6PacketVSgSSF">parseSocketMessage(_:<wbr>)</a>
</code> </code>
<span class="declaration-note">
Default implementation
</span>
</div> </div>
<div class="height-container"> <div class="height-container">
<div class="pointer-container"></div> <div class="pointer-container"></div>
@ -288,11 +317,6 @@ into the correct placeholder.</p>
<div class="abstract"> <div class="abstract">
<p>Called when the engine has received a string that should be parsed into a socket.io packet.</p> <p>Called when the engine has received a string that should be parsed into a socket.io packet.</p>
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
<p>Called when the engine has received a string that should be parsed into a socket.io packet.</p>
</div> </div>
<div class="declaration"> <div class="declaration">
<h4>Declaration</h4> <h4>Declaration</h4>
@ -330,14 +354,145 @@ into the correct placeholder.</p>
</li> </li>
</ul> </ul>
</div> </div>
<div class="task-group">
<div class="task-name-container">
<a name="/Available%20where%20%60Self%60%3A%20%60SocketManagerSpec%60%20%26%20%60SocketDataBufferable%60"></a>
<a name="//apple_ref/swift/Section/Available where `Self`: `SocketManagerSpec` &amp; `SocketDataBufferable`" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/Available%20where%20%60Self%60%3A%20%60SocketManagerSpec%60%20%26%20%60SocketDataBufferable%60"></a>
<h3 class="section-name"><p>Available where <code>Self</code>: <code><a href="../Protocols/SocketManagerSpec.html">SocketManagerSpec</a></code> &amp; <code><a href="../Protocols/SocketDataBufferable.html">SocketDataBufferable</a></code></p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:8SocketIO0A8ParsablePA2A0A14DataBufferableRzAA0A11ManagerSpecRzrlE05parseA7MessageyAA0A6PacketVSgSSF"></a>
<a name="//apple_ref/swift/Method/parseSocketMessage(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A8ParsablePA2A0A14DataBufferableRzAA0A11ManagerSpecRzrlE05parseA7MessageyAA0A6PacketVSgSSF">parseSocketMessage(_:<wbr>)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
<p>Called when the engine has received a string that should be parsed into a socket.io packet.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">parseSocketMessage</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/SocketPacket.html">SocketPacket</a></span><span class="p">?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>message</em>
</code>
</td>
<td>
<div>
<p>The string that needs parsing.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A completed socket packet or nil if the packet is invalid.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8SocketIO0A8ParsablePA2A0A14DataBufferableRzAA0A11ManagerSpecRzrlE011parseBinaryD0yAA0A6PacketVSg10Foundation0D0VF"></a>
<a name="//apple_ref/swift/Method/parseBinaryData(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A8ParsablePA2A0A14DataBufferableRzAA0A11ManagerSpecRzrlE011parseBinaryD0yAA0A6PacketVSg10Foundation0D0VF">parseBinaryData(_:<wbr>)</a>
</code>
<span class="declaration-note">
Default implementation
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</div>
<h4>Default Implementation</h4>
<div class="default_impl abstract">
<p>Called when the engine has received some binary data that should be attached to a packet.</p>
<p>Packets binary data should be sent directly after the packet that expects it, so there&rsquo;s confusion over
where the data should go. Data should be received in the order it is sent, so that the correct data is put
into the correct placeholder.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">parseBinaryData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/SocketPacket.html">SocketPacket</a></span><span class="p">?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>data</em>
</code>
</td>
<td>
<div>
<p>The data that should be attached to a packet.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A completed socket packet if there is no more data left to collect.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
</div> </div>
</section> </section>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

63
docs/Structs.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="index.html"> <a class="header-link" href="index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="12to13.html">12to13</a> <a class="nav-group-task-link" href="12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="faq.html">FAQ</a> <a class="nav-group-task-link" href="faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a> <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,7 +225,7 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>Structures</h1> <h1>Structures</h1>
<p>The following structures are available globally.</p> <p>The following structures are available globally.</p>
@ -223,10 +264,6 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -255,10 +292,6 @@
</section> </section>
</div> </div>
</li> </li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item"> <li class="item">
<div> <div>
<code> <code>
@ -295,8 +328,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

74
docs/Structs/SocketEventHandler.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketEventHandler</h1> <h1>SocketEventHandler</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SocketEventHandler</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SocketEventHandler</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -295,9 +339,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -305,7 +351,7 @@
<code> <code>
<a name="/s:8SocketIO0A12EventHandlerV15executeCallback4with0G3Ack0gA0ySayypG_SiAA0A8IOClientCtF"></a> <a name="/s:8SocketIO0A12EventHandlerV15executeCallback4with0G3Ack0gA0ySayypG_SiAA0A8IOClientCtF"></a>
<a name="//apple_ref/swift/Method/executeCallback(with:withAck:withSocket:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/executeCallback(with:withAck:withSocket:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A12EventHandlerV15executeCallback4with0G3Ack0gA0ySayypG_SiAA0A8IOClientCtF">executeCallback(with:withAck:withSocket:)</a> <a class="token" href="#/s:8SocketIO0A12EventHandlerV15executeCallback4with0G3Ack0gA0ySayypG_SiAA0A8IOClientCtF">executeCallback(with:<wbr>withAck:<wbr>withSocket:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -378,8 +424,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

112
docs/Structs/SocketIOClientConfiguration.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketIOClientConfiguration</h1> <h1>SocketIOClientConfiguration</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SocketIOClientConfiguration</span> <span class="p">:</span> <span class="kt">ExpressibleByArrayLiteral</span><span class="p">,</span> <span class="kt">Collection</span><span class="p">,</span> <span class="kt">MutableCollection</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SocketIOClientConfiguration</span> <span class="p">:</span> <span class="kt">ExpressibleByArrayLiteral</span><span class="p">,</span> <span class="kt">Collection</span><span class="p">,</span> <span class="kt">MutableCollection</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Typealiases"></a> <a name="/Typealiases"></a>
<a name="//apple_ref/swift/Section/Typealiases" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Typealiases" class="dashAnchor"></a>
<a href="#/Typealiases"> <div class="section-name-container">
<h3 class="section-name">Typealiases</h3> <a class="section-name-link" href="#/Typealiases"></a>
</a> <h3 class="section-name"><p>Typealiases</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -322,9 +366,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -347,7 +393,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">startIndex</span><span class="p">:</span> <span class="nf">Index</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">startIndex</span><span class="p">:</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa">Index</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -374,7 +420,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">endIndex</span><span class="p">:</span> <span class="nf">Index</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">endIndex</span><span class="p">:</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa">Index</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -401,7 +447,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isEmpty</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isEmpty</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -428,7 +474,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">count</span><span class="p">:</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa">Index</a></span><span class="o">.</span><span class="nf">Stride</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">count</span><span class="p">:</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa">Index</a></span><span class="o">.</span><span class="kt">Stride</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -455,7 +501,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">first</span><span class="p">:</span> <span class="nf">Element</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">first</span><span class="p">:</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV7Elementa">Element</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -467,7 +513,7 @@
<code> <code>
<a name="/s:Sly7ElementQz5IndexQzcip"></a> <a name="/s:Sly7ElementQz5IndexQzcip"></a>
<a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:Sly7ElementQz5IndexQzcip">subscript(_:)</a> <a class="token" href="#/s:Sly7ElementQz5IndexQzcip">subscript(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -481,7 +527,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">position</span><span class="p">:</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa">Index</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nf">Element</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">position</span><span class="p">:</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa">Index</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV7Elementa">Element</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -493,7 +539,7 @@
<code> <code>
<a name="/s:Sly11SubSequenceQzSny5IndexQzGcip"></a> <a name="/s:Sly11SubSequenceQzSny5IndexQzGcip"></a>
<a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/subscript(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:Sly11SubSequenceQzSny5IndexQzGcip">subscript(_:)</a> <a class="token" href="#/s:Sly11SubSequenceQzSny5IndexQzGcip">subscript(_:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -507,7 +553,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">bounds</span><span class="p">:</span> <span class="kt">Range</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa">Index</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nf">SubSequence</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">subscript</span><span class="p">(</span><span class="nv">bounds</span><span class="p">:</span> <span class="kt">Range</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV5Indexa">Index</a></span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Structs/SocketIOClientConfiguration.html#/s:8SocketIO0A21IOClientConfigurationV11SubSequencea">SubSequence</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -520,9 +566,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Initializers"></a> <a name="/Initializers"></a>
<a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a>
<a href="#/Initializers"> <div class="section-name-container">
<h3 class="section-name">Initializers</h3> <a class="section-name-link" href="#/Initializers"></a>
</a> <h3 class="section-name"><p>Initializers</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -530,7 +578,7 @@
<code> <code>
<a name="/s:8SocketIO0A21IOClientConfigurationV12arrayLiteralAcA0aC6OptionOd_tcfc"></a> <a name="/s:8SocketIO0A21IOClientConfigurationV12arrayLiteralAcA0aC6OptionOd_tcfc"></a>
<a name="//apple_ref/swift/Method/init(arrayLiteral:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/init(arrayLiteral:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A21IOClientConfigurationV12arrayLiteralAcA0aC6OptionOd_tcfc">init(arrayLiteral:)</a> <a class="token" href="#/s:8SocketIO0A21IOClientConfigurationV12arrayLiteralAcA0aC6OptionOd_tcfc">init(arrayLiteral:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -577,9 +625,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Methods"></a> <a name="/Methods"></a>
<a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Methods" class="dashAnchor"></a>
<a href="#/Methods"> <div class="section-name-container">
<h3 class="section-name">Methods</h3> <a class="section-name-link" href="#/Methods"></a>
</a> <h3 class="section-name"><p>Methods</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -618,7 +668,7 @@
<code> <code>
<a name="/s:8SocketIO0A21IOClientConfigurationV5index5afterS2i_tF"></a> <a name="/s:8SocketIO0A21IOClientConfigurationV5index5afterS2i_tF"></a>
<a name="//apple_ref/swift/Method/index(after:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/index(after:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A21IOClientConfigurationV5index5afterS2i_tF">index(after:)</a> <a class="token" href="#/s:8SocketIO0A21IOClientConfigurationV5index5afterS2i_tF">index(after:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -648,7 +698,7 @@
<code> <code>
<a name="/s:8SocketIO0A21IOClientConfigurationV6insert_9replacingyAA0aC6OptionO_SbtF"></a> <a name="/s:8SocketIO0A21IOClientConfigurationV6insert_9replacingyAA0aC6OptionO_SbtF"></a>
<a name="//apple_ref/swift/Method/insert(_:replacing:)" class="dashAnchor"></a> <a name="//apple_ref/swift/Method/insert(_:replacing:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SocketIO0A21IOClientConfigurationV6insert_9replacingyAA0aC6OptionO_SbtF">insert(_:replacing:)</a> <a class="token" href="#/s:8SocketIO0A21IOClientConfigurationV6insert_9replacingyAA0aC6OptionO_SbtF">insert(_:<wbr>replacing:<wbr>)</a>
</code> </code>
</div> </div>
<div class="height-container"> <div class="height-container">
@ -709,8 +759,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

86
docs/Structs/SocketPacket.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../index.html"> <a class="header-link" href="../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../12to13.html">12to13</a> <a class="nav-group-task-link" href="../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../faq.html">FAQ</a> <a class="nav-group-task-link" href="../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>SocketPacket</h1> <h1>SocketPacket</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SocketPacket</span> <span class="p">:</span> <span class="kt">CustomStringConvertible</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">SocketPacket</span> <span class="p">:</span> <span class="kt">CustomStringConvertible</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -309,9 +353,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">binary</span><span class="p">:</span> <span class="p">[</span><span class="kt">Data</span><span class="p">]</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">binary</span><span class="p">:</span> <span class="p">[</span><span class="kt">Data</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -341,9 +383,7 @@ event type packets.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">data</span><span class="p">:</span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">data</span><span class="p">:</span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<span class="k">get</span>
<span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -397,7 +437,7 @@ event type packets.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -424,7 +464,7 @@ event type packets.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">event</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">event</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -451,7 +491,7 @@ event type packets.</p>
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">packetString</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">packetString</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -464,9 +504,11 @@ event type packets.</p>
<div class="task-name-container"> <div class="task-name-container">
<a name="/PacketType%20enum"></a> <a name="/PacketType%20enum"></a>
<a name="//apple_ref/swift/Section/PacketType enum" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/PacketType enum" class="dashAnchor"></a>
<a href="#/PacketType%20enum"> <div class="section-name-container">
<h3 class="section-name">PacketType enum</h3> <a class="section-name-link" href="#/PacketType%20enum"></a>
</a> <h3 class="section-name"><p>PacketType enum</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -505,8 +547,8 @@ event type packets.</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

74
docs/Structs/SocketPacket/PacketType.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="../../index.html"> <a class="header-link" href="../../index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../../12to13.html">12to13</a> <a class="nav-group-task-link" href="../../12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../../faq.html">FAQ</a> <a class="nav-group-task-link" href="../../faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="../../Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="../../Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="../../Protocols.html">Protocols</a> <a class="nav-group-name-link" href="../../Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,10 +225,11 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>PacketType</h1> <h1>PacketType</h1>
<div class="declaration"> <div class="declaration">
<div class="language"> <div class="language">
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">PacketType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre> <pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">PacketType</span> <span class="p">:</span> <span class="kt">Int</span></code></pre>
</div> </div>
@ -203,9 +245,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Cases"></a> <a name="/Cases"></a>
<a name="//apple_ref/swift/Section/Cases" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Cases" class="dashAnchor"></a>
<a href="#/Cases"> <div class="section-name-container">
<h3 class="section-name">Cases</h3> <a class="section-name-link" href="#/Cases"></a>
</a> <h3 class="section-name"><p>Cases</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -403,9 +447,11 @@
<div class="task-name-container"> <div class="task-name-container">
<a name="/Properties"></a> <a name="/Properties"></a>
<a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a> <a name="//apple_ref/swift/Section/Properties" class="dashAnchor"></a>
<a href="#/Properties"> <div class="section-name-container">
<h3 class="section-name">Properties</h3> <a class="section-name-link" href="#/Properties"></a>
</a> <h3 class="section-name"><p>Properties</p>
</h3>
</div>
</div> </div>
<ul class="item-container"> <ul class="item-container">
<li class="item"> <li class="item">
@ -428,7 +474,7 @@
<h4>Declaration</h4> <h4>Declaration</h4>
<div class="language"> <div class="language">
<p class="aside-title">Swift</p> <p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isBinary</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isBinary</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
</div> </div>
</div> </div>
@ -443,8 +489,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

55
docs/Typealiases.html
View File

@ -21,7 +21,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="index.html"> <a class="header-link" href="index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -50,6 +50,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="12to13.html">12to13</a> <a class="nav-group-task-link" href="12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="faq.html">FAQ</a> <a class="nav-group-task-link" href="faq.html">FAQ</a>
</li> </li>
@ -61,9 +64,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -110,6 +110,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a> <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -184,7 +225,7 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h1>Type Aliases</h1> <h1>Type Aliases</h1>
<p>The following type aliases are available globally.</p> <p>The following type aliases are available globally.</p>
@ -284,8 +325,8 @@
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

45
docs/css/jazzy.css
View File

@ -63,6 +63,10 @@ a {
a:hover, a:focus { a:hover, a:focus {
outline: 0; outline: 0;
text-decoration: underline; } text-decoration: underline; }
a.discouraged {
text-decoration: line-through; }
a.discouraged:hover, a.discouraged:focus {
text-decoration: underline line-through; }
table { table {
background: #fff; background: #fff;
@ -90,10 +94,10 @@ pre {
code { code {
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; }
p > code, li > code { .item-container p > code, .item-container li > code, .top-matter p > code, .top-matter li > code {
background: #f7f7f7; background: #f7f7f7;
padding: .2em; } padding: .2em; }
p > code:before, p > code:after, li > code:before, li > code:after { .item-container p > code:before, .item-container p > code:after, .item-container li > code:before, .item-container li > code:after, .top-matter p > code:before, .top-matter p > code:after, .top-matter li > code:before, .top-matter li > code:after {
letter-spacing: -.2em; letter-spacing: -.2em;
content: "\00a0"; } content: "\00a0"; }
@ -107,7 +111,6 @@ pre code {
@media (min-width: 768px) { @media (min-width: 768px) {
.content-wrapper { .content-wrapper {
flex-direction: row; } } flex-direction: row; } }
.header { .header {
display: flex; display: flex;
padding: 8px; padding: 8px;
@ -153,7 +156,6 @@ pre code {
word-wrap: normal; word-wrap: normal;
background: #fbfbfb; background: #fbfbfb;
border-right: 1px solid #ddd; } } border-right: 1px solid #ddd; } }
.nav-groups { .nav-groups {
list-style-type: none; list-style-type: none;
padding-left: 0; } padding-left: 0; }
@ -184,7 +186,6 @@ pre code {
order: 2; order: 2;
flex: 1; flex: 1;
padding-bottom: 60px; } } padding-bottom: 60px; } }
.section { .section {
padding: 0 32px; padding: 0 32px;
border-bottom: 1px solid #ddd; } border-bottom: 1px solid #ddd; }
@ -197,6 +198,8 @@ pre code {
.section-name { .section-name {
color: #666; color: #666;
display: block; } display: block; }
.section-name p {
margin-bottom: inherit; }
.declaration .highlight { .declaration .highlight {
overflow-x: initial; overflow-x: initial;
@ -215,6 +218,22 @@ pre code {
content: ""; content: "";
display: block; } display: block; }
.section-name-container {
position: relative; }
.section-name-container .section-name-link {
position: absolute;
top: 0;
left: 0;
bottom: 0;
right: 0;
margin-bottom: 0; }
.section-name-container .section-name {
position: relative;
pointer-events: none;
z-index: 1; }
.section-name-container .section-name a {
pointer-events: auto; }
.item-container { .item-container {
padding: 0; } padding: 0; }
@ -225,9 +244,11 @@ pre code {
.item a[name]:before { .item a[name]:before {
content: ""; content: "";
display: block; } display: block; }
.item .token { .item .token, .item .direct-link {
display: inline-block;
text-indent: -20px;
padding-left: 3px; padding-left: 3px;
margin-left: 0px; margin-left: 20px;
font-size: 1rem; } font-size: 1rem; }
.item .declaration-note { .item .declaration-note {
font-size: .85em; font-size: .85em;
@ -287,9 +308,9 @@ pre code {
.language .aside-title { .language .aside-title {
color: #4183c4; } color: #4183c4; }
.aside-warning { .aside-warning, .aside-deprecated, .aside-unavailable {
border-left: 5px solid #ff6666; } border-left: 5px solid #ff6666; }
.aside-warning .aside-title { .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title {
color: #ff0000; } color: #ff0000; }
.graybox { .graybox {
@ -325,6 +346,7 @@ pre code {
html.dash .header, html.dash .breadcrumbs, html.dash .navigation { html.dash .header, html.dash .breadcrumbs, html.dash .navigation {
display: none; } display: none; }
html.dash .height-container { html.dash .height-container {
display: block; } display: block; }
@ -338,14 +360,17 @@ form[role=search] input {
border-radius: 1em; } border-radius: 1em; }
.loading form[role=search] input { .loading form[role=search] input {
background: white url(../img/spinner.gif) center right 4px no-repeat; } background: white url(../img/spinner.gif) center right 4px no-repeat; }
form[role=search] .tt-menu { form[role=search] .tt-menu {
margin: 0; margin: 0;
min-width: 300px; min-width: 300px;
background: #fbfbfb; background: #fbfbfb;
color: #333; color: #333;
border: 1px solid #ddd; } border: 1px solid #ddd; }
form[role=search] .tt-highlight { form[role=search] .tt-highlight {
font-weight: bold; } font-weight: bold; }
form[role=search] .tt-suggestion { form[role=search] .tt-suggestion {
font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif;
padding: 0 8px; } padding: 0 8px; }
@ -358,11 +383,13 @@ form[role=search] .tt-suggestion {
font-weight: normal; font-weight: normal;
font-size: 0.9em; font-size: 0.9em;
padding-left: 16px; } padding-left: 16px; }
form[role=search] .tt-suggestion:hover, form[role=search] .tt-suggestion:hover,
form[role=search] .tt-suggestion.tt-cursor { form[role=search] .tt-suggestion.tt-cursor {
cursor: pointer; cursor: pointer;
background-color: #4183c4; background-color: #4183c4;
color: #fff; } color: #fff; }
form[role=search] .tt-suggestion:hover .doc-parent-name, form[role=search] .tt-suggestion:hover .doc-parent-name,
form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { form[role=search] .tt-suggestion.tt-cursor .doc-parent-name {
color: #fff; } color: #fff; }

63
docs/faq.html
View File

@ -20,7 +20,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="index.html"> <a class="header-link" href="index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -49,6 +49,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="12to13.html">12to13</a> <a class="nav-group-task-link" href="12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="faq.html">FAQ</a> <a class="nav-group-task-link" href="faq.html">FAQ</a>
</li> </li>
@ -60,9 +63,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -109,6 +109,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a> <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -183,7 +224,7 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<h2 id='how-do-i-connect-to-my-websocket-server' class='heading'>How do I connect to my WebSocket server?</h2> <h2 id='how-do-i-connect-to-my-websocket-server' class='heading'>How do I connect to my WebSocket server?</h2>
@ -197,9 +238,9 @@ for Objective-C.</p>
<a href="https://developer.apple.com/library/content/documentation/Swift/Conceptual/Swift_Programming_Language/AutomaticReferenceCounting.html">ARC</a>.</p> <a href="https://developer.apple.com/library/content/documentation/Swift/Conceptual/Swift_Programming_Language/AutomaticReferenceCounting.html">ARC</a>.</p>
<p>Take this code for example:</p> <p>Take this code for example:</p>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="nf">Manager</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">Manager</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">addHandlers</span><span class="p">()</span> <span class="p">{</span> <span class="kd">func</span> <span class="nf">addHandlers</span><span class="p">()</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="nf">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="nf">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="s">"http://somesocketioserver.com"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span> <span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="kt">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="s">"http://somesocketioserver.com"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span>
<span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span><span class="o">.</span><span class="nf">on</span><span class="p">(</span><span class="s">"myEvent"</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span><span class="p">,</span> <span class="n">ack</span> <span class="k">in</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span><span class="o">.</span><span class="nf">on</span><span class="p">(</span><span class="s">"myEvent"</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span><span class="p">,</span> <span class="n">ack</span> <span class="k">in</span>
<span class="nf">print</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="nf">print</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
@ -213,8 +254,8 @@ for Objective-C.</p>
will be released, along with the socket, and its memory reclaimed.</p> will be released, along with the socket, and its memory reclaimed.</p>
<p>A correct way would be:</p> <p>A correct way would be:</p>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="nf">Manager</span> <span class="p">{</span> <pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">Manager</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="nf">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="nf">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="s">"http://somesocketioserver.com"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span> <span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="kt">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="s">"http://somesocketioserver.com"</span><span class="p">)</span><span class="o">!</span><span class="p">)</span>
<span class="kd">func</span> <span class="nf">addHandlers</span><span class="p">()</span> <span class="p">{</span> <span class="kd">func</span> <span class="nf">addHandlers</span><span class="p">()</span> <span class="p">{</span>
<span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span><span class="o">.</span><span class="nf">on</span><span class="p">(</span><span class="s">"myEvent"</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span><span class="p">,</span> <span class="n">ack</span> <span class="k">in</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span><span class="o">.</span><span class="nf">on</span><span class="p">(</span><span class="s">"myEvent"</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span><span class="p">,</span> <span class="n">ack</span> <span class="k">in</span>
@ -232,8 +273,8 @@ will be released, along with the socket, and its memory reclaimed.</p>
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

104
docs/index.html
View File

@ -20,7 +20,7 @@
<header class="header"> <header class="header">
<p class="header-col header-col--primary"> <p class="header-col header-col--primary">
<a class="header-link" href="index.html"> <a class="header-link" href="index.html">
SocketIO Docs SocketIO 16.0.0-beta2 Docs
</a> </a>
(100% documented) (100% documented)
</p> </p>
@ -49,6 +49,9 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="12to13.html">12to13</a> <a class="nav-group-task-link" href="12to13.html">12to13</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="15to16.html">15to16</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="faq.html">FAQ</a> <a class="nav-group-task-link" href="faq.html">FAQ</a>
</li> </li>
@ -60,9 +63,6 @@
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a> <a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
</li> </li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
</li>
<li class="nav-group-task"> <li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a> <a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
</li> </li>
@ -109,6 +109,47 @@
</li> </li>
</ul> </ul>
</li> </li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
</li>
</ul>
</li>
<li class="nav-group-name"> <li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a> <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks"> <ul class="nav-group-tasks">
@ -183,7 +224,7 @@
<article class="main-content"> <article class="main-content">
<section class="section"> <section class="section">
<div class="section-content"> <div class="section-content top-matter">
<p><a href="https://travis-ci.org/socketio/socket.io-client-swift"><img src="https://travis-ci.org/socketio/socket.io-client-swift.svg?branch=master" alt="Build Status"></a></p> <p><a href="https://travis-ci.org/socketio/socket.io-client-swift"><img src="https://travis-ci.org/socketio/socket.io-client-swift.svg?branch=master" alt="Build Status"></a></p>
<h1 id='socket-io-client-swift' class='heading'>Socket.IO-Client-Swift</h1> <h1 id='socket-io-client-swift' class='heading'>Socket.IO-Client-Swift</h1>
@ -192,7 +233,7 @@
<h2 id='example' class='heading'>Example</h2> <h2 id='example' class='heading'>Example</h2>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">SocketIO</span> <pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">SocketIO</span>
<span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="nf">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="nf">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="s">"http://localhost:8080"</span><span class="p">)</span><span class="o">!</span><span class="p">,</span> <span class="nv">config</span><span class="p">:</span> <span class="p">[</span><span class="o">.</span><span class="nf">log</span><span class="p">(</span><span class="kc">true</span><span class="p">),</span> <span class="o">.</span><span class="n">compress</span><span class="p">])</span> <span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="kt">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">(</span><span class="nv">string</span><span class="p">:</span> <span class="s">"http://localhost:8080"</span><span class="p">)</span><span class="o">!</span><span class="p">,</span> <span class="nv">config</span><span class="p">:</span> <span class="p">[</span><span class="o">.</span><span class="nf">log</span><span class="p">(</span><span class="kc">true</span><span class="p">),</span> <span class="o">.</span><span class="n">compress</span><span class="p">])</span>
<span class="k">let</span> <span class="nv">socket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span> <span class="k">let</span> <span class="nv">socket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span>
<span class="n">socket</span><span class="o">.</span><span class="nf">on</span><span class="p">(</span><span class="nv">clientEvent</span><span class="p">:</span> <span class="o">.</span><span class="n">connect</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span><span class="p">,</span> <span class="n">ack</span> <span class="k">in</span> <span class="n">socket</span><span class="o">.</span><span class="nf">on</span><span class="p">(</span><span class="nv">clientEvent</span><span class="p">:</span> <span class="o">.</span><span class="n">connect</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span><span class="p">,</span> <span class="n">ack</span> <span class="k">in</span>
@ -200,9 +241,13 @@
<span class="p">}</span> <span class="p">}</span>
<span class="n">socket</span><span class="o">.</span><span class="nf">on</span><span class="p">(</span><span class="s">"currentAmount"</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span><span class="p">,</span> <span class="n">ack</span> <span class="k">in</span> <span class="n">socket</span><span class="o">.</span><span class="nf">on</span><span class="p">(</span><span class="s">"currentAmount"</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span><span class="p">,</span> <span class="n">ack</span> <span class="k">in</span>
<span class="k">guard</span> <span class="k">let</span> <span class="nv">cur</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">Double</span> <span class="nf">else</span> <span class="p">{</span> <span class="k">return</span> <span class="p">}</span> <span class="k">guard</span> <span class="k">let</span> <span class="nv">cur</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">Double</span> <span class="k">else</span> <span class="p">{</span> <span class="k">return</span> <span class="p">}</span>
<span class="n">socket</span><span class="o">.</span><span class="nf">emitWithAck</span><span class="p">(</span><span class="s">"canUpdate"</span><span class="p">,</span> <span class="n">cur</span><span class="p">)</span><span class="o">.</span><span class="nf">timingOut</span><span class="p">(</span><span class="nv">after</span><span class="p">:</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span> <span class="k">in</span> <span class="n">socket</span><span class="o">.</span><span class="nf">emitWithAck</span><span class="p">(</span><span class="s">"canUpdate"</span><span class="p">,</span> <span class="n">cur</span><span class="p">)</span><span class="o">.</span><span class="nf">timingOut</span><span class="p">(</span><span class="nv">after</span><span class="p">:</span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span><span class="n">data</span> <span class="k">in</span>
<span class="k">if</span> <span class="n">data</span><span class="o">.</span><span class="n">first</span> <span class="k">as?</span> <span class="kt">String</span> <span class="p">??</span> <span class="s">"passed"</span> <span class="o">==</span> <span class="kt">SocketAckValue</span><span class="o">.</span><span class="n">noAck</span> <span class="p">{</span>
<span class="c1">// Handle ack timeout </span>
<span class="p">}</span>
<span class="n">socket</span><span class="o">.</span><span class="nf">emit</span><span class="p">(</span><span class="s">"update"</span><span class="p">,</span> <span class="p">[</span><span class="s">"amount"</span><span class="p">:</span> <span class="n">cur</span> <span class="o">+</span> <span class="mf">2.50</span><span class="p">])</span> <span class="n">socket</span><span class="o">.</span><span class="nf">emit</span><span class="p">(</span><span class="s">"update"</span><span class="p">,</span> <span class="p">[</span><span class="s">"amount"</span><span class="p">:</span> <span class="n">cur</span> <span class="o">+</span> <span class="mf">2.50</span><span class="p">])</span>
<span class="p">}</span> <span class="p">}</span>
@ -210,52 +255,25 @@
<span class="p">}</span> <span class="p">}</span>
<span class="n">socket</span><span class="o">.</span><span class="nf">connect</span><span class="p">()</span> <span class="n">socket</span><span class="o">.</span><span class="nf">connect</span><span class="p">()</span>
</code></pre>
<h2 id='objective-c-example' class='heading'>Objective-C Example</h2>
<pre class="highlight plaintext"><code>@import SocketIO;
NSURL* url = [[NSURL alloc] initWithString:@"http://localhost:8080"];
SocketManager* manager = [[SocketManager alloc] initWithSocketURL:url config:@{@"log": @YES, @"compress": @YES}];
SocketIOClient* socket = manager.defaultSocket;
[socket on:@"connect" callback:^(NSArray* data, SocketAckEmitter* ack) {
NSLog(@"socket connected");
}];
[socket on:@"currentAmount" callback:^(NSArray* data, SocketAckEmitter* ack) {
double cur = [[data objectAtIndex:0] floatValue];
[[socket emitWithAck:@"canUpdate" with:@[@(cur)]] timingOutAfter:0 callback:^(NSArray* data) {
[socket emit:@"update" with:@[@{@"amount": @(cur + 2.50)}]];
}];
[ack with:@[@"Got your currentAmount, ", @"dude"]];
}];
[socket connect];
</code></pre> </code></pre>
<h2 id='features' class='heading'>Features</h2> <h2 id='features' class='heading'>Features</h2>
<ul> <ul>
<li>Supports socket.io 2.0+ (For socket.io 1.0 use v9.x)</li> <li>Supports socket.io 3.0+ (For socket.io 1.0 use v9.x, For socket.io 2.0 use 15.x)</li>
<li>Supports binary</li> <li>Supports Binary</li>
<li>Supports Polling and WebSockets</li> <li>Supports Polling and WebSockets</li>
<li>Supports TLS/SSL</li> <li>Supports TLS/SSL</li>
<li>Can be used from Objective-C</li>
</ul> </ul>
<h2 id='faqs' class='heading'>FAQS</h2> <h2 id='faqs' class='heading'>FAQS</h2>
<p>Checkout the <a href="https://nuclearace.github.io/Socket.IO-Client-Swift/faq.html">FAQs</a> for commonly asked questions.</p> <p>Checkout the <a href="https://nuclearace.github.io/Socket.IO-Client-Swift/faq.html">FAQs</a> for commonly asked questions.</p>
<p>Checkout the <a href="https://nuclearace.github.io/Socket.IO-Client-Swift/12to13.html">12to13</a> guide for migrating to v13+ from v12 below.</p> <p>Checkout the <a href="https://nuclearace.github.io/Socket.IO-Client-Swift/12to13.html">12to13</a> guide for migrating to v13+ from v12 below.</p>
<p>Checkout the <a href="https://nuclearace.github.io/Socket.IO-Client-Swift/15to16.html">15to16</a> guide for migrating to v16+ from v15.</p>
<h2 id='installation' class='heading'>Installation</h2> <h2 id='installation' class='heading'>Installation</h2>
<p>Requires Swift 4/5 and Xcode 10.x</p> <p>Requires Swift 4/5 and Xcode 10.x</p>
<p>If you need Swift 2.3 use the <a href="https://github.com/socketio/socket.io-client-swift/releases/tag/swift2.3">swift2.3 tag</a> (Pre-Swift 4 support is no longer maintained)</p>
<p>If you need Swift 3.x use v11.1.3.</p>
<h3 id='swift-package-manager' class='heading'>Swift Package Manager</h3> <h3 id='swift-package-manager' class='heading'>Swift Package Manager</h3>
<p>Add the project as a dependency to your Package.swift:</p> <p>Add the project as a dependency to your Package.swift:</p>
@ -263,7 +281,7 @@ SocketIOClient* socket = manager.defaultSocket;
<span class="kd">import</span> <span class="kt">PackageDescription</span> <span class="kd">import</span> <span class="kt">PackageDescription</span>
<span class="k">let</span> <span class="nv">package</span> <span class="o">=</span> <span class="nf">Package</span><span class="p">(</span> <span class="k">let</span> <span class="nv">package</span> <span class="o">=</span> <span class="kt">Package</span><span class="p">(</span>
<span class="nv">name</span><span class="p">:</span> <span class="s">"socket.io-test"</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="s">"socket.io-test"</span><span class="p">,</span>
<span class="nv">products</span><span class="p">:</span> <span class="p">[</span> <span class="nv">products</span><span class="p">:</span> <span class="p">[</span>
<span class="o">.</span><span class="nf">executable</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="s">"socket.io-test"</span><span class="p">,</span> <span class="nv">targets</span><span class="p">:</span> <span class="p">[</span><span class="s">"YourTargetName"</span><span class="p">])</span> <span class="o">.</span><span class="nf">executable</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="s">"socket.io-test"</span><span class="p">,</span> <span class="nv">targets</span><span class="p">:</span> <span class="p">[</span><span class="s">"YourTargetName"</span><span class="p">])</span>
@ -281,7 +299,7 @@ SocketIOClient* socket = manager.defaultSocket;
<h3 id='carthage' class='heading'>Carthage</h3> <h3 id='carthage' class='heading'>Carthage</h3>
<p>Add this line to your <code>Cartfile</code>:</p> <p>Add this line to your <code>Cartfile</code>:</p>
<pre class="highlight plaintext"><code>github "socketio/socket.io-client-swift" ~&gt; 15.1.0 <pre class="highlight plaintext"><code>github "socketio/socket.io-client-swift" ~&gt; 15.2.0
</code></pre> </code></pre>
<p>Run <code>carthage update --platform ios,macosx</code>.</p> <p>Run <code>carthage update --platform ios,macosx</code>.</p>
@ -293,7 +311,7 @@ SocketIOClient* socket = manager.defaultSocket;
<pre class="highlight ruby"><code><span class="n">use_frameworks!</span> <pre class="highlight ruby"><code><span class="n">use_frameworks!</span>
<span class="n">target</span> <span class="s1">'YourApp'</span> <span class="k">do</span> <span class="n">target</span> <span class="s1">'YourApp'</span> <span class="k">do</span>
<span class="n">pod</span> <span class="s1">'Socket.IO-Client-Swift'</span><span class="p">,</span> <span class="s1">'~&gt; 15.1.0'</span> <span class="n">pod</span> <span class="s1">'Socket.IO-Client-Swift'</span><span class="p">,</span> <span class="s1">'~&gt; 15.2.0'</span>
<span class="k">end</span> <span class="k">end</span>
</code></pre> </code></pre>
@ -334,8 +352,8 @@ SocketIOClient* socket = manager.defaultSocket;
</article> </article>
</div> </div>
<section class="footer"> <section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2019-05-28)</p> <p>&copy; 2020 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2020-11-07)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p> <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section> </section>
</body> </body>
</div> </div>

63
docs/js/jazzy.js
View File

@ -8,26 +8,41 @@ if (navigator.userAgent.match(/xcode/i)) {
window.jazzy.docset = true window.jazzy.docset = true
} }
// On doc load, toggle the URL hash discussion if present function toggleItem($link, $content) {
$(document).ready(function() { var animationDuration = 300;
if (!window.jazzy.docset) { $link.toggleClass('token-open');
var linkToHash = $('a[href="' + window.location.hash +'"]'); $content.slideToggle(animationDuration);
linkToHash.trigger("click"); }
}
});
// On token click, toggle its discussion and animate token.marginLeft function itemLinkToContent($link) {
$(".token").click(function(event) { return $link.parent().parent().next();
}
// On doc load + hash-change, open any targetted item
function openCurrentItemIfClosed() {
if (window.jazzy.docset) { if (window.jazzy.docset) {
return; return;
} }
var link = $(this); var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token');
var animationDuration = 300; $content = itemLinkToContent($link);
$content = link.parent().parent().next(); if ($content.is(':hidden')) {
$content.slideToggle(animationDuration); toggleItem($link, $content);
}
}
$(openCurrentItemIfClosed);
$(window).on('hashchange', openCurrentItemIfClosed);
// On item link ('token') click, toggle its discussion
$('.token').on('click', function(event) {
if (window.jazzy.docset) {
return;
}
var $link = $(this);
toggleItem($link, itemLinkToContent($link));
// Keeps the document from jumping to the hash. // Keeps the document from jumping to the hash.
var href = $(this).attr('href'); var href = $link.attr('href');
if (history.pushState) { if (history.pushState) {
history.pushState({}, '', href); history.pushState({}, '', href);
} else { } else {
@ -36,8 +51,20 @@ $(".token").click(function(event) {
event.preventDefault(); event.preventDefault();
}); });
// Dumb down quotes within code blocks that delimit strings instead of quotations // Clicks on links to the current, closed, item need to open the item
// https://github.com/realm/jazzy/issues/714 $("a:not('.token')").on('click', function() {
$("code q").replaceWith(function () { if (location == this.href) {
return ["\"", $(this).contents(), "\""]; openCurrentItemIfClosed();
}
}); });
// KaTeX rendering
if ("katex" in window) {
$($('.math').each( (_, element) => {
katex.render(element.textContent, element, {
displayMode: $(element).hasClass('m-block'),
throwOnError: false,
trust: true
});
}))
}

26
docs/js/jazzy.search.js
View File

@ -1,9 +1,4 @@
$(function(){ $(function(){
var searchIndex = lunr(function() {
this.ref('url');
this.field('name');
});
var $typeahead = $('[data-typeahead]'); var $typeahead = $('[data-typeahead]');
var $form = $typeahead.parents('form'); var $form = $typeahead.parents('form');
var searchURL = $form.attr('action'); var searchURL = $form.attr('action');
@ -26,21 +21,34 @@ $(function(){
$form.addClass('loading'); $form.addClass('loading');
$.getJSON(searchURL).then(function(searchData) { $.getJSON(searchURL).then(function(searchData) {
$.each(searchData, function (url, doc) { const searchIndex = lunr(function() {
searchIndex.add({url: url, name: doc.name}); this.ref('url');
this.field('name');
this.field('abstract');
for (const [url, doc] of Object.entries(searchData)) {
this.add({url: url, name: doc.name, abstract: doc.abstract});
}
}); });
$typeahead.typeahead( $typeahead.typeahead(
{ {
highlight: true, highlight: true,
minLength: 3 minLength: 3,
autoselect: true
}, },
{ {
limit: 10, limit: 10,
display: displayTemplate, display: displayTemplate,
templates: { suggestion: suggestionTemplate }, templates: { suggestion: suggestionTemplate },
source: function(query, sync) { source: function(query, sync) {
var results = searchIndex.search(query).map(function(result) { const lcSearch = query.toLowerCase();
const results = searchIndex.query(function(q) {
q.term(lcSearch, { boost: 100 });
q.term(lcSearch, {
boost: 10,
wildcard: lunr.Query.wildcard.TRAILING
});
}).map(function(result) {
var doc = searchData[result.ref]; var doc = searchData[result.ref];
doc.url = result.ref; doc.url = result.ref;
return doc; return doc;

6
docs/js/jquery.min.js vendored
View File

File diff suppressed because one or more lines are too long

6
docs/js/lunr.min.js vendored
View File

File diff suppressed because one or more lines are too long

262
docs/js/typeahead.jquery.js
View File

@ -1,18 +1,19 @@
/*! /*!
* typeahead.js 0.11.1 * typeahead.js 1.3.1
* https://github.com/twitter/typeahead.js * https://github.com/corejavascript/typeahead.js
* Copyright 2013-2015 Twitter, Inc. and other contributors; Licensed MIT * Copyright 2013-2020 Twitter, Inc. and other contributors; Licensed MIT
*/ */
(function(root, factory) { (function(root, factory) {
if (typeof define === "function" && define.amd) { if (typeof define === "function" && define.amd) {
define("typeahead.js", [ "jquery" ], function(a0) { define([ "jquery" ], function(a0) {
return factory(a0); return factory(a0);
}); });
} else if (typeof exports === "object") { } else if (typeof module === "object" && module.exports) {
module.exports = factory(require("jquery")); module.exports = factory(require("jquery"));
} else { } else {
factory(jQuery); factory(root["jQuery"]);
} }
})(this, function($) { })(this, function($) {
var _ = function() { var _ = function() {
@ -148,6 +149,13 @@
stringify: function(val) { stringify: function(val) {
return _.isString(val) ? val : JSON.stringify(val); return _.isString(val) ? val : JSON.stringify(val);
}, },
guid: function() {
function _p8(s) {
var p = (Math.random().toString(16) + "000000000").substr(2, 8);
return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p;
}
return "tt-" + _p8() + _p8(true) + _p8(true) + _p8();
},
noop: function() {} noop: function() {}
}; };
}(); }();
@ -189,7 +197,7 @@
function buildHtml(c) { function buildHtml(c) {
return { return {
wrapper: '<span class="' + c.wrapper + '"></span>', wrapper: '<span class="' + c.wrapper + '"></span>',
menu: '<div class="' + c.menu + '"></div>' menu: '<div role="listbox" class="' + c.menu + '"></div>'
}; };
} }
function buildSelectors(classes) { function buildSelectors(classes) {
@ -264,10 +272,8 @@
} }
_.mixin(EventBus.prototype, { _.mixin(EventBus.prototype, {
_trigger: function(type, args) { _trigger: function(type, args) {
var $e; var $e = $.Event(namespace + type);
$e = $.Event(namespace + type); this.$el.trigger.call(this.$el, $e, args || []);
(args = args || []).unshift($e);
this.$el.trigger.apply(this.$el, args);
return $e; return $e;
}, },
before: function(type) { before: function(type) {
@ -384,7 +390,36 @@
tagName: "strong", tagName: "strong",
className: null, className: null,
wordsOnly: false, wordsOnly: false,
caseSensitive: false caseSensitive: false,
diacriticInsensitive: false
};
var accented = {
A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]",
B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]",
C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]",
D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]",
E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]",
F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]",
G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]",
H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]",
I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]",
J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]",
K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]",
L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]",
M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]",
N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]",
O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]",
P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]",
Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]",
R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]",
S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]",
T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]",
U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]",
V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]",
W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]",
X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]",
Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]",
Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]"
}; };
return function hightlight(o) { return function hightlight(o) {
var regex; var regex;
@ -393,7 +428,7 @@
return; return;
} }
o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ];
regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly); regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive);
traverse(o.node, hightlightTextNode); traverse(o.node, hightlightTextNode);
function hightlightTextNode(textNode) { function hightlightTextNode(textNode) {
var match, patternNode, wrapperNode; var match, patternNode, wrapperNode;
@ -419,10 +454,17 @@
} }
} }
}; };
function getRegex(patterns, caseSensitive, wordsOnly) { function accent_replacer(chr) {
return accented[chr.toUpperCase()] || chr;
}
function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) {
var escapedPatterns = [], regexStr; var escapedPatterns = [], regexStr;
for (var i = 0, len = patterns.length; i < len; i++) { for (var i = 0, len = patterns.length; i < len; i++) {
escapedPatterns.push(_.escapeRegExChars(patterns[i])); var escapedWord = _.escapeRegExChars(patterns[i]);
if (diacriticInsensitive) {
escapedWord = escapedWord.replace(/\S/g, accent_replacer);
}
escapedPatterns.push(escapedWord);
} }
regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")";
return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i");
@ -441,6 +483,7 @@
40: "down" 40: "down"
}; };
function Input(o, www) { function Input(o, www) {
var id;
o = o || {}; o = o || {};
if (!o.input) { if (!o.input) {
$.error("input is missing"); $.error("input is missing");
@ -448,6 +491,18 @@
www.mixin(this); www.mixin(this);
this.$hint = $(o.hint); this.$hint = $(o.hint);
this.$input = $(o.input); this.$input = $(o.input);
this.$menu = $(o.menu);
id = this.$input.attr("id") || _.guid();
this.$menu.attr("id", id + "_listbox");
this.$hint.attr({
"aria-hidden": true
});
this.$input.attr({
"aria-owns": id + "_listbox",
role: "combobox",
"aria-autocomplete": "list",
"aria-expanded": false
});
this.query = this.$input.val(); this.query = this.$input.val();
this.queryWhenFocused = this.hasFocus() ? this.query : null; this.queryWhenFocused = this.hasFocus() ? this.query : null;
this.$overflowHelper = buildOverflowHelper(this.$input); this.$overflowHelper = buildOverflowHelper(this.$input);
@ -455,6 +510,7 @@
if (this.$hint.length === 0) { if (this.$hint.length === 0) {
this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop;
} }
this.onSync("cursorchange", this._updateDescendent);
} }
Input.normalizeQuery = function(str) { Input.normalizeQuery = function(str) {
return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " ");
@ -524,6 +580,9 @@
this.trigger("whitespaceChanged", this.query); this.trigger("whitespaceChanged", this.query);
} }
}, },
_updateDescendent: function updateDescendent(event, id) {
this.$input.attr("aria-activedescendant", id);
},
bind: function() { bind: function() {
var that = this, onBlur, onFocus, onKeydown, onInput; var that = this, onBlur, onFocus, onKeydown, onInput;
onBlur = _.bind(this._onBlur, this); onBlur = _.bind(this._onBlur, this);
@ -616,6 +675,9 @@
this.$input.off(".tt"); this.$input.off(".tt");
this.$overflowHelper.remove(); this.$overflowHelper.remove();
this.$hint = this.$input = this.$overflowHelper = $("<div>"); this.$hint = this.$input = this.$overflowHelper = $("<div>");
},
setAriaExpanded: function setAriaExpanded(value) {
this.$input.attr("aria-expanded", value);
} }
}); });
return Input; return Input;
@ -647,6 +709,7 @@
"use strict"; "use strict";
var keys, nameGenerator; var keys, nameGenerator;
keys = { keys = {
dataset: "tt-selectable-dataset",
val: "tt-selectable-display", val: "tt-selectable-display",
obj: "tt-selectable-object" obj: "tt-selectable-object"
}; };
@ -666,19 +729,20 @@
} }
www.mixin(this); www.mixin(this);
this.highlight = !!o.highlight; this.highlight = !!o.highlight;
this.name = o.name || nameGenerator(); this.name = _.toStr(o.name || nameGenerator());
this.limit = o.limit || 5; this.limit = o.limit || 5;
this.displayFn = getDisplayFn(o.display || o.displayKey); this.displayFn = getDisplayFn(o.display || o.displayKey);
this.templates = getTemplates(o.templates, this.displayFn); this.templates = getTemplates(o.templates, this.displayFn);
this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source;
this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async;
this._resetLastSuggestion(); this._resetLastSuggestion();
this.$el = $(o.node).addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name);
} }
Dataset.extractData = function extractData(el) { Dataset.extractData = function extractData(el) {
var $el = $(el); var $el = $(el);
if ($el.data(keys.obj)) { if ($el.data(keys.obj)) {
return { return {
dataset: $el.data(keys.dataset) || "",
val: $el.data(keys.val) || "", val: $el.data(keys.val) || "",
obj: $el.data(keys.obj) || null obj: $el.data(keys.obj) || null
}; };
@ -697,7 +761,7 @@
} else { } else {
this._empty(); this._empty();
} }
this.trigger("rendered", this.name, suggestions, false); this.trigger("rendered", suggestions, false, this.name);
}, },
_append: function append(query, suggestions) { _append: function append(query, suggestions) {
suggestions = suggestions || []; suggestions = suggestions || [];
@ -708,7 +772,7 @@
} else if (!this.$lastSuggestion.length && this.templates.notFound) { } else if (!this.$lastSuggestion.length && this.templates.notFound) {
this._renderNotFound(query); this._renderNotFound(query);
} }
this.trigger("rendered", this.name, suggestions, true); this.trigger("rendered", suggestions, true, this.name);
}, },
_renderSuggestions: function renderSuggestions(query, suggestions) { _renderSuggestions: function renderSuggestions(query, suggestions) {
var $fragment; var $fragment;
@ -749,7 +813,7 @@
_.each(suggestions, function getSuggestionNode(suggestion) { _.each(suggestions, function getSuggestionNode(suggestion) {
var $el, context; var $el, context;
context = that._injectQuery(query, suggestion); context = that._injectQuery(query, suggestion);
$el = $(that.templates.suggestion(context)).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable);
fragment.appendChild($el[0]); fragment.appendChild($el[0]);
}); });
this.highlight && highlight({ this.highlight && highlight({
@ -787,7 +851,7 @@
this.cancel = function cancel() { this.cancel = function cancel() {
canceled = true; canceled = true;
that.cancel = $.noop; that.cancel = $.noop;
that.async && that.trigger("asyncCanceled", query); that.async && that.trigger("asyncCanceled", query, that.name);
}; };
this.source(query, sync, async); this.source(query, sync, async);
!syncCalled && sync([]); !syncCalled && sync([]);
@ -800,16 +864,17 @@
rendered = suggestions.length; rendered = suggestions.length;
that._overwrite(query, suggestions); that._overwrite(query, suggestions);
if (rendered < that.limit && that.async) { if (rendered < that.limit && that.async) {
that.trigger("asyncRequested", query); that.trigger("asyncRequested", query, that.name);
} }
} }
function async(suggestions) { function async(suggestions) {
suggestions = suggestions || []; suggestions = suggestions || [];
if (!canceled && rendered < that.limit) { if (!canceled && rendered < that.limit) {
that.cancel = $.noop; that.cancel = $.noop;
rendered += suggestions.length; var idx = Math.abs(rendered - that.limit);
that._append(query, suggestions.slice(0, that.limit - rendered)); rendered += idx;
that.async && that.trigger("asyncReceived", query); that._append(query, suggestions.slice(0, idx));
that.async && that.trigger("asyncReceived", query, that.name);
} }
} }
}, },
@ -840,10 +905,14 @@
pending: templates.pending && _.templatify(templates.pending), pending: templates.pending && _.templatify(templates.pending),
header: templates.header && _.templatify(templates.header), header: templates.header && _.templatify(templates.header),
footer: templates.footer && _.templatify(templates.footer), footer: templates.footer && _.templatify(templates.footer),
suggestion: templates.suggestion || suggestionTemplate suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate
}; };
function userSuggestionTemplate(context) {
var template = templates.suggestion;
return $(template(context)).attr("id", _.guid());
}
function suggestionTemplate(context) { function suggestionTemplate(context) {
return $("<div>").text(displayFn(context)); return $('<div role="option">').attr("id", _.guid()).text(displayFn(context));
} }
} }
function isValidName(str) { function isValidName(str) {
@ -884,10 +953,11 @@
this.trigger.apply(this, arguments); this.trigger.apply(this, arguments);
}, },
_allDatasetsEmpty: function allDatasetsEmpty() { _allDatasetsEmpty: function allDatasetsEmpty() {
return _.every(this.datasets, isDatasetEmpty); return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) {
function isDatasetEmpty(dataset) { var isEmpty = dataset.isEmpty();
return dataset.isEmpty(); this.$node.attr("aria-expanded", !isEmpty);
} return isEmpty;
}, this));
}, },
_getSelectables: function getSelectables() { _getSelectables: function getSelectables() {
return this.$node.find(this.selectors.selectable); return this.$node.find(this.selectors.selectable);
@ -912,6 +982,12 @@
var that = this, onSelectableClick; var that = this, onSelectableClick;
onSelectableClick = _.bind(this._onSelectableClick, this); onSelectableClick = _.bind(this._onSelectableClick, this);
this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); this.$node.on("click.tt", this.selectors.selectable, onSelectableClick);
this.$node.on("mouseover", this.selectors.selectable, function() {
that.setCursor($(this));
});
this.$node.on("mouseleave", function() {
that._removeCursor();
});
_.each(this.datasets, function(dataset) { _.each(this.datasets, function(dataset) {
dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that);
}); });
@ -921,9 +997,11 @@
return this.$node.hasClass(this.classes.open); return this.$node.hasClass(this.classes.open);
}, },
open: function open() { open: function open() {
this.$node.scrollTop(0);
this.$node.addClass(this.classes.open); this.$node.addClass(this.classes.open);
}, },
close: function close() { close: function close() {
this.$node.attr("aria-expanded", false);
this.$node.removeClass(this.classes.open); this.$node.removeClass(this.classes.open);
this._removeCursor(); this._removeCursor();
}, },
@ -988,6 +1066,55 @@
}); });
return Menu; return Menu;
}(); }();
var Status = function() {
"use strict";
function Status(options) {
this.$el = $("<span></span>", {
role: "status",
"aria-live": "polite"
}).css({
position: "absolute",
padding: "0",
border: "0",
height: "1px",
width: "1px",
"margin-bottom": "-1px",
"margin-right": "-1px",
overflow: "hidden",
clip: "rect(0 0 0 0)",
"white-space": "nowrap"
});
options.$input.after(this.$el);
_.each(options.menu.datasets, _.bind(function(dataset) {
if (dataset.onSync) {
dataset.onSync("rendered", _.bind(this.update, this));
dataset.onSync("cleared", _.bind(this.cleared, this));
}
}, this));
}
_.mixin(Status.prototype, {
update: function update(event, suggestions) {
var length = suggestions.length;
var words;
if (length === 1) {
words = {
result: "result",
is: "is"
};
} else {
words = {
result: "results",
is: "are"
};
}
this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate.");
},
cleared: function() {
this.$el.text("");
}
});
return Status;
}();
var DefaultMenu = function() { var DefaultMenu = function() {
"use strict"; "use strict";
var s = Menu.prototype; var s = Menu.prototype;
@ -1052,6 +1179,7 @@
this.input = o.input; this.input = o.input;
this.menu = o.menu; this.menu = o.menu;
this.enabled = true; this.enabled = true;
this.autoselect = !!o.autoselect;
this.active = false; this.active = false;
this.input.hasFocus() && this.activate(); this.input.hasFocus() && this.activate();
this.dir = this.input.getLangDir(); this.dir = this.input.getLangDir();
@ -1098,8 +1226,12 @@
_onDatasetCleared: function onDatasetCleared() { _onDatasetCleared: function onDatasetCleared() {
this._updateHint(); this._updateHint();
}, },
_onDatasetRendered: function onDatasetRendered(type, dataset, suggestions, async) { _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) {
this._updateHint(); this._updateHint();
if (this.autoselect) {
var cursorClass = this.selectors.cursor.substr(1);
this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass);
}
this.eventBus.trigger("render", suggestions, async, dataset); this.eventBus.trigger("render", suggestions, async, dataset);
}, },
_onAsyncRequested: function onAsyncRequested(type, dataset, query) { _onAsyncRequested: function onAsyncRequested(type, dataset, query) {
@ -1122,15 +1254,25 @@
_onEnterKeyed: function onEnterKeyed(type, $e) { _onEnterKeyed: function onEnterKeyed(type, $e) {
var $selectable; var $selectable;
if ($selectable = this.menu.getActiveSelectable()) { if ($selectable = this.menu.getActiveSelectable()) {
this.select($selectable) && $e.preventDefault(); if (this.select($selectable)) {
$e.preventDefault();
$e.stopPropagation();
}
} else if (this.autoselect) {
if (this.select(this.menu.getTopSelectable())) {
$e.preventDefault();
$e.stopPropagation();
}
} }
}, },
_onTabKeyed: function onTabKeyed(type, $e) { _onTabKeyed: function onTabKeyed(type, $e) {
var $selectable; var $selectable;
if ($selectable = this.menu.getActiveSelectable()) { if ($selectable = this.menu.getActiveSelectable()) {
this.select($selectable) && $e.preventDefault(); this.select($selectable) && $e.preventDefault();
} else if ($selectable = this.menu.getTopSelectable()) { } else if (this.autoselect) {
this.autocomplete($selectable) && $e.preventDefault(); if ($selectable = this.menu.getTopSelectable()) {
this.autocomplete($selectable) && $e.preventDefault();
}
} }
}, },
_onEscKeyed: function onEscKeyed() { _onEscKeyed: function onEscKeyed() {
@ -1144,12 +1286,12 @@
}, },
_onLeftKeyed: function onLeftKeyed() { _onLeftKeyed: function onLeftKeyed() {
if (this.dir === "rtl" && this.input.isCursorAtEnd()) { if (this.dir === "rtl" && this.input.isCursorAtEnd()) {
this.autocomplete(this.menu.getTopSelectable()); this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable());
} }
}, },
_onRightKeyed: function onRightKeyed() { _onRightKeyed: function onRightKeyed() {
if (this.dir === "ltr" && this.input.isCursorAtEnd()) { if (this.dir === "ltr" && this.input.isCursorAtEnd()) {
this.autocomplete(this.menu.getTopSelectable()); this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable());
} }
}, },
_onQueryChanged: function onQueryChanged(e, query) { _onQueryChanged: function onQueryChanged(e, query) {
@ -1226,6 +1368,7 @@
}, },
open: function open() { open: function open() {
if (!this.isOpen() && !this.eventBus.before("open")) { if (!this.isOpen() && !this.eventBus.before("open")) {
this.input.setAriaExpanded(true);
this.menu.open(); this.menu.open();
this._updateHint(); this._updateHint();
this.eventBus.trigger("open"); this.eventBus.trigger("open");
@ -1234,6 +1377,7 @@
}, },
close: function close() { close: function close() {
if (this.isOpen() && !this.eventBus.before("close")) { if (this.isOpen() && !this.eventBus.before("close")) {
this.input.setAriaExpanded(false);
this.menu.close(); this.menu.close();
this.input.clearHint(); this.input.clearHint();
this.input.resetInputValue(); this.input.resetInputValue();
@ -1249,9 +1393,9 @@
}, },
select: function select($selectable) { select: function select($selectable) {
var data = this.menu.getSelectableData($selectable); var data = this.menu.getSelectableData($selectable);
if (data && !this.eventBus.before("select", data.obj)) { if (data && !this.eventBus.before("select", data.obj, data.dataset)) {
this.input.setQuery(data.val, true); this.input.setQuery(data.val, true);
this.eventBus.trigger("select", data.obj); this.eventBus.trigger("select", data.obj, data.dataset);
this.close(); this.close();
return true; return true;
} }
@ -1262,29 +1406,34 @@
query = this.input.getQuery(); query = this.input.getQuery();
data = this.menu.getSelectableData($selectable); data = this.menu.getSelectableData($selectable);
isValid = data && query !== data.val; isValid = data && query !== data.val;
if (isValid && !this.eventBus.before("autocomplete", data.obj)) { if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) {
this.input.setQuery(data.val); this.input.setQuery(data.val);
this.eventBus.trigger("autocomplete", data.obj); this.eventBus.trigger("autocomplete", data.obj, data.dataset);
return true; return true;
} }
return false; return false;
}, },
moveCursor: function moveCursor(delta) { moveCursor: function moveCursor(delta) {
var query, $candidate, data, payload, cancelMove; var query, $candidate, data, suggestion, datasetName, cancelMove, id;
query = this.input.getQuery(); query = this.input.getQuery();
$candidate = this.menu.selectableRelativeToCursor(delta); $candidate = this.menu.selectableRelativeToCursor(delta);
data = this.menu.getSelectableData($candidate); data = this.menu.getSelectableData($candidate);
payload = data ? data.obj : null; suggestion = data ? data.obj : null;
datasetName = data ? data.dataset : null;
id = $candidate ? $candidate.attr("id") : null;
this.input.trigger("cursorchange", id);
cancelMove = this._minLengthMet() && this.menu.update(query); cancelMove = this._minLengthMet() && this.menu.update(query);
if (!cancelMove && !this.eventBus.before("cursorchange", payload)) { if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) {
this.menu.setCursor($candidate); this.menu.setCursor($candidate);
if (data) { if (data) {
this.input.setInputValue(data.val); if (typeof data.val === "string") {
this.input.setInputValue(data.val);
}
} else { } else {
this.input.resetInputValue(); this.input.resetInputValue();
this._updateHint(); this._updateHint();
} }
this.eventBus.trigger("cursorchange", payload); this.eventBus.trigger("cursorchange", suggestion, datasetName);
return true; return true;
} }
return false; return false;
@ -1322,7 +1471,7 @@
www = WWW(o.classNames); www = WWW(o.classNames);
return this.each(attach); return this.each(attach);
function attach() { function attach() {
var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, typeahead, MenuConstructor; var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor;
_.each(datasets, function(d) { _.each(datasets, function(d) {
d.highlight = !!o.highlight; d.highlight = !!o.highlight;
}); });
@ -1347,17 +1496,23 @@
}); });
input = new Input({ input = new Input({
hint: $hint, hint: $hint,
input: $input input: $input,
menu: $menu
}, www); }, www);
menu = new MenuConstructor({ menu = new MenuConstructor({
node: $menu, node: $menu,
datasets: datasets datasets: datasets
}, www); }, www);
status = new Status({
$input: $input,
menu: menu
});
typeahead = new Typeahead({ typeahead = new Typeahead({
input: input, input: input,
menu: menu, menu: menu,
eventBus: eventBus, eventBus: eventBus,
minLength: o.minLength minLength: o.minLength,
autoselect: o.autoselect
}, www); }, www);
$input.data(keys.www, www); $input.data(keys.www, www);
$input.data(keys.typeahead, typeahead); $input.data(keys.typeahead, typeahead);
@ -1450,7 +1605,7 @@
return query; return query;
} else { } else {
ttEach(this, function(t) { ttEach(this, function(t) {
t.setVal(newVal); t.setVal(_.toStr(newVal));
}); });
return this; return this;
} }
@ -1481,8 +1636,10 @@
}); });
} }
function buildHintFromInput($input, www) { function buildHintFromInput($input, www) {
return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop("readonly", true).removeAttr("id name placeholder required").attr({ return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({
autocomplete: "off", readonly: true,
required: false
}).removeAttr("id name placeholder").removeClass("required").attr({
spellcheck: "false", spellcheck: "false",
tabindex: -1 tabindex: -1
}); });
@ -1495,7 +1652,6 @@
style: $input.attr("style") style: $input.attr("style")
}); });
$input.addClass(www.classes.input).attr({ $input.addClass(www.classes.input).attr({
autocomplete: "off",
spellcheck: false spellcheck: false
}); });
try { try {

2
docs/search.json
View File

File diff suppressed because one or more lines are too long