From d388e1cf037d4dad1a91a6a67ad3bcdd9185d7f3 Mon Sep 17 00:00:00 2001
From: Erik Little
Date: Wed, 10 Jan 2018 09:10:36 -0500
Subject: [PATCH] update docs
---
docs/12to13.html | 18 ++--
docs/Classes.html | 20 ++---
docs/Classes/OnAckCallback.html | 8 +-
docs/Classes/SSLSecurity.html | 14 ++--
docs/Classes/SocketAckEmitter.html | 14 ++--
docs/Classes/SocketAnyEvent.html | 12 +--
docs/Classes/SocketEngine.html | 82 +++++++++----------
docs/Classes/SocketIOClient.html | 72 ++++++++--------
docs/Classes/SocketManager.html | 77 ++++++++---------
docs/Enums.html | 16 ++--
docs/Enums/SocketAckStatus.html | 8 +-
docs/Enums/SocketClientEvent.html | 24 +++---
docs/Enums/SocketEnginePacketType.html | 20 ++---
docs/Enums/SocketIOClientOption.html | 46 +++++------
docs/Enums/SocketIOStatus.html | 18 ++--
docs/Enums/SocketParsableError.html | 12 +--
docs/Guides.html | 4 +-
docs/Protocols.html | 34 ++++----
docs/Protocols/ConfigSettable.html | 8 +-
docs/Protocols/SocketData.html | 14 ++--
docs/Protocols/SocketDataBufferable.html | 8 +-
docs/Protocols/SocketEngineClient.html | 20 ++---
docs/Protocols/SocketEnginePollable.html | 22 ++---
docs/Protocols/SocketEngineSpec.html | 62 +++++++-------
docs/Protocols/SocketEngineWebsocket.html | 12 +--
docs/Protocols/SocketIOClientSpec.html | 66 +++++++--------
docs/Protocols/SocketLogger.html | 12 +--
docs/Protocols/SocketManagerSpec.html | 46 +++++------
docs/Protocols/SocketParsable.html | 10 +--
docs/Structs.html | 10 +--
docs/Structs/SocketEventHandler.html | 14 ++--
docs/Structs/SocketIOClientConfiguration.html | 32 ++++----
docs/Structs/SocketPacket.html | 26 +++---
docs/Structs/SocketPacket/PacketType.html | 20 ++---
docs/Typealiases.html | 8 +-
docs/faq.html | 12 +--
docs/index.html | 10 +--
37 files changed, 456 insertions(+), 455 deletions(-)
diff --git a/docs/12to13.html b/docs/12to13.html
index 85b45e5..ccf8495 100644
--- a/docs/12to13.html
+++ b/docs/12to13.html
@@ -186,8 +186,8 @@ the swift client now only uses one engine per connection. Previously in order to
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")])
+let defaultSocket = SocketIOClient(socketURL: myURL)
+let namespaceSocket = SocketIOClient(socketURL: myURL, config: [.nsp("/swift")])
// add handlers for sockets and connect
@@ -196,7 +196,7 @@ to create multiple clients, and each client had its own engine.
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 manager = SocketManager(socketURL: myURL)
let defaultSocket = manager.defaultSocket
let namespaceSocket = manager.socket(forNamespace: "/swift")
@@ -227,9 +227,9 @@ associated with that namespace.
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 {
+class Manager {
func addHandlers() {
- let socket = SocketIOClient(socketURL: myURL, config: [.nsp("/swift")])
+ let socket = SocketIOClient(socketURL: myURL, config: [.nsp("/swift")])
// Add handlers
}
@@ -239,8 +239,8 @@ associated with that namespace.
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)
+class Manager {
+ let socketManager = SocketManager(socketURL: someURL)
func addHandlers() {
let socket = socketManager.socket(forNamespace: "/swift")
@@ -274,8 +274,8 @@ and a connect event fired.