From b6a8984ce0b992344f2c23e37b4d6dd68421b6b6 Mon Sep 17 00:00:00 2001 From: Erik Little Date: Sun, 12 Nov 2017 11:36:35 -0500 Subject: [PATCH] update docs --- docs/12to13.html | 282 ++++ docs/Classes.html | 77 +- docs/Classes/OnAckCallback.html | 24 +- docs/Classes/SSLSecurity.html | 24 +- docs/Classes/SocketAckEmitter.html | 24 +- docs/Classes/SocketAnyEvent.html | 24 +- docs/Classes/SocketEngine.html | 74 +- docs/Classes/SocketIOClient.html | 797 +++------ docs/Classes/SocketManager.html | 1470 +++++++++++++++++ docs/Enums.html | 36 +- docs/Enums/SocketAckStatus.html | 24 +- docs/Enums/SocketClientEvent.html | 138 +- docs/Enums/SocketEnginePacketType.html | 24 +- docs/Enums/SocketIOClientOption.html | 119 +- docs/Enums/SocketIOStatus.html | 395 +++++ docs/Enums/SocketParsableError.html | 24 +- docs/Guides.html | 24 +- docs/Protocols.html | 132 +- docs/Protocols/ConfigSettable.html | 254 +++ docs/Protocols/SocketData.html | 24 +- docs/Protocols/SocketDataBufferable.html | 240 +++ docs/Protocols/SocketEngineClient.html | 78 +- docs/Protocols/SocketEnginePollable.html | 24 +- docs/Protocols/SocketEngineSpec.html | 53 +- docs/Protocols/SocketEngineWebsocket.html | 36 +- docs/Protocols/SocketIOClientSpec.html | 286 ++-- docs/Protocols/SocketLogger.html | 24 +- docs/Protocols/SocketManagerSpec.html | 840 ++++++++++ docs/Protocols/SocketParsable.html | 83 +- docs/Structs.html | 24 +- docs/Structs/SocketEventHandler.html | 24 +- docs/Structs/SocketIOClientConfiguration.html | 24 +- docs/Structs/SocketPacket.html | 24 +- docs/Structs/SocketPacket/PacketType.html | 24 +- docs/Typealiases.html | 24 +- docs/badge.svg | 29 +- docs/faq.html | 48 +- docs/index.html | 50 +- docs/search.json | 2 +- 39 files changed, 4785 insertions(+), 1142 deletions(-) create mode 100644 docs/12to13.html create mode 100644 docs/Classes/SocketManager.html create mode 100644 docs/Enums/SocketIOStatus.html create mode 100644 docs/Protocols/ConfigSettable.html create mode 100644 docs/Protocols/SocketDataBufferable.html create mode 100644 docs/Protocols/SocketManagerSpec.html diff --git a/docs/12to13.html b/docs/12to13.html new file mode 100644 index 0000000..4acabbe --- /dev/null +++ b/docs/12to13.html @@ -0,0 +1,282 @@ + + + + 12to13 Reference + + + + + + + + + + + + + + + +
+

+ + SocketIO Docs + + (100% documented) +

+ +

+

+ +
+

+ + +
+ +

+ SocketIO Reference + + 12to13 Reference +

+ +
+ +
+ +
+
+ +

Upgrading from v12

+ +

This guide will help you navigate the changes that were introduced in v13.

+

What are the big changes?

+ +

The biggest change is how to create and manage clients. Much like the native JS client and server, +the swift client now only uses one engine per connection. Previously in order to use namespaces it was required +to create multiple clients, and each client had its own engine.

+ +

Some v12 code might’ve looked like this:

+
let defaultSocket = SocketIOClient(socketURL: myURL)
+let namespaceSocket = SocketIOClient(socketURL: myURL, config: [.nsp("/swift")])
+
+// add handlers for sockets and connect
+
+
+ +

In v12 this would have opened two connections to the socket.io.

+ +

In v13 the same code would look like this:

+
let manager = SocketManager(socketURL: myURL)
+let defaultSocket = manager.defaultSocket
+let namespaceSocket = manager.socket(forNamespace: "/swift")
+
+// add handlers for sockets and connect
+
+ +

In v13 defaultSocket and namespaceSocket will share a single transport. This means one less connection to the server +needs to be opened.

+

What might I have to change?

+ +
    +

  • The most obvious thing you will need to change is that instead of creating SocketIOClients directly, you will create a +SocketManager and either use the defaultSocket property if you don’t need namespaces, or call the +socket(forNamespace:) method on the manager.

    • +

  • SocketIOClient is no longer a client to an engine. So if you were overriding the engine methods, these have been moved +to the manager.

    • +

  • The library is now a single target. So you might have to change some of your Xcode project settings.

    • +

  • SocketIOClients no longer take a configuration, they are shared from the manager.

    • +

  • The joinNamespace() and leaveNamespace() methods on SocketIOClient no longer take any arguments, and in most cases +no longer need to be called. Namespace joining/leaving can be managed by calling connect()/disconnect() on the socket +associated with that namespace.

    • +
+ +
+

What things should I know?

+

How sockets are stored

+ +

You should know that SocketIOClients no longer need to be held around in properties, but the SocketManager should.

+ +

One of the most common mistakes people made is not maintaining a strong reference to the client.

+
class Manager {
+    func addHandlers() {
+        let socket = SocketIOClient(socketURL: myURL, config: [.nsp("/swift")])
+
+        // Add handlers
+    }
+}
+
+ +

This would have resulted in the client being released and no handlers being called.

+ +

A correct equivalent would be:

+
class Manager {
+    let socketManager = SocketManager(socketURL: someURL)
+
+    func addHandlers() {
+        let socket = socketManager.socket(forNamespace: "/swift")
+
+        // Add handlers
+    }
+}
+
+ +

This code is fine because the SocketManager will maintain a strong reference to the socket.

+ +

It’s also worth noting that subsequent calls to socket(forNamespace:) will return the same socket instance as the +first call. So you don’t need to hold onto the socket directly just to access it again, just call socket(forNamespace:) +on the manager to get it. This does mean that if you need multiple sockets on the same namespace, you will have to use +multiple managers.

+

What to call connect on

+ +

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 /) +will fire a connect event.

+ +

The difference is that if connect() is just called on the manager, then any sockets for that manager that are not the default +socket will not automatically connect. connect() will need to be called individually for each socket. However, if connect() +is called on a client, then in addition to opening the connection if needed, the client will connect to the its namespace, +and a connect event fired.

+ +
+
+ + +
+
+
+

© 2017 Erik. All rights reserved. (Last updated: 2017-11-12)

+

Generated by jazzy ♪♫ v0.9.0, a Realm project.

+
+ + + diff --git a/docs/Classes.html b/docs/Classes.html index 16ec807..a6fa116 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -46,6 +46,9 @@
  • Guides
  • @@ -93,7 +96,7 @@ SocketIOClientOption
  • - SocketIOClientStatus + SocketIOStatus
  • SocketParsableError @@ -103,9 +106,15 @@
  • Protocols