Skip to content

Commit 8b11492

Browse files
nuclearacenuclearace
committed
Regenerate docs
1 parent 2913751 commit 8b11492

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+803
-87
lines changed

‎Source/SocketIO/Client/SocketIOClientOption.swift

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@ import Starscream
2727

2828
/// The socket.io version being used.
2929
public enum SocketIOVersion: Int {
30+
/// socket.io 2, engine.io 3
3031
case two = 2
32+
33+
/// socket.io 3, engine.io 4
3134
case three = 3
3235
}
3336

‎docs/12to13.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,9 @@
104104
<li class="nav-group-task">
105105
<a class="nav-group-task-link" href="Enums/SocketIOStatus.html">SocketIOStatus</a>
106106
</li>
107+
<li class="nav-group-task">
108+
<a class="nav-group-task-link" href="Enums/SocketIOVersion.html">SocketIOVersion</a>
109+
</li>
107110
<li class="nav-group-task">
108111
<a class="nav-group-task-link" href="Enums/SocketParsableError.html">SocketParsableError</a>
109112
</li>
@@ -324,8 +327,8 @@ <h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2>
324327
</article>
325328
</div>
326329
<section class="footer">
327-
<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>
328-
<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>
330+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
331+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
329332
</section>
330333
</body>
331334
</div>

‎docs/15to16.html

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,9 @@
104104
<li class="nav-group-task">
105105
<a class="nav-group-task-link" href="Enums/SocketIOStatus.html">SocketIOStatus</a>
106106
</li>
107+
<li class="nav-group-task">
108+
<a class="nav-group-task-link" href="Enums/SocketIOVersion.html">SocketIOVersion</a>
109+
</li>
107110
<li class="nav-group-task">
108111
<a class="nav-group-task-link" href="Enums/SocketParsableError.html">SocketParsableError</a>
109112
</li>
@@ -229,6 +232,13 @@
229232
<h1 id='upgrading-from-v15-to-v16' class='heading'>Upgrading from v15 to v16</h1>
230233

231234
<p>This guide will help you navigate the changes that were introduced in v16.</p>
235+
<h2 id='objective-c-is-no-longer-supported-you-must-now-use-swift' class='heading'>Objective-c is no longer supported. You must now use Swift.</h2>
236+
<h2 id='client-supports-multiple-socket-io-versions' class='heading'>Client supports multiple socket.io versions</h2>
237+
238+
<p>The client now supports socket.io 3 servers. This is mostly a transparent change, however if your sever
239+
is socket.io 2, you must send <code>.version(.two)</code> as an option to the manager.</p>
240+
<pre class="highlight swift"><code><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:8087/"</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">version</span><span class="p">(</span><span class="o">.</span><span class="n">two</span><span class="p">)])</span>
241+
</code></pre>
232242

233243
</div>
234244
</section>
@@ -237,8 +247,8 @@ <h1 id='upgrading-from-v15-to-v16' class='heading'>Upgrading from v15 to v16</h1
237247
</article>
238248
</div>
239249
<section class="footer">
240-
<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>
241-
<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>
250+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
251+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
242252
</section>
243253
</body>
244254
</div>

‎docs/Classes.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,9 @@
105105
<li class="nav-group-task">
106106
<a class="nav-group-task-link" href="Enums/SocketIOStatus.html">SocketIOStatus</a>
107107
</li>
108+
<li class="nav-group-task">
109+
<a class="nav-group-task-link" href="Enums/SocketIOVersion.html">SocketIOVersion</a>
110+
</li>
108111
<li class="nav-group-task">
109112
<a class="nav-group-task-link" href="Enums/SocketParsableError.html">SocketParsableError</a>
110113
</li>
@@ -515,8 +518,8 @@ <h4>Declaration</h4>
515518
</article>
516519
</div>
517520
<section class="footer">
518-
<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>
519-
<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>
521+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
522+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
520523
</section>
521524
</body>
522525
</div>

‎docs/Classes/OnAckCallback.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,9 @@
105105
<li class="nav-group-task">
106106
<a class="nav-group-task-link" href="../Enums/SocketIOStatus.html">SocketIOStatus</a>
107107
</li>
108+
<li class="nav-group-task">
109+
<a class="nav-group-task-link" href="../Enums/SocketIOVersion.html">SocketIOVersion</a>
110+
</li>
108111
<li class="nav-group-task">
109112
<a class="nav-group-task-link" href="../Enums/SocketParsableError.html">SocketParsableError</a>
110113
</li>
@@ -326,8 +329,8 @@ <h4>Parameters</h4>
326329
</article>
327330
</div>
328331
<section class="footer">
329-
<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>
330-
<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>
332+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
333+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
331334
</section>
332335
</body>
333336
</div>

‎docs/Classes/SocketAckEmitter.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,9 @@
105105
<li class="nav-group-task">
106106
<a class="nav-group-task-link" href="../Enums/SocketIOStatus.html">SocketIOStatus</a>
107107
</li>
108+
<li class="nav-group-task">
109+
<a class="nav-group-task-link" href="../Enums/SocketIOVersion.html">SocketIOVersion</a>
110+
</li>
108111
<li class="nav-group-task">
109112
<a class="nav-group-task-link" href="../Enums/SocketParsableError.html">SocketParsableError</a>
110113
</li>
@@ -507,8 +510,8 @@ <h4>Parameters</h4>
507510
</article>
508511
</div>
509512
<section class="footer">
510-
<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>
511-
<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>
513+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
514+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
512515
</section>
513516
</body>
514517
</div>

‎docs/Classes/SocketAnyEvent.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,9 @@
105105
<li class="nav-group-task">
106106
<a class="nav-group-task-link" href="../Enums/SocketIOStatus.html">SocketIOStatus</a>
107107
</li>
108+
<li class="nav-group-task">
109+
<a class="nav-group-task-link" href="../Enums/SocketIOVersion.html">SocketIOVersion</a>
110+
</li>
108111
<li class="nav-group-task">
109112
<a class="nav-group-task-link" href="../Enums/SocketParsableError.html">SocketParsableError</a>
110113
</li>
@@ -343,8 +346,8 @@ <h4>Declaration</h4>
343346
</article>
344347
</div>
345348
<section class="footer">
346-
<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>
347-
<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>
349+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
350+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
348351
</section>
349352
</body>
350353
</div>

‎docs/Classes/SocketEngine.html

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,9 @@
105105
<li class="nav-group-task">
106106
<a class="nav-group-task-link" href="../Enums/SocketIOStatus.html">SocketIOStatus</a>
107107
</li>
108+
<li class="nav-group-task">
109+
<a class="nav-group-task-link" href="../Enums/SocketIOVersion.html">SocketIOVersion</a>
110+
</li>
108111
<li class="nav-group-task">
109112
<a class="nav-group-task-link" href="../Enums/SocketParsableError.html">SocketParsableError</a>
110113
</li>
@@ -831,6 +834,33 @@ <h4>Declaration</h4>
831834
</section>
832835
</div>
833836
</li>
837+
<li class="item">
838+
<div>
839+
<code>
840+
<a name="/s:8SocketIO0A6EngineC7versionAA0A9IOVersionOvp"></a>
841+
<a name="//apple_ref/swift/Property/version" class="dashAnchor"></a>
842+
<a class="token" href="#/s:8SocketIO0A6EngineC7versionAA0A9IOVersionOvp">version</a>
843+
</code>
844+
</div>
845+
<div class="height-container">
846+
<div class="pointer-container"></div>
847+
<section class="section">
848+
<div class="pointer"></div>
849+
<div class="abstract">
850+
<p>The version of engine.io being used. Default is three.</p>
851+
852+
</div>
853+
<div class="declaration">
854+
<h4>Declaration</h4>
855+
<div class="language">
856+
<p class="aside-title">Swift</p>
857+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">var</span> <span class="nv">version</span><span class="p">:</span> <span class="kt"><a href="../Enums/SocketIOVersion.html">SocketIOVersion</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
858+
859+
</div>
860+
</div>
861+
</section>
862+
</div>
863+
</li>
834864
<li class="item">
835865
<div>
836866
<code>
@@ -960,7 +990,7 @@ <h4>Declaration</h4>
960990
<h4>Declaration</h4>
961991
<div class="language">
962992
<p class="aside-title">Swift</p>
963-
<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>
993+
<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>
964994

965995
</div>
966996
</div>
@@ -1602,8 +1632,8 @@ <h4>Parameters</h4>
16021632
</article>
16031633
</div>
16041634
<section class="footer">
1605-
<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>
1606-
<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>
1635+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
1636+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
16071637
</section>
16081638
</body>
16091639
</div>

‎docs/Classes/SocketIOClient.html

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,9 @@
105105
<li class="nav-group-task">
106106
<a class="nav-group-task-link" href="../Enums/SocketIOStatus.html">SocketIOStatus</a>
107107
</li>
108+
<li class="nav-group-task">
109+
<a class="nav-group-task-link" href="../Enums/SocketIOVersion.html">SocketIOVersion</a>
110+
</li>
108111
<li class="nav-group-task">
109112
<a class="nav-group-task-link" href="../Enums/SocketParsableError.html">SocketParsableError</a>
110113
</li>
@@ -366,7 +369,7 @@ <h4>Declaration</h4>
366369
<h4>Declaration</h4>
367370
<div class="language">
368371
<p class="aside-title">Swift</p>
369-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">weak</span> <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="k">get</span> <span class="p">}</span></code></pre>
372+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="k">weak</span> <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>
370373

371374
</div>
372375
</div>
@@ -1845,8 +1848,8 @@ <h4>Parameters</h4>
18451848
</article>
18461849
</div>
18471850
<section class="footer">
1848-
<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>
1849-
<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>
1851+
<p>&copy; 2021 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2021-01-27)</p>
1852+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
18501853
</section>
18511854
</body>
18521855
</div>

0 commit comments

Comments
 (0)