Skip to content

Commit 5dcfe18

Browse files
nuclearacenuclearace
committed
bump version and docs
1 parent 558ea65 commit 5dcfe18

Some content is hidden

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

46 files changed

+152
-204
lines changed

‎Socket.IO-Client-Swift.podspec

+2-2
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 = "15.0.0"
4+
s.version = "15.1.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 => 'v15.0.0',
21+
:tag => 'v15.1.0',
2222
:submodules => true
2323
}
2424

‎Source/SocketIO/Ack/SocketAckEmitter.swift

+1
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ public final class OnAckCallback : NSObject {
115115
self.binary = binary
116116
}
117117

118+
/// :nodoc:
118119
deinit {
119120
DefaultSocketLogger.Logger.log("OnAckCallback for \(ackNumber) being released", type: "OnAckCallback")
120121
}

‎Source/SocketIO/Client/SocketIOClient.swift

+1
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ open class SocketIOClient : NSObject, SocketIOClientSpec {
107107
super.init()
108108
}
109109

110+
/// :nodoc:
110111
deinit {
111112
DefaultSocketLogger.Logger.log("Client is being released", type: logType)
112113
}

‎Source/SocketIO/Engine/SocketEngine.swift

+2-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ open class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePollable, So
113113
/// If `true`, then the engine is currently in WebSockets mode.
114114
@available(*, deprecated, message: "No longer needed, if we're not polling, then we must be doing websockets")
115115
public private(set) var websocket = false
116-
116+
117117
/// When `true`, the WebSocket `stream` will be configured with the enableSOCKSProxy `true`.
118118
public private(set) var enableSOCKSProxy = false
119119

@@ -170,6 +170,7 @@ open class SocketEngine : NSObject, URLSessionDelegate, SocketEnginePollable, So
170170
self.init(client: client, url: url, config: options?.toSocketConfiguration() ?? [])
171171
}
172172

173+
/// :nodoc:
173174
deinit {
174175
DefaultSocketLogger.Logger.log("Engine is being released", type: SocketEngine.logType)
175176
closed = true

‎Source/SocketIO/Manager/SocketManager.swift

+1
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ open class SocketManager : NSObject, SocketManagerSpec, SocketParsable, SocketDa
158158
self.init(socketURL: socketURL, config: config?.toSocketConfiguration() ?? [])
159159
}
160160

161+
/// :nodoc:
161162
deinit {
162163
DefaultSocketLogger.Logger.log("Manager is being released", type: SocketManager.logType)
163164

‎docs/12to13.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<a class="header-link" href="index.html">
2323
SocketIO Docs
2424
</a>
25-
(98% documented)
25+
(100% documented)
2626
</p>
2727

2828
<p class="header-col--secondary">
@@ -283,7 +283,7 @@ <h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2>
283283
</article>
284284
</div>
285285
<section class="footer">
286-
<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-03-28)</p>
286+
<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>
287287
<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>
288288
</section>
289289
</body>

‎docs/Classes.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="index.html">
2424
SocketIO Docs
2525
</a>
26-
(98% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -525,7 +525,7 @@ <h4>Declaration</h4>
525525
</article>
526526
</div>
527527
<section class="footer">
528-
<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-03-28)</p>
528+
<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>
529529
<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>
530530
</section>
531531
</body>

‎docs/Classes/OnAckCallback.html

+2-33
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
SocketIO Docs
2525
</a>
26-
(98% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -205,37 +205,6 @@ <h1>OnAckCallback</h1>
205205

206206
<section class="section">
207207
<div class="section-content">
208-
<div class="task-group">
209-
<ul class="item-container">
210-
<li class="item">
211-
<div>
212-
<code>
213-
<a name="/c:@M@SocketIO@objc(cs)OnAckCallback(im)dealloc"></a>
214-
<a name="//apple_ref/swift/Method/deinit" class="dashAnchor"></a>
215-
<a class="token" href="#/c:@M@SocketIO@objc(cs)OnAckCallback(im)dealloc">deinit</a>
216-
</code>
217-
</div>
218-
<div class="height-container">
219-
<div class="pointer-container"></div>
220-
<section class="section">
221-
<div class="pointer"></div>
222-
<div class="abstract">
223-
<p>Undocumented</p>
224-
225-
</div>
226-
<div class="declaration">
227-
<h4>Declaration</h4>
228-
<div class="language">
229-
<p class="aside-title">Swift</p>
230-
<pre class="highlight swift"><code><span class="kd">deinit</span></code></pre>
231-
232-
</div>
233-
</div>
234-
</section>
235-
</div>
236-
</li>
237-
</ul>
238-
</div>
239208
<div class="task-group">
240209
<div class="task-name-container">
241210
<a name="/Methods"></a>
@@ -313,7 +282,7 @@ <h4>Parameters</h4>
313282
</article>
314283
</div>
315284
<section class="footer">
316-
<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-03-28)</p>
285+
<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>
317286
<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>
318287
</section>
319288
</body>

‎docs/Classes/SSLSecurity.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
SocketIO Docs
2525
</a>
26-
(98% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -428,7 +428,7 @@ <h4>Return Value</h4>
428428
</article>
429429
</div>
430430
<section class="footer">
431-
<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-03-28)</p>
431+
<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>
432432
<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>
433433
</section>
434434
</body>

‎docs/Classes/SocketAckEmitter.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
SocketIO Docs
2525
</a>
26-
(98% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -459,7 +459,7 @@ <h4>Parameters</h4>
459459
</article>
460460
</div>
461461
<section class="footer">
462-
<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-03-28)</p>
462+
<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>
463463
<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>
464464
</section>
465465
</body>

‎docs/Classes/SocketAnyEvent.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
SocketIO Docs
2525
</a>
26-
(98% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -299,7 +299,7 @@ <h4>Declaration</h4>
299299
</article>
300300
</div>
301301
<section class="footer">
302-
<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-03-28)</p>
302+
<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>
303303
<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>
304304
</section>
305305
</body>

‎docs/Classes/SocketEngine.html

+31-29
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
SocketIO Docs
2525
</a>
26-
(98% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -839,6 +839,35 @@ <h4>Declaration</h4>
839839
<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>
840840
<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>
841841
<span class="k">get</span>
842+
<span class="p">}</span></code></pre>
843+
844+
</div>
845+
</div>
846+
</section>
847+
</div>
848+
</li>
849+
<li class="item">
850+
<div>
851+
<code>
852+
<a name="/s:8SocketIO0A6EngineC16enableSOCKSProxySbvp"></a>
853+
<a name="//apple_ref/swift/Property/enableSOCKSProxy" class="dashAnchor"></a>
854+
<a class="token" href="#/s:8SocketIO0A6EngineC16enableSOCKSProxySbvp">enableSOCKSProxy</a>
855+
</code>
856+
</div>
857+
<div class="height-container">
858+
<div class="pointer-container"></div>
859+
<section class="section">
860+
<div class="pointer"></div>
861+
<div class="abstract">
862+
<p>When <code>true</code>, the WebSocket <code>stream</code> will be configured with the enableSOCKSProxy <code>true</code>.</p>
863+
864+
</div>
865+
<div class="declaration">
866+
<h4>Declaration</h4>
867+
<div class="language">
868+
<p class="aside-title">Swift</p>
869+
<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>
870+
<span class="k">get</span>
842871
<span class="p">}</span></code></pre>
843872

844873
</div>
@@ -1053,33 +1082,6 @@ <h4>Parameters</h4>
10531082
</section>
10541083
</div>
10551084
</li>
1056-
<li class="item">
1057-
<div>
1058-
<code>
1059-
<a name="/c:@M@SocketIO@objc(cs)SocketEngine(im)dealloc"></a>
1060-
<a name="//apple_ref/swift/Method/deinit" class="dashAnchor"></a>
1061-
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketEngine(im)dealloc">deinit</a>
1062-
</code>
1063-
</div>
1064-
<div class="height-container">
1065-
<div class="pointer-container"></div>
1066-
<section class="section">
1067-
<div class="pointer"></div>
1068-
<div class="abstract">
1069-
<p>Undocumented</p>
1070-
1071-
</div>
1072-
<div class="declaration">
1073-
<h4>Declaration</h4>
1074-
<div class="language">
1075-
<p class="aside-title">Swift</p>
1076-
<pre class="highlight swift"><code><span class="kd">deinit</span></code></pre>
1077-
1078-
</div>
1079-
</div>
1080-
</section>
1081-
</div>
1082-
</li>
10831085
</ul>
10841086
</div>
10851087
<div class="task-group">
@@ -1500,7 +1502,7 @@ <h4>Declaration</h4>
15001502
</article>
15011503
</div>
15021504
<section class="footer">
1503-
<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-03-28)</p>
1505+
<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>
15041506
<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>
15051507
</section>
15061508
</body>

‎docs/Classes/SocketIOClient.html

+2-29
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
SocketIO Docs
2525
</a>
26-
(98% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -486,33 +486,6 @@ <h4>Parameters</h4>
486486
</section>
487487
</div>
488488
</li>
489-
<li class="item">
490-
<div>
491-
<code>
492-
<a name="/c:@M@SocketIO@objc(cs)SocketIOClient(im)dealloc"></a>
493-
<a name="//apple_ref/swift/Method/deinit" class="dashAnchor"></a>
494-
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketIOClient(im)dealloc">deinit</a>
495-
</code>
496-
</div>
497-
<div class="height-container">
498-
<div class="pointer-container"></div>
499-
<section class="section">
500-
<div class="pointer"></div>
501-
<div class="abstract">
502-
<p>Undocumented</p>
503-
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">deinit</span></code></pre>
510-
511-
</div>
512-
</div>
513-
</section>
514-
</div>
515-
</li>
516489
</ul>
517490
</div>
518491
<div class="task-group">
@@ -1991,7 +1964,7 @@ <h4>Parameters</h4>
19911964
</article>
19921965
</div>
19931966
<section class="footer">
1994-
<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-03-28)</p>
1967+
<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>
19951968
<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>
19961969
</section>
19971970
</body>

‎docs/Classes/SocketManager.html

+2-29
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
SocketIO Docs
2525
</a>
26-
(98% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -719,33 +719,6 @@ <h4>Parameters</h4>
719719
</section>
720720
</div>
721721
</li>
722-
<li class="item">
723-
<div>
724-
<code>
725-
<a name="/c:@M@SocketIO@objc(cs)SocketManager(im)dealloc"></a>
726-
<a name="//apple_ref/swift/Method/deinit" class="dashAnchor"></a>
727-
<a class="token" href="#/c:@M@SocketIO@objc(cs)SocketManager(im)dealloc">deinit</a>
728-
</code>
729-
</div>
730-
<div class="height-container">
731-
<div class="pointer-container"></div>
732-
<section class="section">
733-
<div class="pointer"></div>
734-
<div class="abstract">
735-
<p>Undocumented</p>
736-
737-
</div>
738-
<div class="declaration">
739-
<h4>Declaration</h4>
740-
<div class="language">
741-
<p class="aside-title">Swift</p>
742-
<pre class="highlight swift"><code><span class="kd">deinit</span></code></pre>
743-
744-
</div>
745-
</div>
746-
</section>
747-
</div>
748-
</li>
749722
</ul>
750723
</div>
751724
<div class="task-group">
@@ -1674,7 +1647,7 @@ <h4>Return Value</h4>
16741647
</article>
16751648
</div>
16761649
<section class="footer">
1677-
<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-03-28)</p>
1650+
<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>
16781651
<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>
16791652
</section>
16801653
</body>

0 commit comments

Comments
 (0)