Start working on migration guide

Author: nuclearace

README.md

@@ -31,56 +31,23 @@ socket.on("currentAmount") {data, ack in
 socket.connect()
 ```
 
-## Objective-C Example
-```objective-c
-@import SocketIO;
-
-NSURL* url = [[NSURL alloc] initWithString:@"http://localhost:8080"];
-SocketManager* manager = [[SocketManager alloc] initWithSocketURL:url config:@{@"log": @YES, @"compress": @YES}];
-SocketIOClient* socket = manager.defaultSocket;
-
-[socket on:@"connect" callback:^(NSArray* data, SocketAckEmitter* ack) {
-    NSLog(@"socket connected");
-}];
-
-[socket on:@"currentAmount" callback:^(NSArray* data, SocketAckEmitter* ack) {
-    double cur = [[data objectAtIndex:0] floatValue];
-
-    [[socket emitWithAck:@"canUpdate" with:@[@(cur)]] timingOutAfter:0 callback:^(NSArray* data) {
-        if ([[data[0] description] isEqualToString:@"NO ACK"]) {
-            // Handle ack timeout
-        }
-
-        [socket emit:@"update" with:@[@{@"amount": @(cur + 2.50)}]];
-    }];
-
-    [ack with:@[@"Got your currentAmount, ", @"dude"]];
-}];
-
-[socket connect];
-
-```
-
 ## Features
-- Supports socket.io 2.0+ (For socket.io 1.0 use v9.x)
-- Supports binary
+- Supports socket.io 3.0+ (For socket.io 1.0 use v9.x, For socket.io 2.0 use 15.x)
+- Supports Binary
 - Supports Polling and WebSockets
 - Supports TLS/SSL
-- Can be used from Objective-C
 
 ## FAQS
 Checkout the [FAQs](https://nuclearace.github.io/Socket.IO-Client-Swift/faq.html) for commonly asked questions.
 
+
 Checkout the [12to13](https://nuclearace.github.io/Socket.IO-Client-Swift/12to13.html) guide for migrating to v13+ from v12 below.
 
+Checkout the [15to16](https://nuclearace.github.io/Socket.IO-Client-Swift/15to16.html) guide for migrating to v16+ from v15.
 
 ## Installation
 Requires Swift 4/5 and Xcode 10.x
 
-If you need Swift 2.3 use the [swift2.3 tag](https://github.com/socketio/socket.io-client-swift/releases/tag/swift2.3) (Pre-Swift 4 support is no longer maintained)
-
-If you need Swift 3.x use v11.1.3.
-
 ### Swift Package Manager
 Add the project as a dependency to your Package.swift:
 ```swift

Source/SocketIO/Engine/SocketEngine.swift

@@ -681,6 +681,11 @@ enum EngineError: Error {
 }
 
 extension SocketEngine {
+    /// Delegate method for WebSocketDelegate.
+    ///
+    /// - Parameters:
+    ///   - event: WS Event
+    ///   - _:
     public func didReceive(event: WebSocketEvent, client _: WebSocket) {
         switch event {
         case let .connected(headers):

Usage Docs/15to16.md

@@ -0,0 +1,3 @@
+# Upgrading from v15 to v16
+
+This guide will help you navigate the changes that were introduced in v16.

docs/12to13.html

@@ -20,7 +20,7 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="index.html">
-          SocketIO Docs
+          SocketIO 16.0.0-beta2 Docs
         </a>
          (100% documented)
       </p>
@@ -49,6 +49,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="12to13.html">12to13</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="15to16.html">15to16</a>
+              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="faq.html">FAQ</a>
               </li>
@@ -60,9 +63,6 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Classes/OnAckCallback.html">OnAckCallback</a>
               </li>
-              <li class="nav-group-task">
-                <a class="nav-group-task-link" href="Classes/SSLSecurity.html">SSLSecurity</a>
-              </li>
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Classes/SocketAckEmitter.html">SocketAckEmitter</a>
               </li>
@@ -109,6 +109,47 @@
               </li>
             </ul>
           </li>
+          <li class="nav-group-name">
+            <a class="nav-group-name-link" href="Extensions.html">Extensions</a>
+            <ul class="nav-group-tasks">
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/s:Sa">Array</a>
+              </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/s:Sb">Bool</a>
+              </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/s:10Foundation4DataV">Data</a>
+              </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/s:SD">Dictionary</a>
+              </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/s:Sd">Double</a>
+              </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/s:Si">Int</a>
+              </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSArray">NSArray</a>
+              </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSData">NSData</a>
+              </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSDictionary">NSDictionary</a>
+              </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSNull">NSNull</a>
+              </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/c:objc(cs)NSString">NSString</a>
+              </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Extensions.html#/s:SS">String</a>
+              </li>
+            </ul>
+          </li>
           <li class="nav-group-name">
             <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
             <ul class="nav-group-tasks">
@@ -183,7 +224,7 @@
       <article class="main-content">
 
         <section class="section">
-          <div class="section-content">
+          <div class="section-content top-matter">
 
             <h1 id='upgrading-from-v12' class='heading'>Upgrading from v12</h1>
 
@@ -195,8 +236,8 @@ <h2 id='what-are-the-big-changes' class='heading'>What are the big changes?</h2>
 to create multiple clients, and each client had its own engine.</p>
 
 <p>Some v12 code might&rsquo;ve looked like this:</p>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">defaultSocket</span> <span class="o">=</span> <span class="nf">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">)</span>
-<span class="k">let</span> <span class="nv">namespaceSocket</span> <span class="o">=</span> <span class="nf">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</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">nsp</span><span class="p">(</span><span class="s">"/swift"</span><span class="p">)])</span>
+<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">defaultSocket</span> <span class="o">=</span> <span class="kt">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">)</span>
+<span class="k">let</span> <span class="nv">namespaceSocket</span> <span class="o">=</span> <span class="kt">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</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">nsp</span><span class="p">(</span><span class="s">"/swift"</span><span class="p">)])</span>
 
 <span class="c1">// add handlers for sockets and connect</span>
 
@@ -205,7 +246,7 @@ <h2 id='what-are-the-big-changes' class='heading'>What are the big changes?</h2>
 <p>In v12 this would have opened two connections to the socket.io.</p>
 
 <p>In v13 the same code would look like this:</p>
-<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="nf">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">)</span>
+<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">manager</span> <span class="o">=</span> <span class="kt">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</span><span class="p">)</span>
 <span class="k">let</span> <span class="nv">defaultSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">defaultSocket</span>
 <span class="k">let</span> <span class="nv">namespaceSocket</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span>
 
@@ -236,9 +277,9 @@ <h2 id='how-sockets-are-stored' class='heading'>How sockets are stored</h2>
 <p>You should know that <code><a href="Classes/SocketIOClient.html">SocketIOClient</a></code>s no longer need to be held around in properties, but the <code><a href="Classes/SocketManager.html">SocketManager</a></code> should.</p>
 
 <p>One of the most common mistakes people made is not maintaining a strong reference to the client.</p>
-<pre class="highlight swift"><code><span class="kd">class</span> <span class="nf">Manager</span> <span class="p">{</span>
+<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">Manager</span> <span class="p">{</span>
     <span class="kd">func</span> <span class="nf">addHandlers</span><span class="p">()</span> <span class="p">{</span>
-        <span class="k">let</span> <span class="nv">socket</span> <span class="o">=</span> <span class="nf">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</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">nsp</span><span class="p">(</span><span class="s">"/swift"</span><span class="p">)])</span>
+        <span class="k">let</span> <span class="nv">socket</span> <span class="o">=</span> <span class="kt">SocketIOClient</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">myURL</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">nsp</span><span class="p">(</span><span class="s">"/swift"</span><span class="p">)])</span>
 
         <span class="c1">// Add handlers</span>
     <span class="p">}</span>
@@ -248,8 +289,8 @@ <h2 id='how-sockets-are-stored' class='heading'>How sockets are stored</h2>
 <p>This would have resulted in the client being released and no handlers being called.</p>
 
 <p>A <em>correct</em> equivalent would be:</p>
-<pre class="highlight swift"><code><span class="kd">class</span> <span class="nf">Manager</span> <span class="p">{</span>
-    <span class="k">let</span> <span class="nv">socketManager</span> <span class="o">=</span> <span class="nf">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">someURL</span><span class="p">)</span>
+<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">Manager</span> <span class="p">{</span>
+    <span class="k">let</span> <span class="nv">socketManager</span> <span class="o">=</span> <span class="kt">SocketManager</span><span class="p">(</span><span class="nv">socketURL</span><span class="p">:</span> <span class="n">someURL</span><span class="p">)</span>
 
     <span class="kd">func</span> <span class="nf">addHandlers</span><span class="p">()</span> <span class="p">{</span>
         <span class="k">let</span> <span class="nv">socket</span> <span class="o">=</span> <span class="n">socketManager</span><span class="o">.</span><span class="nf">socket</span><span class="p">(</span><span class="nv">forNamespace</span><span class="p">:</span> <span class="s">"/swift"</span><span class="p">)</span>
@@ -268,7 +309,7 @@ <h2 id='how-sockets-are-stored' class='heading'>How sockets are stored</h2>
 <h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2>
 
 <p>Connect can either be called on the manager directly, or on one of the sockets made from it. In either case, if the manager
-was not already connected to the server, a connection will be made. Also in both cases the default socket (namespace <q>/</q>)
+was not already connected to the server, a connection will be made. Also in both cases the default socket (namespace &ldquo;/&rdquo;)
 will fire a <code>connect</code> event. </p>
 
 <p>The difference is that if <code>connect()</code> is just called on the manager, then any sockets for that manager that are not the default
@@ -283,8 +324,8 @@ <h2 id='what-to-call-connect-on' class='heading'>What to call connect on</h2>
       </article>
     </div>
     <section class="footer">
-      <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>
-      <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>
+      <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>
+      <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>
     </section>
   </body>
 </div>