Merge pull request #527 from brian-dlee/master

Documents `disconnect` behavior in README
2018-07-20 16:50:59 -05:00
parent d2bf71599a 9811225d21
commit 70fd033db6
1 changed files with 6 additions and 0 deletions
@@ -160,6 +160,12 @@ The disconnect method does what you would expect and closes the socket.
 socket.disconnect()
 ```

+The socket can be forcefully closed, by specifying a timeout (in milliseconds). A timeout of zero will also close the socket immediately without waiting on the server.
+
+```swift
+socket.disconnect(forceTimeout: 10, closeCode: CloseCode.normal.rawValue)
+```
+
 ### isConnected

 Returns if the socket is connected or not.