SwiftWebSocket
Conforming WebSocket (RFC 6455) client library for iOS and Mac OSX.
SwiftWebSocket passes all 521 of the Autobahn's fuzzing tests, including strict UTF-8, and message compression.
Project Status
I'm looking for someone to help with or take over maintenance of this project.
Features
- High performance.
- 100% conforms to Autobahn Tests. Including base, limits, compression, etc. Test results.
- TLS / WSS support. Self-signed certificate option.
- The API is modeled after the Javascript API.
- Reads compressed messages (
permessage-deflate). RFC 7692 - Send pings and receive pong events.
- Strict UTF-8 processing.
binaryTypeproperty to choose between[UInt8]orNSDatamessages.- Zero asserts. All networking, stream, and protocol errors are routed through the
errorevent. - iOS / Objective-C support.
Example
func echoTest(){
var messageNum = 0
let ws = WebSocket("wss://echo.websocket.org")
let send : ()->() = {
messageNum += 1
let msg = "\(messageNum): \(NSDate().description)"
print("send: \(msg)")
ws.send(msg)
}
ws.event.open = {
print("opened")
send()
}
ws.event.close = { code, reason, clean in
print("close")
}
ws.event.error = { error in
print("error \(error)")
}
ws.event.message = { message in
if let text = message as? String {
print("recv: \(text)")
if messageNum == 10 {
ws.close()
} else {
send()
}
}
}
}
Custom Headers
var request = URLRequest(url: URL(string:"ws://url")!)
request.addValue("AUTH_TOKEN", forHTTPHeaderField: "Authorization")
request.addValue("Value", forHTTPHeaderField: "X-Another-Header")
let ws = WebSocket(request: request)
Reuse and Delaying WebSocket Connections
v2.3.0+ makes available an optional open method. This will allow for a WebSocket object to be instantiated without an immediate connection to the server. It can also be used to reconnect to a server following the close event.
For example,
let ws = WebSocket()
ws.event.close = { _,_,_ in
ws.open() // reopen the socket to the previous url
ws.open("ws://otherurl") // or, reopen the socket to a new url
}
ws.open("ws://url") // call with url
Compression
The compression flag may be used to request compressed messages from the server. If the server does not support or accept the request, then connection will continue as normal, but with uncompressed messages.
let ws = WebSocket("ws://url")
ws.compression.on = true
Self-signed SSL Certificate
let ws = WebSocket("ws://url")
ws.allowSelfSignedSSL = true
Network Services (VoIP, Video, Background, Voice)
// Allow socket to handle VoIP in the background.
ws.services = [.VoIP, .Background]
Installation (iOS and OS X)
Carthage
Add the following to your Cartfile:
github "tidwall/SwiftWebSocket"
Then run carthage update.
Follow the current instructions in Carthage's README for up to date installation instructions.
The import SwiftWebSocket directive is required in order to access SwiftWebSocket features.
CocoaPods
Add the following to your Podfile:
use_frameworks!
pod 'SwiftWebSocket'
Then run pod install with CocoaPods 0.36 or newer.
The import SwiftWebSocket directive is required in order to access SwiftWebSocket features.
Manually
Copy the SwiftWebSocket/WebSocket.swift file into your project.
You must also add the libz.dylib library. Project -> Target -> Build Phases -> Link Binary With Libraries
There is no need for import SwiftWebSocket when manually installing.
Contact
Josh Baker @tidwall
License
SwiftWebSocket source code is available under the MIT License.
7.5k Jan 4, 2023
574 Dec 7, 2022
4.9k Jan 9, 2023
1.6k Jan 3, 2023
1.3k Jan 3, 2023
0 Dec 24, 2021
36 Jan 29, 2022
9.4k Dec 27, 2022
1.2k Dec 29, 2022
3 Apr 2, 2022
6 Sep 1, 2022
63 Jan 29, 2022
5 Oct 19, 2022
2 Sep 16, 2022