From 777f6e2406c21a888d53b4473ccf3001ce2d0916 Mon Sep 17 00:00:00 2001
From: Erik
Date: Sun, 18 Jun 2017 12:49:47 -0400
Subject: [PATCH] update docs
---
README.md | 8 +--
docs/Classes.html | 4 +-
docs/Classes/OnAckCallback.html | 2 +-
docs/Classes/SSLCert.html | 2 +-
docs/Classes/SSLSecurity.html | 2 +-
docs/Classes/SocketAckEmitter.html | 2 +-
docs/Classes/SocketAnyEvent.html | 2 +-
docs/Classes/SocketClientManager.html | 2 +-
docs/Classes/SocketEngine.html | 2 +-
docs/Classes/SocketIOClient.html | 65 ++++++++++---------
docs/Classes/WebSocket.html | 2 +-
docs/Classes/WebSocket/CloseCode.html | 2 +-
docs/Enums.html | 2 +-
docs/Enums/SocketAckStatus.html | 2 +-
docs/Enums/SocketClientEvent.html | 2 +-
docs/Enums/SocketEnginePacketType.html | 2 +-
docs/Enums/SocketIOClientOption.html | 2 +-
docs/Enums/SocketIOClientStatus.html | 2 +-
docs/Global Variables.html | 2 +-
docs/Protocols.html | 2 +-
docs/Protocols/SSLTrustValidator.html | 2 +-
docs/Protocols/SocketData.html | 2 +-
docs/Protocols/SocketEngineClient.html | 2 +-
docs/Protocols/SocketEnginePollable.html | 2 +-
docs/Protocols/SocketEngineSpec.html | 2 +-
docs/Protocols/SocketEngineWebsocket.html | 2 +-
docs/Protocols/SocketLogger.html | 2 +-
docs/Protocols/WebSocketDelegate.html | 2 +-
docs/Protocols/WebSocketPongDelegate.html | 2 +-
docs/Structs.html | 2 +-
docs/Structs/SocketIOClientConfiguration.html | 2 +-
docs/Typealiases.html | 58 ++++++++---------
docs/index.html | 10 +--
docs/search.json | 2 +-
34 files changed, 105 insertions(+), 98 deletions(-)
diff --git a/README.md b/README.md
index 578ffab..62172be 100644
--- a/README.md
+++ b/README.md
@@ -82,7 +82,7 @@ import PackageDescription
let package = Package(
name: "YourSocketIOProject",
dependencies: [
- .Package(url: "https://github.com/socketio/socket.io-client-swift", majorVersion: 9)
+ .Package(url: "https://github.com/socketio/socket.io-client-swift", majorVersion: 10)
]
)
```
@@ -92,7 +92,7 @@ Then import `import SocketIO`.
### Carthage
Add this line to your `Cartfile`:
```
-github "socketio/socket.io-client-swift" ~> 10.0.0 # Or latest version
+github "socketio/socket.io-client-swift" ~> 10.0.1 # Or latest version
```
Run `carthage update --platform ios,macosx`.
@@ -104,7 +104,7 @@ Create `Podfile` and add `pod 'Socket.IO-Client-Swift'`:
use_frameworks!
target 'YourApp' do
- pod 'Socket.IO-Client-Swift', '~> 10.0.0' # Or latest version
+ pod 'Socket.IO-Client-Swift', '~> 10.0.1' # Or latest version
end
```
@@ -132,7 +132,7 @@ Objective-C:
Add this line to your `Seedfile`:
```
-github "socketio/socket.io-client-swift", "v10.0.0", :files => "Source/*.swift" # Or latest version
+github "socketio/socket.io-client-swift", "v10.0.1", :files => "Source/*.swift" # Or latest version
```
Run `seed install`.
diff --git a/docs/Classes.html b/docs/Classes.html
index 5a55432..c7efa64 100644
--- a/docs/Classes.html
+++ b/docs/Classes.html
@@ -295,6 +295,8 @@ Example:
The main class for SocketIOClientSwift.
+
NOTE: The client is not thread/queue safe, all interaction with the socket should be done on the handleQueue
+
Represents a socket.io-client. Most interaction with socket.io will be through this class.
See more
@@ -465,7 +467,7 @@ manager["room1"]?.emit("hello")