Skip to content

Commit 6564d1a

Browse files
nuclearacenuclearace
committed
bump version and docs
1 parent 41af615 commit 6564d1a

Some content is hidden

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

42 files changed

+1405
-161
lines changed

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ let package = Package(
8686
.executable(name: "socket.io-test", targets: ["YourTargetName"])
8787
],
8888
dependencies: [
89-
.package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMinor(from: "13.1.0"))
89+
.package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMinor(from: "13.2.0"))
9090
],
9191
targets: [
9292
.target(name: "YourTargetName", dependencies: ["SocketIO"], path: "./Path/To/Your/Sources")
@@ -99,7 +99,7 @@ Then import `import SocketIO`.
9999
### Carthage
100100
Add this line to your `Cartfile`:
101101
```
102-
github "socketio/socket.io-client-swift" ~> 13.1.0
102+
github "socketio/socket.io-client-swift" ~> 13.2.0
103103
```
104104

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

115115
target 'YourApp' do
116-
pod 'Socket.IO-Client-Swift', '~> 13.1.0'
116+
pod 'Socket.IO-Client-Swift', '~> 13.2.0'
117117
end
118118
```
119119

‎Socket.IO-Client-Swift.podspec‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Pod::Spec.new do |s|
22
s.name = "Socket.IO-Client-Swift"
33
s.module_name = "SocketIO"
4-
s.version = "13.1.3"
4+
s.version = "13.2.0"
55
s.summary = "Socket.IO-client for iOS and OS X"
66
s.description = <<-DESC
77
Socket.IO-client for iOS and OS X.
@@ -18,7 +18,7 @@ Pod::Spec.new do |s|
1818
s.requires_arc = true
1919
s.source = {
2020
:git => "https://github.com/socketio/socket.io-client-swift.git",
21-
:tag => 'v13.1.3',
21+
:tag => 'v13.2.0',
2222
:submodules => true
2323
}
2424
s.pod_target_xcconfig = {

‎docs/12to13.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,12 @@
7878
<li class="nav-group-task">
7979
<a class="nav-group-task-link" href="Classes/SocketManager.html">SocketManager</a>
8080
</li>
81+
<li class="nav-group-task">
82+
<a class="nav-group-task-link" href="Classes/SocketRawAckView.html">SocketRawAckView</a>
83+
</li>
84+
<li class="nav-group-task">
85+
<a class="nav-group-task-link" href="Classes/SocketRawView.html">SocketRawView</a>
86+
</li>
8187
</ul>
8288
</li>
8389
<li class="nav-group-name">
@@ -274,7 +280,7 @@ <h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2>
274280
</article>
275281
</div>
276282
<section class="footer">
277-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
283+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-05-16)</p>
278284
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
279285
</section>
280286
</body>

‎docs/Classes.html‎

Lines changed: 78 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,12 @@
7878
<li class="nav-group-task">
7979
<a class="nav-group-task-link" href="Classes/SocketManager.html">SocketManager</a>
8080
</li>
81+
<li class="nav-group-task">
82+
<a class="nav-group-task-link" href="Classes/SocketRawAckView.html">SocketRawAckView</a>
83+
</li>
84+
<li class="nav-group-task">
85+
<a class="nav-group-task-link" href="Classes/SocketRawView.html">SocketRawView</a>
86+
</li>
8187
</ul>
8288
</li>
8389
<li class="nav-group-name">
@@ -207,8 +213,7 @@ <h1>Classes</h1>
207213
<h4>Declaration</h4>
208214
<div class="language">
209215
<p class="aside-title">Swift</p>
210-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</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>
211-
<span class="kt"><a href="Protocols/ConfigSettable.html">ConfigSettable</a></span></code></pre>
216+
<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>
212217

213218
</div>
214219
</div>
@@ -425,6 +430,8 @@ <h4>Declaration</h4>
425430
<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,
426431
or call one of the <code>disconnectSocket</code> methods on this class.</p>
427432

433+
<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>
434+
428435
<a href="Classes/SocketManager.html" class="slightly-smaller">See more</a>
429436
</div>
430437
<div class="declaration">
@@ -440,13 +447,81 @@ <h4>Declaration</h4>
440447
</li>
441448
</ul>
442449
</div>
450+
<div class="task-group">
451+
<ul class="item-container">
452+
<li class="item">
453+
<div>
454+
<code>
455+
<a name="/c:@M@SocketIO@objc(cs)SocketRawView"></a>
456+
<a name="//apple_ref/swift/Class/SocketRawView" class="dashAnchor"></a>
457+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketRawView">SocketRawView</a>
458+
</code>
459+
</div>
460+
<div class="height-container">
461+
<div class="pointer-container"></div>
462+
<section class="section">
463+
<div class="pointer"></div>
464+
<div class="abstract">
465+
<p>Class that gives a backwards compatible way to cause an emit not to recursively check for Data objects.</p>
466+
467+
<p>Usage:</p>
468+
<pre class="highlight swift"><code><span class="n">socket</span><span class="o">.</span><span class="n">rawEmitView</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="n">myObject</span><span class="p">)</span>
469+
</code></pre>
470+
471+
<a href="Classes/SocketRawView.html" class="slightly-smaller">See more</a>
472+
</div>
473+
<div class="declaration">
474+
<h4>Declaration</h4>
475+
<div class="language">
476+
<p class="aside-title">Swift</p>
477+
<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>
478+
479+
</div>
480+
</div>
481+
</section>
482+
</div>
483+
</li>
484+
<li class="item">
485+
<div>
486+
<code>
487+
<a name="/c:@M@SocketIO@objc(cs)SocketRawAckView"></a>
488+
<a name="//apple_ref/swift/Class/SocketRawAckView" class="dashAnchor"></a>
489+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketRawAckView">SocketRawAckView</a>
490+
</code>
491+
</div>
492+
<div class="height-container">
493+
<div class="pointer-container"></div>
494+
<section class="section">
495+
<div class="pointer"></div>
496+
<div class="abstract">
497+
<p>Class that gives a backwards compatible way to cause an emit not to recursively check for Data objects.</p>
498+
499+
<p>Usage:</p>
500+
<pre class="highlight swift"><code><span class="n">ack</span><span class="o">.</span><span class="n">rawEmitView</span><span class="o">.</span><span class="nf">with</span><span class="p">(</span><span class="n">myObject</span><span class="p">)</span>
501+
</code></pre>
502+
503+
<a href="Classes/SocketRawAckView.html" class="slightly-smaller">See more</a>
504+
</div>
505+
<div class="declaration">
506+
<h4>Declaration</h4>
507+
<div class="language">
508+
<p class="aside-title">Swift</p>
509+
<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>
510+
511+
</div>
512+
</div>
513+
</section>
514+
</div>
515+
</li>
516+
</ul>
517+
</div>
443518
</div>
444519
</section>
445520

446521
</article>
447522
</div>
448523
<section class="footer">
449-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
524+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-05-16)</p>
450525
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
451526
</section>
452527
</body>

‎docs/Classes/OnAckCallback.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,12 @@
7979
<li class="nav-group-task">
8080
<a class="nav-group-task-link" href="../Classes/SocketManager.html">SocketManager</a>
8181
</li>
82+
<li class="nav-group-task">
83+
<a class="nav-group-task-link" href="../Classes/SocketRawAckView.html">SocketRawAckView</a>
84+
</li>
85+
<li class="nav-group-task">
86+
<a class="nav-group-task-link" href="../Classes/SocketRawView.html">SocketRawView</a>
87+
</li>
8288
</ul>
8389
</li>
8490
<li class="nav-group-name">
@@ -272,7 +278,7 @@ <h4>Parameters</h4>
272278
</article>
273279
</div>
274280
<section class="footer">
275-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
281+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-05-16)</p>
276282
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
277283
</section>
278284
</body>

‎docs/Classes/SSLSecurity.html‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,12 @@
7979
<li class="nav-group-task">
8080
<a class="nav-group-task-link" href="../Classes/SocketManager.html">SocketManager</a>
8181
</li>
82+
<li class="nav-group-task">
83+
<a class="nav-group-task-link" href="../Classes/SocketRawAckView.html">SocketRawAckView</a>
84+
</li>
85+
<li class="nav-group-task">
86+
<a class="nav-group-task-link" href="../Classes/SocketRawView.html">SocketRawView</a>
87+
</li>
8288
</ul>
8389
</li>
8490
<li class="nav-group-name">
@@ -202,9 +208,9 @@ <h3 class="section-name">Properties</h3>
202208
<li class="item">
203209
<div>
204210
<code>
205-
<a name="/s:8SocketIO11SSLSecurityC8security10StarscreamABCv"></a>
211+
<a name="/s:8SocketIO11SSLSecurityC8security10StarscreamABCvp"></a>
206212
<a name="//apple_ref/swift/Property/security" class="dashAnchor"></a>
207-
<a class="token" href="#/s:8SocketIO11SSLSecurityC8security10StarscreamABCv">security</a>
213+
<a class="token" href="#/s:8SocketIO11SSLSecurityC8security10StarscreamABCvp">security</a>
208214
</code>
209215
</div>
210216
<div class="height-container">
@@ -418,7 +424,7 @@ <h4>Return Value</h4>
418424
</article>
419425
</div>
420426
<section class="footer">
421-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
427+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-05-16)</p>
422428
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
423429
</section>
424430
</body>

‎docs/Classes/SocketAckEmitter.html‎

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,12 @@
7979
<li class="nav-group-task">
8080
<a class="nav-group-task-link" href="../Classes/SocketManager.html">SocketManager</a>
8181
</li>
82+
<li class="nav-group-task">
83+
<a class="nav-group-task-link" href="../Classes/SocketRawAckView.html">SocketRawAckView</a>
84+
</li>
85+
<li class="nav-group-task">
86+
<a class="nav-group-task-link" href="../Classes/SocketRawView.html">SocketRawView</a>
87+
</li>
8288
</ul>
8389
</li>
8490
<li class="nav-group-name">
@@ -192,6 +198,43 @@ <h1>SocketAckEmitter</h1>
192198

193199
<section class="section">
194200
<div class="section-content">
201+
<div class="task-group">
202+
<ul class="item-container">
203+
<li class="item">
204+
<div>
205+
<code>
206+
<a name="/c:@M@SocketIO@objc(cs)SocketAckEmitter(py)rawEmitView"></a>
207+
<a name="//apple_ref/swift/Property/rawEmitView" class="dashAnchor"></a>
208+
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketAckEmitter(py)rawEmitView">rawEmitView</a>
209+
</code>
210+
</div>
211+
<div class="height-container">
212+
<div class="pointer-container"></div>
213+
<section class="section">
214+
<div class="pointer"></div>
215+
<div class="abstract">
216+
<p>A view into this emitter where emits do not check for binary data.</p>
217+
218+
<p>Usage:</p>
219+
<pre class="highlight swift"><code><span class="n">ack</span><span class="o">.</span><span class="n">rawEmitView</span><span class="o">.</span><span class="nf">with</span><span class="p">(</span><span class="n">myObject</span><span class="p">)</span>
220+
</code></pre>
221+
222+
<p><strong>NOTE</strong>: It is not safe to hold on to this view beyond the life of the socket.</p>
223+
224+
</div>
225+
<div class="declaration">
226+
<h4>Declaration</h4>
227+
<div class="language">
228+
<p class="aside-title">Swift</p>
229+
<pre class="highlight swift"><code><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="o">=</span> <span class="nf">SocketRawAckView</span><span class="p">(</span><span class="nv">socket</span><span class="p">:</span> <span class="n">socket</span><span class="p">,</span> <span class="nv">ackNum</span><span class="p">:</span> <span class="n">ackNum</span><span class="p">)</span></code></pre>
230+
231+
</div>
232+
</div>
233+
</section>
234+
</div>
235+
</li>
236+
</ul>
237+
</div>
195238
<div class="task-group">
196239
<div class="task-name-container">
197240
<a name="/Properties"></a>
@@ -204,9 +247,9 @@ <h3 class="section-name">Properties</h3>
204247
<li class="item">
205248
<div>
206249
<code>
207-
<a name="/s:8SocketIO0A10AckEmitterC8expectedSbv"></a>
250+
<a name="/s:8SocketIO0A10AckEmitterC8expectedSbvp"></a>
208251
<a name="//apple_ref/swift/Property/expected" class="dashAnchor"></a>
209-
<a class="token" href="#/s:8SocketIO0A10AckEmitterC8expectedSbv">expected</a>
252+
<a class="token" href="#/s:8SocketIO0A10AckEmitterC8expectedSbvp">expected</a>
210253
</code>
211254
</div>
212255
<div class="height-container">
@@ -311,9 +354,9 @@ <h3 class="section-name">Methods</h3>
311354
<li class="item">
312355
<div>
313356
<code>
314-
<a name="/s:8SocketIO0A10AckEmitterC4withySayAA0A4Data_pGd_tF"></a>
357+
<a name="/s:8SocketIO0A10AckEmitterC4withyAA0A4Data_pd_tF"></a>
315358
<a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a>
316-
<a class="token" href="#/s:8SocketIO0A10AckEmitterC4withySayAA0A4Data_pGd_tF">with(_:)</a>
359+
<a class="token" href="#/s:8SocketIO0A10AckEmitterC4withyAA0A4Data_pd_tF">with(_:)</a>
317360
</code>
318361
</div>
319362
<div class="height-container">
@@ -411,7 +454,7 @@ <h4>Parameters</h4>
411454
</article>
412455
</div>
413456
<section class="footer">
414-
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-03-11)</p>
457+
<p>&copy; 2018 <a class="link" href="https://github.com/socketio/socket.io-client-swift" target="_blank" rel="external">Erik</a>. All rights reserved. (Last updated: 2018-05-16)</p>
415458
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
416459
</section>
417460
</body>

0 commit comments

Comments
 (0)