Skip to content

Commit 777f6e2

Browse files
nuclearacenuclearace
committed
update docs
1 parent 33d7230 commit 777f6e2

34 files changed

+87
-80
lines changed

Diff for: ‎README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ import PackageDescription
8282
let package = Package(
8383
name: "YourSocketIOProject",
8484
dependencies: [
85-
.Package(url: "https://github.com/socketio/socket.io-client-swift", majorVersion: 9)
85+
.Package(url: "https://github.com/socketio/socket.io-client-swift", majorVersion: 10)
8686
]
8787
)
8888
```
@@ -92,7 +92,7 @@ Then import `import SocketIO`.
9292
### Carthage
9393
Add this line to your `Cartfile`:
9494
```
95-
github "socketio/socket.io-client-swift" ~> 10.0.0 # Or latest version
95+
github "socketio/socket.io-client-swift" ~> 10.0.1 # Or latest version
9696
```
9797

9898
Run `carthage update --platform ios,macosx`.
@@ -104,7 +104,7 @@ Create `Podfile` and add `pod 'Socket.IO-Client-Swift'`:
104104
use_frameworks!
105105

106106
target 'YourApp' do
107-
pod 'Socket.IO-Client-Swift', '~> 10.0.0' # Or latest version
107+
pod 'Socket.IO-Client-Swift', '~> 10.0.1' # Or latest version
108108
end
109109
```
110110

@@ -132,7 +132,7 @@ Objective-C:
132132
Add this line to your `Seedfile`:
133133

134134
```
135-
github "socketio/socket.io-client-swift", "v10.0.0", :files => "Source/*.swift" # Or latest version
135+
github "socketio/socket.io-client-swift", "v10.0.1", :files => "Source/*.swift" # Or latest version
136136
```
137137

138138
Run `seed install`.

Diff for: ‎docs/Classes.html

+3-1
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,8 @@ <h4>Declaration</h4>
295295
<div class="abstract">
296296
<p>The main class for SocketIOClientSwift.</p>
297297

298+
<p><strong>NOTE</strong>: The client is not thread/queue safe, all interaction with the socket should be done on the <code>handleQueue</code></p>
299+
298300
<p>Represents a socket.io-client. Most interaction with socket.io will be through this class.</p>
299301

300302
<a href="Classes/SocketIOClient.html" class="slightly-smaller">See more</a>
@@ -465,7 +467,7 @@ <h4>Declaration</h4>
465467
</article>
466468
</div>
467469
<section class="footer">
468-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
470+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
469471
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
470472
</section>
471473
</body>

Diff for: ‎docs/Classes/OnAckCallback.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ <h4>Parameters</h4>
266266
</article>
267267
</div>
268268
<section class="footer">
269-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
269+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
270270
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
271271
</section>
272272
</body>

Diff for: ‎docs/Classes/SSLCert.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ <h4>Return Value</h4>
288288
</article>
289289
</div>
290290
<section class="footer">
291-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
291+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
292292
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
293293
</section>
294294
</body>

Diff for: ‎docs/Classes/SSLSecurity.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ <h4>Return Value</h4>
381381
</article>
382382
</div>
383383
<section class="footer">
384-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
384+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
385385
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
386386
</section>
387387
</body>

Diff for: ‎docs/Classes/SocketAckEmitter.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ <h4>Parameters</h4>
336336
</article>
337337
</div>
338338
<section class="footer">
339-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
339+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
340340
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
341341
</section>
342342
</body>

Diff for: ‎docs/Classes/SocketAnyEvent.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ <h4>Declaration</h4>
282282
</article>
283283
</div>
284284
<section class="footer">
285-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
285+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
286286
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
287287
</section>
288288
</body>

Diff for: ‎docs/Classes/SocketClientManager.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@ <h4>Declaration</h4>
470470
</article>
471471
</div>
472472
<section class="footer">
473-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
473+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
474474
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
475475
</section>
476476
</body>

Diff for: ‎docs/Classes/SocketEngine.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1433,7 +1433,7 @@ <h4>Declaration</h4>
14331433
</article>
14341434
</div>
14351435
<section class="footer">
1436-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
1436+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
14371437
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
14381438
</section>
14391439
</body>

Diff for: ‎docs/Classes/SocketIOClient.html

+35-30
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,8 @@ <h1>SocketIOClient</h1>
179179
</div>
180180
<p>The main class for SocketIOClientSwift.</p>
181181

182+
<p><strong>NOTE</strong>: The client is not thread/queue safe, all interaction with the socket should be done on the <code>handleQueue</code></p>
183+
182184
<p>Represents a socket.io-client. Most interaction with socket.io will be through this class.</p>
183185

184186
</div>
@@ -195,33 +197,6 @@ <h3 class="section-name">Properties</h3>
195197
</a>
196198
</div>
197199
<ul class="item-container">
198-
<li class="item">
199-
<div>
200-
<code>
201-
<a name="/s:vC8SocketIO14SocketIOClient9socketURLV10Foundation3URL"></a>
202-
<a name="//apple_ref/swift/Property/socketURL" class="dashAnchor"></a>
203-
<a class="token" href="#/s:vC8SocketIO14SocketIOClient9socketURLV10Foundation3URL">socketURL</a>
204-
</code>
205-
</div>
206-
<div class="height-container">
207-
<div class="pointer-container"></div>
208-
<section class="section">
209-
<div class="pointer"></div>
210-
<div class="abstract">
211-
<p>The URL of the socket.io server. This is set in the initializer.</p>
212-
213-
</div>
214-
<div class="declaration">
215-
<h4>Declaration</h4>
216-
<div class="language">
217-
<p class="aside-title">Swift</p>
218-
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span></code></pre>
219-
220-
</div>
221-
</div>
222-
</section>
223-
</div>
224-
</li>
225200
<li class="item">
226201
<div>
227202
<code>
@@ -466,6 +441,36 @@ <h4>Declaration</h4>
466441
</section>
467442
</div>
468443
</li>
444+
<li class="item">
445+
<div>
446+
<code>
447+
<a name="/s:vC8SocketIO14SocketIOClient9socketURLV10Foundation3URL"></a>
448+
<a name="//apple_ref/swift/Property/socketURL" class="dashAnchor"></a>
449+
<a class="token" href="#/s:vC8SocketIO14SocketIOClient9socketURLV10Foundation3URL">socketURL</a>
450+
</code>
451+
</div>
452+
<div class="height-container">
453+
<div class="pointer-container"></div>
454+
<section class="section">
455+
<div class="pointer"></div>
456+
<div class="abstract">
457+
<p>The URL of the socket.io server.</p>
458+
459+
<p>If changed after calling <code>init</code>, <code><a href="../Classes/SocketIOClient.html#/s:vC8SocketIO14SocketIOClient8forceNewSb">forceNew</a></code> must be set to <code>true</code>, or it will only connect to the url set in the
460+
init.</p>
461+
462+
</div>
463+
<div class="declaration">
464+
<h4>Declaration</h4>
465+
<div class="language">
466+
<p class="aside-title">Swift</p>
467+
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">socketURL</span><span class="p">:</span> <span class="kt">URL</span></code></pre>
468+
469+
</div>
470+
</div>
471+
</section>
472+
</div>
473+
</li>
469474
</ul>
470475
</div>
471476
<div class="task-group">
@@ -652,7 +657,7 @@ <h4>Declaration</h4>
652657
<h4>Declaration</h4>
653658
<div class="language">
654659
<p class="aside-title">Swift</p>
655-
<pre class="highlight"><code><span class="n">open</span> <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">Int</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="kt">Void</span><span class="p">)?)</span></code></pre>
660+
<pre class="highlight"><code><span class="n">open</span> <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">Int</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>
656661

657662
</div>
658663
</div>
@@ -1585,7 +1590,7 @@ <h4>Return Value</h4>
15851590
<h4>Declaration</h4>
15861591
<div class="language">
15871592
<p class="aside-title">Swift</p>
1588-
<pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">onAny</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Classes/SocketAnyEvent.html">SocketAnyEvent</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
1593+
<pre class="highlight"><code><span class="n">open</span> <span class="kd">func</span> <span class="nf">onAny</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt"><a href="../Classes/SocketAnyEvent.html">SocketAnyEvent</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">())</span></code></pre>
15891594

15901595
</div>
15911596
</div>
@@ -1768,7 +1773,7 @@ <h4>Declaration</h4>
17681773
</article>
17691774
</div>
17701775
<section class="footer">
1771-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
1776+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
17721777
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
17731778
</section>
17741779
</body>

Diff for: ‎docs/Classes/WebSocket.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -906,7 +906,7 @@ <h4>Declaration</h4>
906906
</article>
907907
</div>
908908
<section class="footer">
909-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
909+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
910910
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
911911
</section>
912912
</body>

Diff for: ‎docs/Classes/WebSocket/CloseCode.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ <h1>CloseCode</h1>
368368
</article>
369369
</div>
370370
<section class="footer">
371-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
371+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
372372
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
373373
</section>
374374
</body>

Diff for: ‎docs/Enums.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ <h4>Declaration</h4>
343343
</article>
344344
</div>
345345
<section class="footer">
346-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
346+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
347347
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
348348
</section>
349349
</body>

Diff for: ‎docs/Enums/SocketAckStatus.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ <h4>Declaration</h4>
221221
</article>
222222
</div>
223223
<section class="footer">
224-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
224+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
225225
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
226226
</section>
227227
</body>

Diff for: ‎docs/Enums/SocketClientEvent.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ <h4>Declaration</h4>
376376
</article>
377377
</div>
378378
<section class="footer">
379-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
379+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
380380
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
381381
</section>
382382
</body>

Diff for: ‎docs/Enums/SocketEnginePacketType.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ <h4>Declaration</h4>
407407
</article>
408408
</div>
409409
<section class="footer">
410-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
410+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
411411
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
412412
</section>
413413
</body>

Diff for: ‎docs/Enums/SocketIOClientOption.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -926,7 +926,7 @@ <h4>Return Value</h4>
926926
</article>
927927
</div>
928928
<section class="footer">
929-
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-05-27)</p>
929+
<p>&copy; 2017 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2017-06-18)</p>
930930
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
931931
</section>
932932
</body>

0 commit comments

Comments
 (0)