bump version and docs

socketio · May 16, 2018 · 6564d1a · 6564d1a
1 parent 41af615
commit 6564d1a
Show file tree

Hide file tree

Showing 42 changed files with 1,405 additions and 161 deletions.
diff --git a/README.md b/README.md
@@ -86,7 +86,7 @@ let package = Package(
         .executable(name: "socket.io-test", targets: ["YourTargetName"])
     ],
     dependencies: [
-        .package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMinor(from: "13.1.0"))
+        .package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMinor(from: "13.2.0"))
     ],
     targets: [
         .target(name: "YourTargetName", dependencies: ["SocketIO"], path: "./Path/To/Your/Sources")
@@ -99,7 +99,7 @@ Then import `import SocketIO`.
 ### Carthage
 Add this line to your `Cartfile`:
 ```
-github "socketio/socket.io-client-swift" ~> 13.1.0
+github "socketio/socket.io-client-swift" ~> 13.2.0
 ```
 
 Run `carthage update --platform ios,macosx`.
@@ -113,7 +113,7 @@ Create `Podfile` and add `pod 'Socket.IO-Client-Swift'`:
 use_frameworks!
 
 target 'YourApp' do
-    pod 'Socket.IO-Client-Swift', '~> 13.1.0'
+    pod 'Socket.IO-Client-Swift', '~> 13.2.0'
 end
 ```
 

diff --git a/Socket.IO-Client-Swift.podspec b/Socket.IO-Client-Swift.podspec
@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name         = "Socket.IO-Client-Swift"
   s.module_name  = "SocketIO"
-  s.version      = "13.1.3"
+  s.version      = "13.2.0"
   s.summary      = "Socket.IO-client for iOS and OS X"
   s.description  = <<-DESC
                    Socket.IO-client for iOS and OS X.
@@ -18,7 +18,7 @@ Pod::Spec.new do |s|
   s.requires_arc = true
   s.source = {
     :git => "https://github.com/socketio/socket.io-client-swift.git",
-    :tag => 'v13.1.3',
+    :tag => 'v13.2.0',
     :submodules => true
   }
   s.pod_target_xcconfig = {

diff --git a/docs/12to13.html b/docs/12to13.html
@@ -78,6 +78,12 @@
               <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">
@@ -274,7 +280,7 @@ <h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2>
       </article>
     </div>
     <section class="footer">
-      <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>
+      <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>
       <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>
     </section>
   </body>

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -78,6 +78,12 @@
               <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">
@@ -207,8 +213,7 @@ <h1>Classes</h1>
                         <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">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>
-                                  <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">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>
@@ -425,6 +430,8 @@ <h4>Declaration</h4>
 <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,
 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>
+
                         <a href="Classes/SocketManager.html" class="slightly-smaller">See more</a>
                       </div>
                       <div class="declaration">
@@ -440,13 +447,81 @@ <h4>Declaration</h4>
                 </li>
               </ul>
             </div>
+            <div class="task-group">
+              <ul class="item-container">
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@SocketIO@objc(cs)SocketRawView"></a>
+                    <a name="//apple_ref/swift/Class/SocketRawView" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketRawView">SocketRawView</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Class that gives a backwards compatible way to cause an emit not to recursively check for Data objects.</p>
+
+<p>Usage:</p>
+<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>
+</code></pre>
+
+                        <a href="Classes/SocketRawView.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">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>
+                    </section>
+                  </div>
+                </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@SocketIO@objc(cs)SocketRawAckView"></a>
+                    <a name="//apple_ref/swift/Class/SocketRawAckView" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketRawAckView">SocketRawAckView</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Class that gives a backwards compatible way to cause an emit not to recursively check for Data objects.</p>
+
+<p>Usage:</p>
+<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>
+</code></pre>
+
+                        <a href="Classes/SocketRawAckView.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">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>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
           </div>
         </section>
 
       </article>
     </div>
     <section class="footer">
-      <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>
+      <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>
       <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>
     </section>
   </body>

diff --git a/docs/Classes/OnAckCallback.html b/docs/Classes/OnAckCallback.html
@@ -79,6 +79,12 @@
               <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">
@@ -272,7 +278,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <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>
+      <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>
       <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>
     </section>
   </body>

diff --git a/docs/Classes/SSLSecurity.html b/docs/Classes/SSLSecurity.html
@@ -79,6 +79,12 @@
               <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">
@@ -202,9 +208,9 @@ <h3 class="section-name">Properties</h3>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:8SocketIO11SSLSecurityC8security10StarscreamABCv"></a>
+                    <a name="/s:8SocketIO11SSLSecurityC8security10StarscreamABCvp"></a>
                     <a name="//apple_ref/swift/Property/security" class="dashAnchor"></a>
-                    <a class="token" href="#/s:8SocketIO11SSLSecurityC8security10StarscreamABCv">security</a>
+                    <a class="token" href="#/s:8SocketIO11SSLSecurityC8security10StarscreamABCvp">security</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -418,7 +424,7 @@ <h4>Return Value</h4>
       </article>
     </div>
     <section class="footer">
-      <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>
+      <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>
       <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>
     </section>
   </body>

diff --git a/docs/Classes/SocketAckEmitter.html b/docs/Classes/SocketAckEmitter.html
@@ -79,6 +79,12 @@
               <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">
@@ -192,6 +198,43 @@ <h1>SocketAckEmitter</h1>
 
         <section class="section">
           <div class="section-content">
+            <div class="task-group">
+              <ul class="item-container">
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/c:@M@SocketIO@objc(cs)SocketAckEmitter(py)rawEmitView"></a>
+                    <a name="//apple_ref/swift/Property/rawEmitView" class="dashAnchor"></a>
+                    <a class="token" href="#/c:@M@SocketIO@objc(cs)SocketAckEmitter(py)rawEmitView">rawEmitView</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>A view into this emitter where emits do not check for binary data.</p>
+
+<p>Usage:</p>
+<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>
+</code></pre>
+
+<p><strong>NOTE</strong>: It is not safe to hold on to this view beyond the life of the socket.</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="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>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
+              </ul>
+            </div>
             <div class="task-group">
               <div class="task-name-container">
                 <a name="/Properties"></a>
@@ -204,9 +247,9 @@ <h3 class="section-name">Properties</h3>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:8SocketIO0A10AckEmitterC8expectedSbv"></a>
+                    <a name="/s:8SocketIO0A10AckEmitterC8expectedSbvp"></a>
                     <a name="//apple_ref/swift/Property/expected" class="dashAnchor"></a>
-                    <a class="token" href="#/s:8SocketIO0A10AckEmitterC8expectedSbv">expected</a>
+                    <a class="token" href="#/s:8SocketIO0A10AckEmitterC8expectedSbvp">expected</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -311,9 +354,9 @@ <h3 class="section-name">Methods</h3>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:8SocketIO0A10AckEmitterC4withySayAA0A4Data_pGd_tF"></a>
+                    <a name="/s:8SocketIO0A10AckEmitterC4withyAA0A4Data_pd_tF"></a>
                     <a name="//apple_ref/swift/Method/with(_:)" class="dashAnchor"></a>
-                    <a class="token" href="#/s:8SocketIO0A10AckEmitterC4withySayAA0A4Data_pGd_tF">with(_:)</a>
+                    <a class="token" href="#/s:8SocketIO0A10AckEmitterC4withyAA0A4Data_pd_tF">with(_:)</a>
                     </code>
                   </div>
                   <div class="height-container">
@@ -411,7 +454,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <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>
+      <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>
       <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>
     </section>
   </body>