handle trailing slash better. bumped version

HTTP headers are case insensitive

.swift-version

@@ -0,0 +1 @@
+4.0

CHANGELOG.md

@@ -2,6 +2,112 @@
 All notable changes to this project will be documented in this file.
 `Starscream` adheres to [Semantic Versioning](http://semver.org/).
 
+#### [3.0.1](https://github.com/daltoniam/Starscream/tree/3.0.2)
+
+Small fixes for 3.0.1.
+
+[#394](https://github.com/daltoniam/Starscream/issues/394)
+[#392](https://github.com/daltoniam/Starscream/issues/392)
+[#391](https://github.com/daltoniam/Starscream/issues/391)
+
+#### [3.0.1](https://github.com/daltoniam/Starscream/tree/3.0.1)
+
+Small fixes for 3.0.0.
+
+[#389](https://github.com/daltoniam/Starscream/issues/389)
+[#354](https://github.com/daltoniam/Starscream/issues/354)
+[#386](https://github.com/daltoniam/Starscream/pull/386)
+[#388](https://github.com/daltoniam/Starscream/pull/388)
+[#390](https://github.com/daltoniam/Starscream/pull/390)
+
+#### [3.0.0](https://github.com/daltoniam/Starscream/tree/3.0.0)
+
+Major refactor and Swift 4 support. Additions include:
+
+- Watchos support.
+- Linux support.
+- New Stream class to allow custom socket implementations if desired.
+- Protocol added for mocking (dependency injection).
+- Single framework (no more platform suffixes! e.g. StarscreamOSX, StarscreamTVOS, etc).
+
+[#384](https://github.com/daltoniam/Starscream/issues/384)
+[#377](https://github.com/daltoniam/Starscream/pull/377)
+[#374](https://github.com/daltoniam/Starscream/issues/374)
+[#346](https://github.com/daltoniam/Starscream/issues/346)
+[#335](https://github.com/daltoniam/Starscream/issues/335)
+[#311](https://github.com/daltoniam/Starscream/pull/311)
+[#269](https://github.com/daltoniam/Starscream/issues/269)
+
+#### [2.1.1](https://github.com/daltoniam/Starscream/tree/2.1.1)
+
+Fixes race condition. Updated to avoid SPM dependencies.
+
+[#370](https://github.com/daltoniam/Starscream/issues/370)
+[#367](https://github.com/daltoniam/Starscream/issues/367)
+[#364](https://github.com/daltoniam/Starscream/pull/364)
+[#357](https://github.com/daltoniam/Starscream/pull/357)
+[#355](https://github.com/daltoniam/Starscream/pull/355)
+
+#### [2.1.0](https://github.com/daltoniam/Starscream/tree/2.1.0)
+
+Adds WebSocket compression. Also adds advance WebSocket delegate for extra control. Bug Fixes.
+
+[#349](https://github.com/daltoniam/Starscream/pull/349)
+[#344](https://github.com/daltoniam/Starscream/pull/344)
+[#339](https://github.com/daltoniam/Starscream/pull/339)
+[#337](https://github.com/daltoniam/Starscream/pull/337)
+[#334](https://github.com/daltoniam/Starscream/issues/334)
+[#333](https://github.com/daltoniam/Starscream/pull/333)
+[#319](https://github.com/daltoniam/Starscream/issues/319)
+[#309](https://github.com/daltoniam/Starscream/issues/309)
+[#329](https://github.com/daltoniam/Starscream/issues/329)
+
+#### [2.0.4](https://github.com/daltoniam/Starscream/tree/2.0.4)
+
+SSL Pinning fix by Giuliano Galea as reported by Lukas Futera of [Centralway](https://www.centralway.com/de/).
+Warning fixes for Swift 3.1
+
+#### [2.0.3](https://github.com/daltoniam/Starscream/tree/2.0.3)
+
+[#302](https://github.com/daltoniam/Starscream/issues/302)
+[#301](https://github.com/daltoniam/Starscream/issues/301)
+[#300](https://github.com/daltoniam/Starscream/issues/300)
+[#296](https://github.com/daltoniam/Starscream/issues/296)
+[#294](https://github.com/daltoniam/Starscream/issues/294)
+[#292](https://github.com/daltoniam/Starscream/issues/292)
+[#289](https://github.com/daltoniam/Starscream/issues/289)
+[#288](https://github.com/daltoniam/Starscream/issues/288)
+
+#### [2.0.2](https://github.com/daltoniam/Starscream/tree/2.0.2)
+
+Fix for the Swift Package Manager.
+
+Fixed: 
+[#277](https://github.com/daltoniam/Starscream/issues/277)
+
+#### [2.0.1](https://github.com/daltoniam/Starscream/tree/2.0.1)
+
+Bug fixes.
+
+Fixed: 
+[#261](https://github.com/daltoniam/Starscream/issues/261)
+[#276](https://github.com/daltoniam/Starscream/issues/276)
+[#267](https://github.com/daltoniam/Starscream/issues/267)
+[#266](https://github.com/daltoniam/Starscream/issues/266)
+[#259](https://github.com/daltoniam/Starscream/issues/259)
+
+#### [2.0.0](https://github.com/daltoniam/Starscream/tree/2.0.0)
+
+Added Swift 3 support.
+
+Fixed: 
+[#229](https://github.com/daltoniam/Starscream/issues/229)
+[#232](https://github.com/daltoniam/Starscream/issues/232)
+
+#### [1.1.4](https://github.com/daltoniam/Starscream/tree/1.1.4)
+
+Swift 2.3 support.
+
 #### [1.1.3](https://github.com/daltoniam/Starscream/tree/1.1.3)
 
 Changed: 
@@ -47,4 +153,4 @@ Fixes for #121, #123
 
 #### [1.0.0](https://github.com/daltoniam/Starscream/tree/1.0.0)
 
-first release of Swift 2 support.
+first release of Swift 2 support.

Cartfile

@@ -0,0 +1,2 @@
+github "daltoniam/zlib-spm" ~> 1.1
+github "daltoniam/common-crypto-spm" ~> 1.1

Cartfile.resolved

@@ -0,0 +1,2 @@
+github "daltoniam/zlib-spm" "1.1"
+github "daltoniam/common-crypto-spm" "1.1"

LICENSE

@@ -2,7 +2,7 @@
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 
-   Copyright (c) 2014-2015 Dalton Cherry.
+   Copyright (c) 2014-2016 Dalton Cherry.
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 

Package.swift

@@ -3,7 +3,7 @@
 //  Starscream
 //
 //  Created by Dalton Cherry on 5/16/15.
-//  Copyright (c) 2014-2015 Dalton Cherry.
+//  Copyright (c) 2014-2016 Dalton Cherry.
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");
 //  you may not use this file except in compliance with the License.
@@ -21,5 +21,12 @@
 import PackageDescription
 
 let package = Package(
-    name: "Starscream"
-)
+    name: "Starscream",
+    dependencies: [
+        .Package(url: "https://github.com/daltoniam/zlib-spm.git",
+    majorVersion: 1, minor: 1),
+        .Package(url: "https://github.com/daltoniam/common-crypto-spm",
+                 majorVersion: 1, minor: 1),
+        ],
+    exclude: ["Tests", "examples"]
+)

README.md

@@ -1,17 +1,15 @@
 ![starscream](https://raw.githubusercontent.com/daltoniam/starscream/assets/starscream.jpg)
 
-Starscream is a conforming WebSocket ([RFC 6455](http://tools.ietf.org/html/rfc6455)) client library in Swift for iOS and OSX.
+Starscream is a conforming WebSocket ([RFC 6455](http://tools.ietf.org/html/rfc6455)) client library in Swift.
 
-It's Objective-C counter part can be found here: [Jetfire](https://github.com/acmacalister/jetfire)
-
-###Swift 3/Xcode 8
-If you are looking for Swift 3 support, see [swift 3 here](https://github.com/daltoniam/Starscream/tree/swift3)
+Its Objective-C counterpart can be found here: [Jetfire](https://github.com/acmacalister/jetfire)
 
 ## Features
 
 - Conforms to all of the base [Autobahn test suite](http://autobahn.ws/testsuite/).
 - Nonblocking. Everything happens in the background, thanks to GCD.
 - TLS/WSS support.
+- Compression Extensions support ([RFC 7692](https://tools.ietf.org/html/rfc7692))
 - Simple concise codebase at just a few hundred LOC.
 
 ## Example
@@ -25,7 +23,7 @@ import Starscream
 Once imported, you can open a connection to your WebSocket server. Note that `socket` is probably best as a property, so it doesn't get deallocated right after being setup.
 
 ```swift
-socket = WebSocket(url: NSURL(string: "ws://localhost:8080/")!)
+socket = WebSocket(url: URL(string: "ws://localhost:8080/")!)
 socket.delegate = self
 socket.connect()
 ```
@@ -37,7 +35,7 @@ After you are connected, there are some delegate methods that we need to impleme
 websocketDidConnect is called as soon as the client connects to the server.
 
 ```swift
-func websocketDidConnect(socket: WebSocket) {
+func websocketDidConnect(socket: WebSocketClient) {
     print("websocket is connected")
 }
 ```
@@ -47,7 +45,7 @@ func websocketDidConnect(socket: WebSocket) {
 websocketDidDisconnect is called as soon as the client is disconnected from the server.
 
 ```swift
-func websocketDidDisconnect(socket: WebSocket, error: NSError?) {
+func websocketDidDisconnect(socket: WebSocketClient, error: Error?) {
 	print("websocket is disconnected: \(error?.localizedDescription)")
 }
 ```
@@ -57,7 +55,7 @@ func websocketDidDisconnect(socket: WebSocket, error: NSError?) {
 websocketDidReceiveMessage is called when the client gets a text frame from the connection.
 
 ```swift
-func websocketDidReceiveMessage(socket: WebSocket, text: String) {
+func websocketDidReceiveMessage(socket: WebSocketClient, text: String) {
 	print("got some text: \(text)")
 }
 ```
@@ -67,8 +65,8 @@ func websocketDidReceiveMessage(socket: WebSocket, text: String) {
 websocketDidReceiveData is called when the client gets a binary frame from the connection.
 
 ```swift
-func websocketDidReceiveData(socket: WebSocket, data: NSData) {
-	print("got some data: \(data.length)")
+func websocketDidReceiveData(socket: WebSocketClient, data: Data) {
+	print("got some data: \(data.count)")
 }
 ```
 
@@ -77,21 +75,21 @@ func websocketDidReceiveData(socket: WebSocket, data: NSData) {
 websocketDidReceivePong is called when the client gets a pong response from the connection. You need to implement the WebSocketPongDelegate protocol and set an additional delegate, eg: ` socket.pongDelegate = self`
 
 ```swift
-func websocketDidReceivePong(socket: WebSocket) {
-	print("Got pong!")
+func websocketDidReceivePong(socket: WebSocketClient, data: Data?) {
+	print("Got pong! Maybe some data: \(data?.count)")
 }
 ```
 
 Or you can use closures.
 
 ```swift
-socket = WebSocket(url: NSURL(string: "ws://localhost:8080/")!)
+socket = WebSocket(url: URL(string: "ws://localhost:8080/")!)
 //websocketDidConnect
 socket.onConnect = {
     print("websocket is connected")
 }
 //websocketDidDisconnect
-socket.onDisconnect = { (error: NSError?) in
+socket.onDisconnect = { (error: Error?) in
     print("websocket is disconnected: \(error?.localizedDescription)")
 }
 //websocketDidReceiveMessage
@@ -99,40 +97,40 @@ socket.onText = { (text: String) in
     print("got some text: \(text)")
 }
 //websocketDidReceiveData
-socket.onData = { (data: NSData) in
-    print("got some data: \(data.length)")
+socket.onData = { (data: Data) in
+    print("got some data: \(data.count)")
 }
 //you could do onPong as well.
 socket.connect()
 ```
 
-One more: you can listen to socket connection and disconnection via notifications. Starscream posts `WebsocketDidConnectNotification` and `WebsocketDidDisconnectNotification`. You can find an `NSError` that caused the disconection by accessing `WebsocketDisconnectionErrorKeyName` on notification `userInfo`.
+One more: you can listen to socket connection and disconnection via notifications. Starscream posts `WebsocketDidConnectNotification` and `WebsocketDidDisconnectNotification`. You can find an `Error` that caused the disconection by accessing `WebsocketDisconnectionErrorKeyName` on notification `userInfo`.
 
 
 ## The delegate methods give you a simple way to handle data from the server, but how do you send data?
 
-### writeData
+### write a binary frame
 
-The writeData method gives you a simple way to send `NSData` (binary) data to the server.
+The writeData method gives you a simple way to send `Data` (binary) data to the server.
 
 ```swift
-socket.writeData(data) //write some NSData over the socket!
+socket.write(data: data) //write some Data over the socket!
 ```
 
-### writeString
+### write a string frame
 
 The writeString method is the same as writeData, but sends text/string.
 
 ```swift
-socket.writeString("Hi Server!") //example on how to write text over the socket!
+socket.write(string: "Hi Server!") //example on how to write text over the socket!
 ```
 
-### writePing
+### write a ping frame
 
-The writePing method is the same as writeData, but sends a ping control frame.
+The writePing method is the same as write, but sends a ping control frame.
 
 ```swift
-socket.writePing(NSData()) //example on how to write a ping control frame over the socket!
+socket.write(ping: Data()) //example on how to write a ping control frame over the socket!
 ```
 
 ### disconnect
@@ -158,9 +156,23 @@ if socket.isConnected {
 You can also override the default websocket headers with your own custom ones like so:
 
 ```swift
-socket.headers["Sec-WebSocket-Protocol"] = "someother protocols"
-socket.headers["Sec-WebSocket-Version"] = "14"
-socket.headers["My-Awesome-Header"] = "Everything is Awesome!"
+var request = URLRequest(url: URL(string: "ws://localhost:8080/")!)
+request.timeoutInterval = 5
+request.setValue("someother protocols", forHTTPHeaderField: "Sec-WebSocket-Protocol")
+request.setValue("14", forHTTPHeaderField: "Sec-WebSocket-Version")
+request.setValue("Everything is Awesome!", forHTTPHeaderField: "My-Awesome-Header")
+let socket = WebSocket(request: request)
+```
+
+### Custom HTTP Method
+
+Your server may use a different HTTP method when connecting to the websocket:
+
+```swift
+var request = URLRequest(url: URL(string: "ws://localhost:8080/")!)
+request.httpMethod = "POST"
+request.timeoutInterval = 5
+let socket = WebSocket(request: request)
 ```
 
 ### Protocols
@@ -169,45 +181,64 @@ If you need to specify a protocol, simple add it to the init:
 
 ```swift
 //chat and superchat are the example protocols here
-socket = WebSocket(url: NSURL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])
+socket = WebSocket(url: URL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])
 socket.delegate = self
 socket.connect()
 ```
 
-### Self Signed SSL and VOIP
-
-There are a couple of other properties that modify the stream:
+### Self Signed SSL
 
 ```swift
-socket = WebSocket(url: NSURL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])
+socket = WebSocket(url: URL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])
 
-//set this if you are planning on using the socket in a VOIP background setting (using the background VOIP service).
-socket.voipEnabled = true
-
-//set this you want to ignore SSL cert validation, so a self signed SSL certificate can be used.
-socket.selfSignedSSL = true
+//set this if you want to ignore SSL cert validation, so a self signed SSL certificate can be used.
+socket.disableSSLCertValidation = true
 ```
 
 ### SSL Pinning
 
-SSL Pinning is also supported in Starscream. 
+SSL Pinning is also supported in Starscream.
 
 ```swift
-socket = WebSocket(url: NSURL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])
+socket = WebSocket(url: URL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])
 let data = ... //load your certificate from disk
 socket.security = SSLSecurity(certs: [SSLCert(data: data)], usePublicKeys: true)
 //socket.security = SSLSecurity() //uses the .cer files in your app's bundle
 ```
-You load either a `NSData` blob of your certificate or you can use a `SecKeyRef` if you have a public key you want to use. The `usePublicKeys` bool is whether to use the certificates for validation or the public keys. The public keys will be extracted from the certificates automatically if `usePublicKeys` is choosen.
+You load either a `Data` blob of your certificate or you can use a `SecKeyRef` if you have a public key you want to use. The `usePublicKeys` bool is whether to use the certificates for validation or the public keys. The public keys will be extracted from the certificates automatically if `usePublicKeys` is choosen.
+
+### SSL Cipher Suites
+
+To use an SSL encrypted connection, you need to tell Starscream about the cipher suites your server supports. 
+
+```swift
+socket = WebSocket(url: URL(string: "wss://localhost:8080/")!, protocols: ["chat","superchat"])
+
+// Set enabled cipher suites to AES 256 and AES 128
+socket.enabledSSLCipherSuites = [TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256] 
+```
+
+If you don't know which cipher suites are supported by your server, you can try pointing [SSL Labs](https://www.ssllabs.com/ssltest/) at it and checking the results.
+
+### Compression Extensions
+
+Compression Extensions ([RFC 7692](https://tools.ietf.org/html/rfc7692)) is supported in Starscream.  Compression is enabled by default, however compression will only be used if it is supported by the server as well.  You may enable or disable compression via the `.enableCompression` property:
+
+```swift
+socket = WebSocket(url: URL(string: "ws://localhost:8080/")!)
+socket.enableCompression = false
+```
+
+Compression should be disabled if your application is transmitting already-compressed, random, or other uncompressable data.
 
 ### Custom Queue
 
-A custom queue can be specified when delegate methods are called. By default `dispatch_get_main_queue` is used, thus making all delegate methods calls run on the main thread. It is important to note that all WebSocket processing is done on a background thread, only the delegate method calls are changed when modifying the queue. The actual processing is always on a background thread and will not pause your app.
+A custom queue can be specified when delegate methods are called. By default `DispatchQueue.main` is used, thus making all delegate methods calls run on the main thread. It is important to note that all WebSocket processing is done on a background thread, only the delegate method calls are changed when modifying the queue. The actual processing is always on a background thread and will not pause your app.
 
 ```swift
-socket = WebSocket(url: NSURL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])
+socket = WebSocket(url: URL(string: "ws://localhost:8080/")!, protocols: ["chat","superchat"])
 //create a custom queue
-socket.queue = dispatch_queue_create("com.vluxe.starscream.myapp", nil)
+socket.callbackQueue = DispatchQueue(label: "com.vluxe.starscream.myapp")
 ```
 
 ## Example Project
@@ -230,7 +261,7 @@ To use Starscream in your project add the following 'Podfile' to your project
 	platform :ios, '9.0'
 	use_frameworks!
 
-	pod 'Starscream', '~> 1.1.3'
+	pod 'Starscream', '~> 3.0.2'
 
 Then run:
 
@@ -252,7 +283,7 @@ $ brew install carthage
 To integrate Starscream into your Xcode project using Carthage, specify it in your `Cartfile`:
 
 ```
-github "daltoniam/Starscream" >= 1.1.3
+github "daltoniam/Starscream" >= 3.0.2
 ```
 
 ### Rogue
@@ -262,11 +293,23 @@ First see the [installation docs](https://github.com/acmacalister/Rogue) for how
 To install Starscream run the command below in the directory you created the rogue file.
 
 ```
-rogue add https://github.com/daltoniam/starscream
+rogue add https://github.com/daltoniam/Starscream
 ```
 
 Next open the `libs` folder and add the `Starscream.xcodeproj` to your Xcode project. Once that is complete, in your "Build Phases" add the `Starscream.framework` to your "Link Binary with Libraries" phase. Make sure to add the `libs` folder to your `.gitignore` file.
 
+### Swift Package Manager
+
+The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler.
+
+Once you have your Swift package set up, adding Starscream as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
+
+```swift
+dependencies: [
+    .Package(url: "https://github.com/daltoniam/Starscream.git", majorVersion: 3)
+]
+```
+
 ### Other
 
 Simply grab the framework (either via git submodule or another package manager).
@@ -277,11 +320,54 @@ Add the `Starscream.xcodeproj` to your Xcode project. Once that is complete, in
 
 If you are running this in an OSX app or on a physical iOS device you will need to make sure you add the `Starscream.framework` to be included in your app bundle. To do this, in Xcode, navigate to the target configuration window by clicking on the blue project icon, and selecting the application target under the "Targets" heading in the sidebar. In the tab bar at the top of that window, open the "Build Phases" panel. Expand the "Link Binary with Libraries" group, and add `Starscream.framework`. Click on the + button at the top left of the panel and select "New Copy Files Phase". Rename this new phase to "Copy Frameworks", set the "Destination" to "Frameworks", and add `Starscream.framework` respectively.
 
+
+## WebSocketAdvancedDelegate
+The advanced delegate acts just like the simpler delegate but provides some additional information on the connection and incoming frames.
+
+```swift
+socket.advancedDelegate = self
+```
+
+In most cases you do not need the extra info and should use the normal delegate.
+
+#### websocketDidReceiveMessage
+```swift
+func websocketDidReceiveMessage(socket: WebSocketClient, text: String, response: WebSocket.WSResponse {
+	print("got some text: \(text)")
+	print("First frame for this message arrived on \(response.firstFrame)")
+}
+```
+
+#### websocketDidReceiveData
+```swift
+func websocketDidReceiveData(socket: WebSocketClient, data: Date, response: WebSocket.WSResponse) {
+	print("got some data it long: \(data.count)")
+	print("A total of \(response.frameCount) frames were used to send this data")
+}
+```
+
+#### websocketHttpUpgrade
+These methods are called when the HTTP upgrade request is sent and when the response returns.
+```swift
+func  websocketHttpUpgrade(socket: WebSocketClient, request: CFHTTPMessage) {
+	print("the http request was sent we can check the raw http if we need to")
+}
+```
+
+```swift
+func  websocketHttpUpgrade(socket: WebSocketClient, response: CFHTTPMessage) {
+	print("the http response has returned.")
+}
+```
+
+## KNOWN ISSUES
+- WatchOS does not have the the CFNetwork String constants to modify the stream's SSL behavior. It will be the default Foundation SSL behavior. This means watchOS CANNOT use `SSLCiphers`,  `disableSSLCertValidation`, or SSL pinning. All these values set on watchOS will do nothing. 
+- Linux does not have the security framework, so it CANNOT use SSL pinning or `SSLCiphers` either. 
+
+
 ## TODOs
 
-- [ ] WatchOS?
-- [ ] Linux Support?
-- [ ] Add Unit Tests - Local Swift websocket server
+- [ ] Add Unit Tests - Local WebSocket server that runs against Autobahn
 
 ## License
 

Source/Info-tvOS.plist

@@ -1,30 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>CFBundleDevelopmentRegion</key>
-	<string>en</string>
-	<key>CFBundleExecutable</key>
-	<string>$(EXECUTABLE_NAME)</string>
-	<key>CFBundleIdentifier</key>
-	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
-	<key>CFBundleInfoDictionaryVersion</key>
-	<string>6.0</string>
-	<key>CFBundleName</key>
-	<string>$(PRODUCT_NAME)</string>
-	<key>CFBundlePackageType</key>
-	<string>FMWK</string>
-	<key>CFBundleShortVersionString</key>
-	<string>1.1.3</string>
-	<key>CFBundleSignature</key>
-	<string>????</string>
-	<key>CFBundleVersion</key>
-	<string>$(CURRENT_PROJECT_VERSION)</string>
-	<key>NSPrincipalClass</key>
-	<string></string>
-	<key>UIRequiredDeviceCapabilities</key>
-	<array>
-		<string>arm64</string>
-	</array>
-</dict>
-</plist>

Source/WebSocket.swift

@@ -1,880 +0,0 @@
-//////////////////////////////////////////////////////////////////////////////////////////////////
-//
-//  Websocket.swift
-//
-//  Created by Dalton Cherry on 7/16/14.
-//  Copyright (c) 2014-2015 Dalton Cherry.
-//
-//  Licensed under the Apache License, Version 2.0 (the "License");
-//  you may not use this file except in compliance with the License.
-//  You may obtain a copy of the License at
-//
-//  http://www.apache.org/licenses/LICENSE-2.0
-//
-//  Unless required by applicable law or agreed to in writing, software
-//  distributed under the License is distributed on an "AS IS" BASIS,
-//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-//  See the License for the specific language governing permissions and
-//  limitations under the License.
-//
-//////////////////////////////////////////////////////////////////////////////////////////////////
-
-import Foundation
-import CoreFoundation
-import Security
-
-public let WebsocketDidConnectNotification = "WebsocketDidConnectNotification"
-public let WebsocketDidDisconnectNotification = "WebsocketDidDisconnectNotification"
-public let WebsocketDisconnectionErrorKeyName = "WebsocketDisconnectionErrorKeyName"
-
-public protocol WebSocketDelegate: class {
-    func websocketDidConnect(_ socket: WebSocket)
-    func websocketDidDisconnect(_ socket: WebSocket, error: NSError?)
-    func websocketDidReceiveMessage(_ socket: WebSocket, text: String)
-    func websocketDidReceiveData(_ socket: WebSocket, data: Data)
-}
-
-public protocol WebSocketPongDelegate: class {
-    func websocketDidReceivePong(_ socket: WebSocket)
-}
-
-public class WebSocket : NSObject, StreamDelegate {
-    
-    enum OpCode : UInt8 {
-        case continueFrame = 0x0
-        case textFrame = 0x1
-        case binaryFrame = 0x2
-        // 3-7 are reserved.
-        case connectionClose = 0x8
-        case ping = 0x9
-        case pong = 0xA
-        // B-F reserved.
-    }
-    
-    public enum CloseCode : UInt16 {
-        case normal                 = 1000
-        case goingAway              = 1001
-        case protocolError          = 1002
-        case protocolUnhandledType  = 1003
-        // 1004 reserved.
-        case noStatusReceived       = 1005
-        //1006 reserved.
-        case encoding               = 1007
-        case policyViolated         = 1008
-        case messageTooBig          = 1009
-    }
-
-    public static let ErrorDomain = "WebSocket"
-
-    enum InternalErrorCode: UInt16 {
-        // 0-999 WebSocket status codes not used
-        case outputStreamWriteError = 1
-    }
-
-    // Where the callback is executed. It defaults to the main UI thread queue.
-    public var callbackQueue        = DispatchQueue.main
-
-    var optionalProtocols       : [String]?
-
-    // MARK: - Constants
-
-    let headerWSUpgradeName     = "Upgrade"
-    let headerWSUpgradeValue    = "websocket"
-    let headerWSHostName        = "Host"
-    let headerWSConnectionName  = "Connection"
-    let headerWSConnectionValue = "Upgrade"
-    let headerWSProtocolName    = "Sec-WebSocket-Protocol"
-    let headerWSVersionName     = "Sec-WebSocket-Version"
-    let headerWSVersionValue    = "13"
-    let headerWSKeyName         = "Sec-WebSocket-Key"
-    let headerOriginName        = "Origin"
-    let headerWSAcceptName      = "Sec-WebSocket-Accept"
-    let BUFFER_MAX              = 4096
-    let FinMask: UInt8          = 0x80
-    let OpCodeMask: UInt8       = 0x0F
-    let RSVMask: UInt8          = 0x70
-    let MaskMask: UInt8         = 0x80
-    let PayloadLenMask: UInt8   = 0x7F
-    let MaxFrameSize: Int       = 32
-    let httpSwitchProtocolCode  = 101
-    let supportedSSLSchemes     = ["wss", "https"]
-
-    class WSResponse {
-        var isFin = false
-        var code: OpCode = .continueFrame
-        var bytesLeft = 0
-        var frameCount = 0
-        var buffer: NSMutableData?
-    }
-
-    // MARK: - Delegates
-
-    /// Responds to callback about new messages coming in over the WebSocket
-    /// and also connection/disconnect messages.
-    public weak var delegate: WebSocketDelegate?
-
-    /// Recives a callback for each pong message recived.
-    public weak var pongDelegate: WebSocketPongDelegate?
-
-
-    // MARK: - Block based API.
-
-    public var onConnect: ((Void) -> Void)?
-    public var onDisconnect: ((NSError?) -> Void)?
-    public var onText: ((String) -> Void)?
-    public var onData: ((Data) -> Void)?
-    public var onPong: ((Void) -> Void)?
-
-    public var headers = [String: String]()
-    public var voipEnabled = false
-    public var selfSignedSSL = false
-    public var security: SSLSecurity?
-    public var enabledSSLCipherSuites: [SSLCipherSuite]?
-    public var origin: String?
-    public var timeout = 5
-    public var isConnected :Bool {
-        return connected
-    }
-    
-    public var currentURL: URL { return url }
-
-    // MARK: - Private
-
-    private var url: URL
-    private var inputStream: InputStream?
-    private var outputStream: OutputStream?
-    private var connected = false
-    private var isConnecting = false
-    private var writeQueue = OperationQueue()
-    private var readStack = [WSResponse]()
-    private var inputQueue = [Data]()
-    private var fragBuffer: Data?
-    private var certValidated = false
-    private var didDisconnect = false
-    private var readyToWrite = false
-    private let mutex = NSLock()
-    private let notificationCenter = NotificationCenter.default
-    private var canDispatch: Bool {
-        mutex.lock()
-        let canWork = readyToWrite
-        mutex.unlock()
-        return canWork
-    }
-    /// The shared processing queue used for all WebSocket.
-    private static let sharedWorkQueue = DispatchQueue(label: "com.vluxe.starscream.websocket", attributes: [])
-    
-    /// Used for setting protocols.
-    public init(url: URL, protocols: [String]? = nil) {
-        self.url = url
-        self.origin = url.absoluteString
-        writeQueue.maxConcurrentOperationCount = 1
-        optionalProtocols = protocols
-    }
-
-    /// Connect to the WebSocket server on a background thread.
-    public func connect() {
-        guard !isConnecting else { return }
-        didDisconnect = false
-        isConnecting = true
-        createHTTPRequest()
-        isConnecting = false
-    }
-
-    /**
-     Disconnect from the server. I send a Close control frame to the server, then expect the server to respond with a Close control frame and close the socket from its end. I notify my delegate once the socket has been closed.
-
-     If you supply a non-nil `forceTimeout`, I wait at most that long (in seconds) for the server to close the socket. After the timeout expires, I close the socket and notify my delegate.
-
-     If you supply a zero (or negative) `forceTimeout`, I immediately close the socket (without sending a Close control frame) and notify my delegate.
-
-     - Parameter forceTimeout: Maximum time to wait for the server to close the socket.
-    */
-    public func disconnect(forceTimeout: TimeInterval? = nil) {
-        switch forceTimeout {
-        case .some(let seconds) where seconds > 0:
-            callbackQueue.asyncAfter(deadline: DispatchTime.now() + Double(Int64(seconds * Double(NSEC_PER_SEC))) / Double(NSEC_PER_SEC)) { [weak self] in
-                self?.disconnectStream(nil)
-            }
-            fallthrough
-        case .none:
-            writeError(CloseCode.normal.rawValue)
-        default:
-            disconnectStream(nil)
-            break
-        }
-    }
-
-    /**
-     Write a string to the websocket. This sends it as a text frame.
-
-     If you supply a non-nil completion block, I will perform it when the write completes.
-
-     - parameter str:        The string to write.
-     - parameter completion: The (optional) completion handler.
-     */
-    public func write(string: String, completion: (() -> ())? = nil) {
-        guard isConnected else { return }
-        dequeueWrite(string.data(using: String.Encoding.utf8)!, code: .textFrame, writeCompletion: completion)
-    }
-
-    /**
-     Write binary data to the websocket. This sends it as a binary frame.
-
-     If you supply a non-nil completion block, I will perform it when the write completes.
-
-     - parameter data:       The data to write.
-     - parameter completion: The (optional) completion handler.
-     */
-    public func write(data: Data, completion: (() -> ())? = nil) {
-        guard isConnected else { return }
-        dequeueWrite(data, code: .binaryFrame, writeCompletion: completion)
-    }
-    
-    // Write a ping to the websocket. This sends it as a control frame.
-    // Yodel a   sound  to the planet.    This sends it as an astroid. http://youtu.be/Eu5ZJELRiJ8?t=42s
-    public func write(_ ping: Data, completion: (() -> ())? = nil) {
-        guard isConnected else { return }
-        dequeueWrite(ping, code: .ping, writeCompletion: completion)
-    }
-
-    /// Private method that starts the connection.
-    private func createHTTPRequest() {
-
-        let urlRequest = CFHTTPMessageCreateRequest(kCFAllocatorDefault, "GET" as CFString,
-                                                    url as CFURL, kCFHTTPVersion1_1).takeRetainedValue()
-
-        var port = url.port
-        if port == nil {
-            if supportedSSLSchemes.contains(url.scheme!) {
-                port = 443
-            } else {
-                port = 80
-            }
-        }
-        addHeader(urlRequest, key: headerWSUpgradeName, val: headerWSUpgradeValue)
-        addHeader(urlRequest, key: headerWSConnectionName, val: headerWSConnectionValue)
-        if let protocols = optionalProtocols {
-            addHeader(urlRequest, key: headerWSProtocolName, val: protocols.joined(separator: ","))
-        }
-        addHeader(urlRequest, key: headerWSVersionName, val: headerWSVersionValue)
-        addHeader(urlRequest, key: headerWSKeyName, val: generateWebSocketKey())
-        if let origin = origin {
-            addHeader(urlRequest, key: headerOriginName, val: origin)
-        }
-        addHeader(urlRequest, key: headerWSHostName, val: "\(url.host!):\(port!)")
-        for (key,value) in headers {
-            addHeader(urlRequest, key: key, val: value)
-        }
-        if let cfHTTPMessage = CFHTTPMessageCopySerializedMessage(urlRequest) {
-            let serializedRequest = cfHTTPMessage.takeRetainedValue()
-            initStreamsWithData(serializedRequest as Data, Int(port!))
-        }
-    }
-    
-    // Add a header to the CFHTTPMessage by using the NSString bridges to CFString
-    private func addHeader(_ urlRequest: CFHTTPMessage, key: String, val: String) {
-        CFHTTPMessageSetHeaderFieldValue(urlRequest, key as CFString, val as CFString)
-    }
-
-    /// Generate a WebSocket key as needed in RFC.
-    private func generateWebSocketKey() -> String {
-        var key = ""
-        let seed = 16
-        for _ in 0..<seed {
-            let uni = UnicodeScalar(UInt32(97 + arc4random_uniform(25)))
-            key += "\(Character(uni!))"
-        }
-        let data = key.data(using: String.Encoding.utf8)
-        let baseKey = data?.base64EncodedString(options: NSData.Base64EncodingOptions(rawValue: 0))
-        return baseKey!
-    }
-    
-    /// Start the stream connection and write the data to the output stream.
-    private func initStreamsWithData(_ data: Data, _ port: Int) {
-        //higher level API we will cut over to at some point
-        //NSStream.getStreamsToHostWithName(url.host, port: url.port.integerValue, inputStream: &inputStream, outputStream: &outputStream)
-
-        var readStream: Unmanaged<CFReadStream>?
-        var writeStream: Unmanaged<CFWriteStream>?
-        let h = url.host! as NSString
-        CFStreamCreatePairWithSocketToHost(nil, h, UInt32(port), &readStream, &writeStream)
-        inputStream = readStream!.takeRetainedValue()
-        outputStream = writeStream!.takeRetainedValue()
-        guard let inStream = inputStream, let outStream = outputStream else { return }
-        inStream.delegate = self
-        outStream.delegate = self
-        if supportedSSLSchemes.contains(url.scheme!) {
-            inStream.setProperty(StreamSocketSecurityLevel.negotiatedSSL as AnyObject, forKey: Stream.PropertyKey.socketSecurityLevelKey)
-            outStream.setProperty(StreamSocketSecurityLevel.negotiatedSSL as AnyObject, forKey: Stream.PropertyKey.socketSecurityLevelKey)
-        } else {
-            certValidated = true //not a https session, so no need to check SSL pinning
-        }
-        if voipEnabled {
-            inStream.setProperty(StreamNetworkServiceTypeValue.voIP as AnyObject, forKey: Stream.PropertyKey.networkServiceType)
-            outStream.setProperty(StreamNetworkServiceTypeValue.voIP as AnyObject, forKey: Stream.PropertyKey.networkServiceType)
-        }
-        if selfSignedSSL {
-            let settings: [NSObject: NSObject] = [kCFStreamSSLValidatesCertificateChain: NSNumber(value: false), kCFStreamSSLPeerName: kCFNull]
-            inStream.setProperty(settings, forKey: kCFStreamPropertySSLSettings as Stream.PropertyKey)
-            outStream.setProperty(settings, forKey: kCFStreamPropertySSLSettings as Stream.PropertyKey)
-        }
-        if let cipherSuites = self.enabledSSLCipherSuites {
-            if let sslContextIn = CFReadStreamCopyProperty(inputStream, CFStreamPropertyKey(rawValue: kCFStreamPropertySSLContext)) as! SSLContext?,
-                let sslContextOut = CFWriteStreamCopyProperty(outputStream, CFStreamPropertyKey(rawValue: kCFStreamPropertySSLContext)) as! SSLContext? {
-                let resIn = SSLSetEnabledCiphers(sslContextIn, cipherSuites, cipherSuites.count)
-                let resOut = SSLSetEnabledCiphers(sslContextOut, cipherSuites, cipherSuites.count)
-                if resIn != errSecSuccess {
-                    let error = self.errorWithDetail("Error setting ingoing cypher suites", code: UInt16(resIn))
-                    disconnectStream(error)
-                    return
-                }
-                if resOut != errSecSuccess {
-                    let error = self.errorWithDetail("Error setting outgoing cypher suites", code: UInt16(resOut))
-                    disconnectStream(error)
-                    return
-                }
-            }
-        }
-        
-        CFReadStreamSetDispatchQueue(inStream, WebSocket.sharedWorkQueue)
-        CFWriteStreamSetDispatchQueue(outStream, WebSocket.sharedWorkQueue)
-        inStream.open()
-        outStream.open()
-
-        self.mutex.lock()
-        self.readyToWrite = true
-        self.mutex.unlock()
-        
-        let bytes = UnsafeRawPointer((data as NSData).bytes).assumingMemoryBound(to: UInt8.self)
-        var out = timeout * 1000000 // wait 5 seconds before giving up
-        writeQueue.addOperation { [weak self] in
-            while !outStream.hasSpaceAvailable {
-                usleep(100) // wait until the socket is ready
-                out -= 100
-                if out < 0 {
-                    self?.cleanupStream()
-                    self?.doDisconnect(self?.errorWithDetail("write wait timed out", code: 2))
-                    return
-                } else if outStream.streamError != nil {
-                    return // disconnectStream will be called.
-                }
-            }
-            outStream.write(bytes, maxLength: data.count)
-        }
-    }
-    
-    //delegate for the stream methods. Processes incoming bytes
-    public func stream(_ aStream: Stream, handle eventCode: Stream.Event) {
-        if let sec = security, !certValidated && [.hasBytesAvailable, .hasSpaceAvailable].contains(eventCode) {
-            let trust = aStream.property(forKey: kCFStreamPropertySSLPeerTrust as Stream.PropertyKey) as AnyObject
-            let domain = aStream.property(forKey: kCFStreamSSLPeerName as Stream.PropertyKey) as? String
-            if sec.isValid(trust as! SecTrust, domain: domain) {
-                certValidated = true
-            } else {
-                let error = errorWithDetail("Invalid SSL certificate", code: 1)
-                disconnectStream(error)
-                return
-            }
-        }
-        if eventCode == .hasBytesAvailable {
-            if aStream == inputStream {
-                processInputStream()
-            }
-        } else if eventCode == .errorOccurred {
-            disconnectStream(aStream.streamError as NSError?)
-        } else if eventCode == .endEncountered {
-            disconnectStream(nil)
-        }
-    }
-    
-    /// Disconnect the stream object and notifies the delegate.
-    private func disconnectStream(_ error: NSError?) {
-        if error == nil {
-            writeQueue.waitUntilAllOperationsAreFinished()
-        } else {
-            writeQueue.cancelAllOperations()
-        }
-        cleanupStream()
-        doDisconnect(error)
-    }
-
-    private func cleanupStream() {
-        outputStream?.delegate = nil
-        inputStream?.delegate = nil
-        if let stream = inputStream {
-            CFReadStreamSetDispatchQueue(stream, nil)
-            stream.close()
-        }
-        if let stream = outputStream {
-            CFWriteStreamSetDispatchQueue(stream, nil)
-            stream.close()
-        }
-        outputStream = nil
-        inputStream = nil
-    }
-
-    /// Handles the incoming bytes and sending them to the proper processing method.
-    private func processInputStream() {
-        let buf = NSMutableData(capacity: BUFFER_MAX)
-        let buffer = UnsafeMutableRawPointer(mutating: buf!.bytes).assumingMemoryBound(to: UInt8.self)
-        let length = inputStream!.read(buffer, maxLength: BUFFER_MAX)
-
-        guard length > 0 else { return }
-        var process = false
-        if inputQueue.count == 0 {
-            process = true
-        }
-        inputQueue.append(Data(bytes: buffer, count: length))
-        if process {
-            dequeueInput()
-        }
-    }
-
-    /// Dequeue the incoming input so it is processed in order.
-    private func dequeueInput() {
-        while !inputQueue.isEmpty {
-            let data = inputQueue[0]
-            var work = data
-            if let fragBuffer = fragBuffer {
-                var combine = NSData(data: fragBuffer) as Data
-                combine.append(data)
-                work = combine
-                self.fragBuffer = nil
-            }
-            let buffer = UnsafeRawPointer((work as NSData).bytes).assumingMemoryBound(to: UInt8.self)
-            let length = work.count
-            if !connected {
-                processTCPHandshake(buffer, bufferLen: length)
-            } else {
-                processRawMessagesInBuffer(buffer, bufferLen: length)
-            }
-            inputQueue = inputQueue.filter{ $0 != data }
-        }
-    }
-    
-    //handle checking the inital connection status
-    private func processTCPHandshake(_ buffer: UnsafePointer<UInt8>, bufferLen: Int) {
-        let code = processHTTP(buffer, bufferLen: bufferLen)
-        switch code {
-        case 0:
-            connected = true
-            guard canDispatch else {return}
-            callbackQueue.async { [weak self] in
-                guard let s = self else { return }
-                s.onConnect?()
-                s.delegate?.websocketDidConnect(s)
-                s.notificationCenter.post(name: NSNotification.Name(WebsocketDidConnectNotification), object: self)
-            }
-        case -1:
-            fragBuffer = Data(bytes: buffer, count: bufferLen)
-        break // do nothing, we are going to collect more data
-        default:
-            doDisconnect(errorWithDetail("Invalid HTTP upgrade", code: UInt16(code)))
-        }
-    }
-    
-    ///Finds the HTTP Packet in the TCP stream, by looking for the CRLF.
-    private func processHTTP(_ buffer: UnsafePointer<UInt8>, bufferLen: Int) -> Int {
-        let CRLFBytes = [UInt8(ascii: "\r"), UInt8(ascii: "\n"), UInt8(ascii: "\r"), UInt8(ascii: "\n")]
-        var k = 0
-        var totalSize = 0
-        for i in 0..<bufferLen {
-            if buffer[i] == CRLFBytes[k] {
-                k += 1
-                if k == 3 {
-                    totalSize = i + 1
-                    break
-                }
-            } else {
-                k = 0
-            }
-        }
-        if totalSize > 0 {
-            let code = validateResponse(buffer, bufferLen: totalSize)
-            if code != 0 {
-                return code
-            }
-            totalSize += 1 //skip the last \n
-            let restSize = bufferLen - totalSize
-            if restSize > 0 {
-                processRawMessagesInBuffer(buffer + totalSize, bufferLen: restSize)
-            }
-            return 0 //success
-        }
-        return -1 // Was unable to find the full TCP header.
-    }
-    
-    /// Validates the HTTP is a 101 as per the RFC spec.
-    private func validateResponse(_ buffer: UnsafePointer<UInt8>, bufferLen: Int) -> Int {
-        let response = CFHTTPMessageCreateEmpty(kCFAllocatorDefault, false).takeRetainedValue()
-        CFHTTPMessageAppendBytes(response, buffer, bufferLen)
-        let code = CFHTTPMessageGetResponseStatusCode(response)
-        if code != httpSwitchProtocolCode {
-            return code
-        }
-        if let cfHeaders = CFHTTPMessageCopyAllHeaderFields(response) {
-            let headers = cfHeaders.takeRetainedValue() as NSDictionary
-            if let acceptKey = headers[headerWSAcceptName as NSString] as? NSString {
-                if acceptKey.length > 0 {
-                    return 0
-                }
-            }
-        }
-        return -1
-    }
-    
-    ///read a 16 bit big endian value from a buffer
-    private static func readUint16(_ buffer: UnsafePointer<UInt8>, offset: Int) -> UInt16 {
-        return (UInt16(buffer[offset + 0]) << 8) | UInt16(buffer[offset + 1])
-    }
-    
-    ///read a 64 bit big endian value from a buffer
-    private static func readUint64(_ buffer: UnsafePointer<UInt8>, offset: Int) -> UInt64 {
-        var value = UInt64(0)
-        for i in 0...7 {
-            value = (value << 8) | UInt64(buffer[offset + i])
-        }
-        return value
-    }
-    
-    /// Write a 16-bit big endian value to a buffer.
-    private static func writeUint16(_ buffer: UnsafeMutablePointer<UInt8>, offset: Int, value: UInt16) {
-        buffer[offset + 0] = UInt8(value >> 8)
-        buffer[offset + 1] = UInt8(value & 0xff)
-    }
-    
-    /// Write a 64-bit big endian value to a buffer.
-    private static func writeUint64(_ buffer: UnsafeMutablePointer<UInt8>, offset: Int, value: UInt64) {
-        for i in 0...7 {
-            buffer[offset + i] = UInt8((value >> (8*UInt64(7 - i))) & 0xff)
-        }
-    }
-
-    /// Process one message at the start of `buffer`. Return another buffer (sharing storage) that contains the leftover contents of `buffer` that I didn't process.
-    
-    private func processOneRawMessage(inBuffer buffer: UnsafeBufferPointer<UInt8>) -> UnsafeBufferPointer<UInt8> {
-        let response = readStack.last
-        guard let baseAddress = buffer.baseAddress else {return emptyBuffer}
-        let bufferLen = buffer.count
-        if response != nil && bufferLen < 2  {
-            fragBuffer = Data(buffer: buffer)
-            return emptyBuffer
-        }
-        if let response = response, response.bytesLeft > 0 {
-            var len = response.bytesLeft
-            var extra = bufferLen - response.bytesLeft
-            if response.bytesLeft > bufferLen {
-                len = bufferLen
-                extra = 0
-            }
-            response.bytesLeft -= len
-            response.buffer?.append(Data(bytes: baseAddress, count: len))
-            _ = processResponse(response)
-            return buffer.fromOffset(bufferLen - extra)
-        } else {
-            let isFin = (FinMask & baseAddress[0])
-            let receivedOpcode = OpCode(rawValue: (OpCodeMask & baseAddress[0]))
-            let isMasked = (MaskMask & baseAddress[1])
-            let payloadLen = (PayloadLenMask & baseAddress[1])
-            var offset = 2
-            if (isMasked > 0 || (RSVMask & baseAddress[0]) > 0) && receivedOpcode != .pong {
-                let errCode = CloseCode.protocolError.rawValue
-                doDisconnect(errorWithDetail("masked and rsv data is not currently supported", code: errCode))
-                writeError(errCode)
-                return emptyBuffer
-            }
-            let isControlFrame = (receivedOpcode == .connectionClose || receivedOpcode == .ping)
-            if !isControlFrame && (receivedOpcode != .binaryFrame && receivedOpcode != .continueFrame &&
-                receivedOpcode != .textFrame && receivedOpcode != .pong) {
-                    let errCode = CloseCode.protocolError.rawValue
-                    doDisconnect(errorWithDetail("unknown opcode: \(receivedOpcode)", code: errCode))
-                    writeError(errCode)
-                    return emptyBuffer
-            }
-            if isControlFrame && isFin == 0 {
-                let errCode = CloseCode.protocolError.rawValue
-                doDisconnect(errorWithDetail("control frames can't be fragmented", code: errCode))
-                writeError(errCode)
-                return emptyBuffer
-            }
-            if receivedOpcode == .connectionClose {
-                var code = CloseCode.normal.rawValue
-                if payloadLen == 1 {
-                    code = CloseCode.protocolError.rawValue
-                } else if payloadLen > 1 {
-                    code = WebSocket.readUint16(baseAddress, offset: offset)
-                    if code < 1000 || (code > 1003 && code < 1007) || (code > 1011 && code < 3000) {
-                        code = CloseCode.protocolError.rawValue
-                    }
-                    offset += 2
-                }
-                var closeReason = "connection closed by server"
-                if payloadLen > 2 {
-                    let len = Int(payloadLen - 2)
-                    if len > 0 {
-                        let bytes = baseAddress + offset
-                        if let customCloseReason = String(data: Data(bytes: bytes, count: len), encoding: .utf8) {
-                            closeReason = customCloseReason
-                        } else {
-                            code = CloseCode.protocolError.rawValue
-                        }
-                    }
-                }
-                doDisconnect(errorWithDetail(closeReason, code: code))
-                writeError(code)
-                return emptyBuffer
-            }
-            if isControlFrame && payloadLen > 125 {
-                writeError(CloseCode.protocolError.rawValue)
-                return emptyBuffer
-            }
-            var dataLength = UInt64(payloadLen)
-            if dataLength == 127 {
-                dataLength = WebSocket.readUint64(baseAddress, offset: offset)
-                offset += MemoryLayout<UInt64>.size
-            } else if dataLength == 126 {
-                dataLength = UInt64(WebSocket.readUint16(baseAddress, offset: offset))
-                offset += MemoryLayout<UInt16>.size
-            }
-            if bufferLen < offset || UInt64(bufferLen - offset) < dataLength {
-                fragBuffer = Data(bytes: baseAddress, count: bufferLen)
-                return emptyBuffer
-            }
-            var len = dataLength
-            if dataLength > UInt64(bufferLen) {
-                len = UInt64(bufferLen-offset)
-            }
-            let data: Data
-            if len < 0 {
-                len = 0
-                data = Data()
-            } else {
-                data = Data(bytes: baseAddress+offset, count: Int(len))
-            }
-            if receivedOpcode == .pong {
-                if canDispatch {
-                    callbackQueue.async { [weak self] in
-                        guard let s = self else { return }
-                        s.onPong?()
-                        s.pongDelegate?.websocketDidReceivePong(s)
-                    }
-                }
-                return buffer.fromOffset(offset + Int(len))
-            }
-            var response = readStack.last
-            if isControlFrame {
-                response = nil // Don't append pings.
-            }
-            if isFin == 0 && receivedOpcode == .continueFrame && response == nil {
-                let errCode = CloseCode.protocolError.rawValue
-                doDisconnect(errorWithDetail("continue frame before a binary or text frame", code: errCode))
-                writeError(errCode)
-                return emptyBuffer
-            }
-            var isNew = false
-            if response == nil {
-                if receivedOpcode == .continueFrame  {
-                    let errCode = CloseCode.protocolError.rawValue
-                    doDisconnect(errorWithDetail("first frame can't be a continue frame",
-                        code: errCode))
-                    writeError(errCode)
-                    return emptyBuffer
-                }
-                isNew = true
-                response = WSResponse()
-                response!.code = receivedOpcode!
-                response!.bytesLeft = Int(dataLength)
-                response!.buffer = NSMutableData(data: data)
-            } else {
-                if receivedOpcode == .continueFrame  {
-                    response!.bytesLeft = Int(dataLength)
-                } else {
-                    let errCode = CloseCode.protocolError.rawValue
-                    doDisconnect(errorWithDetail("second and beyond of fragment message must be a continue frame",
-                        code: errCode))
-                    writeError(errCode)
-                    return emptyBuffer
-                }
-                response!.buffer!.append(data)
-            }
-            if let response = response {
-                response.bytesLeft -= Int(len)
-                response.frameCount += 1
-                response.isFin = isFin > 0 ? true : false
-                if isNew {
-                    readStack.append(response)
-                }
-                _ = processResponse(response)
-            }
-
-            let step = Int(offset + numericCast(len))
-            return buffer.fromOffset(step)
-        }
-    }
-
-    /// Process all messages in the buffer if possible.
-    private func processRawMessagesInBuffer(_ pointer: UnsafePointer<UInt8>, bufferLen: Int) {
-        var buffer = UnsafeBufferPointer(start: pointer, count: bufferLen)
-        repeat {
-            buffer = processOneRawMessage(inBuffer: buffer)
-        } while buffer.count >= 2
-        if buffer.count > 0 {
-            fragBuffer = Data(buffer: buffer)
-        }
-    }
-
-    /// Process the finished response of a buffer.
-    private func processResponse(_ response: WSResponse) -> Bool {
-        if response.isFin && response.bytesLeft <= 0 {
-            if response.code == .ping {
-                let data = response.buffer! // local copy so it is perverse for writing
-                dequeueWrite(data as Data, code: .pong)
-            } else if response.code == .textFrame {
-                let str: NSString? = NSString(data: response.buffer! as Data, encoding: String.Encoding.utf8.rawValue)
-                if str == nil {
-                    writeError(CloseCode.encoding.rawValue)
-                    return false
-                }
-                if canDispatch {
-                    callbackQueue.async { [weak self] in
-                        guard let s = self else { return }
-                        s.onText?(str! as String)
-                        s.delegate?.websocketDidReceiveMessage(s, text: str! as String)
-                    }
-                }
-            } else if response.code == .binaryFrame {
-                if canDispatch {
-                    let data = response.buffer! // local copy so it is perverse for writing
-                    callbackQueue.async { [weak self] in
-                        guard let s = self else { return }
-                        s.onData?(data as Data)
-                        s.delegate?.websocketDidReceiveData(s, data: data as Data)
-                    }
-                }
-            }
-            readStack.removeLast()
-            return true
-        }
-        return false
-    }
-    
-    /// Create an error
-    private func errorWithDetail(_ detail: String, code: UInt16) -> NSError {
-        var details = [String: String]()
-        details[NSLocalizedDescriptionKey] =  detail
-        return NSError(domain: WebSocket.ErrorDomain, code: Int(code), userInfo: details)
-    }
-    
-    /// Write an error to the socket
-    private func writeError(_ code: UInt16) {
-        let buf = NSMutableData(capacity: MemoryLayout<UInt16>.size)
-        let buffer = UnsafeMutableRawPointer(mutating: buf!.bytes).assumingMemoryBound(to: UInt8.self)
-        WebSocket.writeUint16(buffer, offset: 0, value: code)
-        dequeueWrite(Data(bytes: buffer, count: MemoryLayout<UInt16>.size), code: .connectionClose)
-    }
-    
-    /// Used to write things to the stream
-    private func dequeueWrite(_ data: Data, code: OpCode, writeCompletion: (() -> ())? = nil) {
-        writeQueue.addOperation { [weak self] in
-            //stream isn't ready, let's wait
-            guard let s = self else { return }
-            var offset = 2
-            let dataLength = data.count
-            let frame = NSMutableData(capacity: dataLength + s.MaxFrameSize)
-            let buffer = UnsafeMutableRawPointer(frame!.mutableBytes).assumingMemoryBound(to: UInt8.self)
-            buffer[0] = s.FinMask | code.rawValue
-            if dataLength < 126 {
-                buffer[1] = CUnsignedChar(dataLength)
-            } else if dataLength <= Int(UInt16.max) {
-                buffer[1] = 126
-                WebSocket.writeUint16(buffer, offset: offset, value: UInt16(dataLength))
-                offset += MemoryLayout<UInt16>.size
-            } else {
-                buffer[1] = 127
-                WebSocket.writeUint64(buffer, offset: offset, value: UInt64(dataLength))
-                offset += MemoryLayout<UInt64>.size
-            }
-            buffer[1] |= s.MaskMask
-            let maskKey = UnsafeMutablePointer<UInt8>(buffer + offset)
-            _ = SecRandomCopyBytes(kSecRandomDefault, Int(MemoryLayout<UInt32>.size), maskKey)
-            offset += MemoryLayout<UInt32>.size
-            
-            for i in 0..<dataLength {
-                buffer[offset] = data[i] ^ maskKey[i % MemoryLayout<UInt32>.size]
-                offset += 1
-            }
-            var total = 0
-            while true {
-                guard let outStream = s.outputStream else { break }
-                let writeBuffer = UnsafeRawPointer(frame!.bytes+total).assumingMemoryBound(to: UInt8.self)
-                let len = outStream.write(writeBuffer, maxLength: offset-total)
-                if len < 0 {
-                    var error: Error?
-                    if let streamError = outStream.streamError {
-                        error = streamError
-                    } else {
-                        let errCode = InternalErrorCode.outputStreamWriteError.rawValue
-                        error = s.errorWithDetail("output stream error during write", code: errCode)
-                    }
-                    s.doDisconnect(error as NSError?)
-                    break
-                } else {
-                    total += len
-                }
-                if total >= offset {
-                    if let queue = self?.callbackQueue, let callback = writeCompletion {
-                        queue.async {
-                            callback()
-                        }
-                    }
-
-                    break
-                }
-            }
-
-        }
-    }
-    
-    /// Used to preform the disconnect delegate
-    private func doDisconnect(_ error: NSError?) {
-        guard !didDisconnect else { return }
-        didDisconnect = true
-        connected = false
-        guard canDispatch else {return}
-        callbackQueue.async { [weak self] in
-            guard let s = self else { return }
-            s.onDisconnect?(error)
-            s.delegate?.websocketDidDisconnect(s, error: error)
-            let userInfo = error.map{ [WebsocketDisconnectionErrorKeyName: $0] }
-            s.notificationCenter.post(name: NSNotification.Name(WebsocketDidDisconnectNotification), object: self, userInfo: userInfo)
-        }
-    }
-
-    // MARK: - Deinit
-
-    deinit {
-        mutex.lock()
-        readyToWrite = false
-        mutex.unlock()
-        cleanupStream()
-    }
-
-}
-
-private extension Data {
-
-    init(buffer: UnsafeBufferPointer<UInt8>) {
-        self.init(bytes: buffer.baseAddress!, count: buffer.count)
-    }
-
-}
-
-private extension UnsafeBufferPointer {
-
-    func fromOffset(_ offset: Int) -> UnsafeBufferPointer<Element> {
-        return UnsafeBufferPointer<Element>(start: baseAddress?.advanced(by: offset), count: count - offset)
-    }
-    
-}
-
-private let emptyBuffer = UnsafeBufferPointer<UInt8>(start: nil, count: 0)

Sources/Compression.swift

@@ -0,0 +1,177 @@
+//////////////////////////////////////////////////////////////////////////////////////////////////
+//
+//  Compression.swift
+//
+//  Created by Joseph Ross on 7/16/14.
+//  Copyright © 2017 Joseph Ross.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+//////////////////////////////////////////////////////////////////////////////////////////////////
+
+//////////////////////////////////////////////////////////////////////////////////////////////////
+//
+//  Compression implementation is implemented in conformance with RFC 7692 Compression Extensions
+//  for WebSocket: https://tools.ietf.org/html/rfc7692
+//
+//////////////////////////////////////////////////////////////////////////////////////////////////
+
+import Foundation
+import SSCZLib
+
+class Decompressor {
+    private var strm = z_stream()
+    private var buffer = [UInt8](repeating: 0, count: 0x2000)
+    private var inflateInitialized = false
+    private let windowBits:Int
+
+    init?(windowBits:Int) {
+        self.windowBits = windowBits
+        guard initInflate() else { return nil }
+    }
+
+    private func initInflate() -> Bool {
+        if Z_OK == inflateInit2_(&strm, -CInt(windowBits),
+                                 ZLIB_VERSION, CInt(MemoryLayout<z_stream>.size))
+        {
+            inflateInitialized = true
+            return true
+        }
+        return false
+    }
+
+    func reset() throws {
+        teardownInflate()
+        guard initInflate() else { throw NSError() }
+    }
+
+    func decompress(_ data: Data, finish: Bool) throws -> Data {
+        return try data.withUnsafeBytes { (bytes:UnsafePointer<UInt8>) -> Data in
+            return try decompress(bytes: bytes, count: data.count, finish: finish)
+        }
+    }
+
+    func decompress(bytes: UnsafePointer<UInt8>, count: Int, finish: Bool) throws -> Data {
+        var decompressed = Data()
+        try decompress(bytes: bytes, count: count, out: &decompressed)
+
+        if finish {
+            let tail:[UInt8] = [0x00, 0x00, 0xFF, 0xFF]
+            try decompress(bytes: tail, count: tail.count, out: &decompressed)
+        }
+
+        return decompressed
+
+    }
+
+    private func decompress(bytes: UnsafePointer<UInt8>, count: Int, out:inout Data) throws {
+        var res:CInt = 0
+        strm.next_in = UnsafeMutablePointer<UInt8>(mutating: bytes)
+        strm.avail_in = CUnsignedInt(count)
+
+        repeat {
+            strm.next_out = UnsafeMutablePointer<UInt8>(&buffer)
+            strm.avail_out = CUnsignedInt(buffer.count)
+
+            res = inflate(&strm, 0)
+
+            let byteCount = buffer.count - Int(strm.avail_out)
+            out.append(buffer, count: byteCount)
+        } while res == Z_OK && strm.avail_out == 0
+
+        guard (res == Z_OK && strm.avail_out > 0)
+            || (res == Z_BUF_ERROR && Int(strm.avail_out) == buffer.count)
+            else {
+                throw NSError(domain: WebSocket.ErrorDomain, code: Int(InternalErrorCode.compressionError.rawValue), userInfo: nil)
+        }
+    }
+
+    private func teardownInflate() {
+        if inflateInitialized, Z_OK == inflateEnd(&strm) {
+            inflateInitialized = false
+        }
+    }
+
+    deinit {
+        teardownInflate()
+    }
+}
+
+class Compressor {
+    private var strm = z_stream()
+    private var buffer = [UInt8](repeating: 0, count: 0x2000)
+    private var deflateInitialized = false
+    private let windowBits:Int
+
+    init?(windowBits: Int) {
+        self.windowBits = windowBits
+        guard initDeflate() else { return nil }
+    }
+
+    private func initDeflate() -> Bool {
+        if Z_OK == deflateInit2_(&strm, Z_DEFAULT_COMPRESSION, Z_DEFLATED,
+                                 -CInt(windowBits), 8, Z_DEFAULT_STRATEGY,
+                                 ZLIB_VERSION, CInt(MemoryLayout<z_stream>.size))
+        {
+            deflateInitialized = true
+            return true
+        }
+        return false
+    }
+
+    func reset() throws {
+        teardownDeflate()
+        guard initDeflate() else { throw NSError() }
+    }
+
+    func compress(_ data: Data) throws -> Data {
+        var compressed = Data()
+        var res:CInt = 0
+        data.withUnsafeBytes { (ptr:UnsafePointer<UInt8>) -> Void in
+            strm.next_in = UnsafeMutablePointer<UInt8>(mutating: ptr)
+            strm.avail_in = CUnsignedInt(data.count)
+
+            repeat {
+                strm.next_out = UnsafeMutablePointer<UInt8>(&buffer)
+                strm.avail_out = CUnsignedInt(buffer.count)
+
+                res = deflate(&strm, Z_SYNC_FLUSH)
+
+                let byteCount = buffer.count - Int(strm.avail_out)
+                compressed.append(buffer, count: byteCount)
+            }
+            while res == Z_OK && strm.avail_out == 0
+
+        }
+
+        guard res == Z_OK && strm.avail_out > 0
+            || (res == Z_BUF_ERROR && Int(strm.avail_out) == buffer.count)
+        else {
+            throw NSError(domain: WebSocket.ErrorDomain, code: Int(InternalErrorCode.compressionError.rawValue), userInfo: nil)
+        }
+
+        compressed.removeLast(4)
+        return compressed
+    }
+
+    private func teardownDeflate() {
+        if deflateInitialized, Z_OK == deflateEnd(&strm) {
+            deflateInitialized = false
+        }
+    }
+
+    deinit {
+        teardownDeflate()
+    }
+}
+

Sources/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.1.3</string>
+	<string>3.0.2</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

Sources/SSLSecurity.swift

@@ -4,7 +4,7 @@
 //  Starscream
 //
 //  Created by Dalton Cherry on 5/16/15.
-//  Copyright (c) 2014-2015 Dalton Cherry.
+//  Copyright (c) 2014-2016 Dalton Cherry.
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");
 //  you may not use this file except in compliance with the License.
@@ -19,11 +19,16 @@
 //  limitations under the License.
 //
 //////////////////////////////////////////////////////////////////////////////////////////////////
-
+#if os(Linux)
+#else
 import Foundation
 import Security
 
-public class SSLCert {
+public protocol SSLTrustValidator {
+    func isValid(_ trust: SecTrust, domain: String?) -> Bool
+}
+
+open class SSLCert {
     var certData: Data?
     var key: SecKey?
     
@@ -50,7 +55,7 @@ public class SSLCert {
     }
 }
 
-public class SSLSecurity {
+open class SSLSecurity : SSLTrustValidator {
     public var validatedDN = true //should the domain name be validated?
     
     var isReady = false //is the key processing done?
@@ -82,7 +87,7 @@ public class SSLSecurity {
     /**
     Designated init
     
-    - parameter keys: is the certificates or public keys to use
+    - parameter certs: is the certificates or public keys to use
     - parameter usePublicKeys: is to specific if the publicKeys or certificates should be used for SSL pinning validation
     
     - returns: a representation security object to be used with
@@ -207,7 +212,6 @@ public class SSLSecurity {
         SecTrustCreateWithCertificates(cert, policy, &possibleTrust)
         
         guard let trust = possibleTrust else { return nil }
-        
         var result: SecTrustResultType = .unspecified
         SecTrustEvaluate(trust, &result)
         return SecTrustCopyPublicKey(trust)
@@ -255,3 +259,4 @@ public class SSLSecurity {
     
     
 }
+#endif

Starscream.podspec

@@ -1,15 +1,20 @@
 Pod::Spec.new do |s|
   s.name         = "Starscream"
-  s.version      = "1.1.3"
-  s.summary      = "A conforming WebSocket RFC 6455 client library in Swift for iOS and OSX."
+  s.version      = "3.0.2"
+  s.summary      = "A conforming WebSocket RFC 6455 client library in Swift."
   s.homepage     = "https://github.com/daltoniam/Starscream"
   s.license      = 'Apache License, Version 2.0'
   s.author       = {'Dalton Cherry' => 'http://daltoniam.com', 'Austin Cherry' => 'http://austincherry.me'}
   s.source       = { :git => 'https://github.com/daltoniam/Starscream.git',  :tag => "#{s.version}"}
   s.social_media_url = 'http://twitter.com/daltoniam'
   s.ios.deployment_target = '8.0'
-  s.osx.deployment_target = '10.9'
+  s.osx.deployment_target = '10.10'
   s.tvos.deployment_target = '9.0'
-  s.source_files = 'Source/*.swift'
-  s.requires_arc = 'true'
+  s.watchos.deployment_target = '2.0'
+  s.source_files = 'Sources/*.swift'
+  s.libraries    = 'z'
+  s.pod_target_xcconfig = {
+  'SWIFT_INCLUDE_PATHS' => '$(PODS_ROOT)/Starscream/zlib'
+  }
+  s.preserve_paths = 'zlib/*'
 end

Starscream.xcodeproj/xcshareddata/xcschemes/Starscream.xcscheme

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0800"
-   version = "1.3">
+   LastUpgradeVersion = "0900"
+   version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"
       buildImplicitDependencies = "YES">
@@ -14,9 +14,9 @@
             buildForAnalyzing = "YES">
             <BuildableReference
                BuildableIdentifier = "primary"
-               BlueprintIdentifier = "6B3E79E519D48B7F006071F7"
+               BlueprintIdentifier = "33CCF0841F5DDC030099B092"
                BuildableName = "Starscream.framework"
-               BlueprintName = "Starscream iOS"
+               BlueprintName = "Starscream"
                ReferencedContainer = "container:Starscream.xcodeproj">
             </BuildableReference>
          </BuildActionEntry>
@@ -26,9 +26,34 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      language = ""
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      codeCoverageEnabled = "YES">
       <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "335FA1F41F5DF71D00F6D2EC"
+               BuildableName = "Starscream Tests.xctest"
+               BlueprintName = "Starscream Tests"
+               ReferencedContainer = "container:Starscream.xcodeproj">
+            </BuildableReference>
+            <LocationScenarioReference
+               identifier = "com.apple.dt.IDEFoundation.CurrentLocationScenarioIdentifier"
+               referenceType = "1">
+            </LocationScenarioReference>
+         </TestableReference>
       </Testables>
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "33CCF0841F5DDC030099B092"
+            BuildableName = "Starscream.framework"
+            BlueprintName = "Starscream"
+            ReferencedContainer = "container:Starscream.xcodeproj">
+         </BuildableReference>
+      </MacroExpansion>
       <AdditionalOptions>
       </AdditionalOptions>
    </TestAction>
@@ -36,6 +61,7 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      language = ""
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"
@@ -45,9 +71,9 @@
       <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"
-            BlueprintIdentifier = "6B3E79E519D48B7F006071F7"
+            BlueprintIdentifier = "33CCF0841F5DDC030099B092"
             BuildableName = "Starscream.framework"
-            BlueprintName = "Starscream iOS"
+            BlueprintName = "Starscream"
             ReferencedContainer = "container:Starscream.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
@@ -63,9 +89,9 @@
       <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"
-            BlueprintIdentifier = "6B3E79E519D48B7F006071F7"
+            BlueprintIdentifier = "33CCF0841F5DDC030099B092"
             BuildableName = "Starscream.framework"
-            BlueprintName = "Starscream iOS"
+            BlueprintName = "Starscream"
             ReferencedContainer = "container:Starscream.xcodeproj">
          </BuildableReference>
       </MacroExpansion>

Starscream.xcodeproj/xcshareddata/xcschemes/StarscreamOSX.xcscheme

@@ -1,113 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
-   LastUpgradeVersion = "0800"
-   version = "1.3">
-   <BuildAction
-      parallelizeBuildables = "YES"
-      buildImplicitDependencies = "YES">
-      <BuildActionEntries>
-         <BuildActionEntry
-            buildForTesting = "YES"
-            buildForRunning = "YES"
-            buildForProfiling = "YES"
-            buildForArchiving = "YES"
-            buildForAnalyzing = "YES">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "D9C3E35E19E48FF1009FC285"
-               BuildableName = "Starscream.framework"
-               BlueprintName = "Starscream OSX"
-               ReferencedContainer = "container:Starscream.xcodeproj">
-            </BuildableReference>
-         </BuildActionEntry>
-         <BuildActionEntry
-            buildForTesting = "YES"
-            buildForRunning = "YES"
-            buildForProfiling = "NO"
-            buildForArchiving = "NO"
-            buildForAnalyzing = "YES">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "D9C3E36819E48FF1009FC285"
-               BuildableName = "Starscream OSXTests.xctest"
-               BlueprintName = "Starscream OSXTests"
-               ReferencedContainer = "container:Starscream.xcodeproj">
-            </BuildableReference>
-         </BuildActionEntry>
-      </BuildActionEntries>
-   </BuildAction>
-   <TestAction
-      buildConfiguration = "Debug"
-      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
-      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
-      <Testables>
-         <TestableReference
-            skipped = "NO">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "D9C3E36819E48FF1009FC285"
-               BuildableName = "Starscream OSXTests.xctest"
-               BlueprintName = "Starscream OSXTests"
-               ReferencedContainer = "container:Starscream.xcodeproj">
-            </BuildableReference>
-         </TestableReference>
-      </Testables>
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "D9C3E35E19E48FF1009FC285"
-            BuildableName = "Starscream.framework"
-            BlueprintName = "Starscream OSX"
-            ReferencedContainer = "container:Starscream.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
-   </TestAction>
-   <LaunchAction
-      buildConfiguration = "Debug"
-      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
-      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      launchStyle = "0"
-      useCustomWorkingDirectory = "NO"
-      ignoresPersistentStateOnLaunch = "NO"
-      debugDocumentVersioning = "YES"
-      debugServiceExtension = "internal"
-      allowLocationSimulation = "YES">
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "D9C3E35E19E48FF1009FC285"
-            BuildableName = "Starscream.framework"
-            BlueprintName = "Starscream OSX"
-            ReferencedContainer = "container:Starscream.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
-   </LaunchAction>
-   <ProfileAction
-      buildConfiguration = "Release"
-      shouldUseLaunchSchemeArgsEnv = "YES"
-      savedToolIdentifier = ""
-      useCustomWorkingDirectory = "NO"
-      debugDocumentVersioning = "YES">
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "D9C3E35E19E48FF1009FC285"
-            BuildableName = "Starscream.framework"
-            BlueprintName = "Starscream OSX"
-            ReferencedContainer = "container:Starscream.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-   </ProfileAction>
-   <AnalyzeAction
-      buildConfiguration = "Debug">
-   </AnalyzeAction>
-   <ArchiveAction
-      buildConfiguration = "Release"
-      revealArchiveInOrganizer = "YES">
-   </ArchiveAction>
-</Scheme>

Starscream.xcodeproj/xcshareddata/xcschemes/StarscreamTests.xcscheme

@@ -1,99 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
-   LastUpgradeVersion = "0800"
-   version = "1.3">
-   <BuildAction
-      parallelizeBuildables = "YES"
-      buildImplicitDependencies = "YES">
-      <BuildActionEntries>
-         <BuildActionEntry
-            buildForTesting = "YES"
-            buildForRunning = "YES"
-            buildForProfiling = "NO"
-            buildForArchiving = "NO"
-            buildForAnalyzing = "YES">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "6B3E79F019D48B7F006071F7"
-               BuildableName = "Starscream iOSTests.xctest"
-               BlueprintName = "Starscream iOSTests"
-               ReferencedContainer = "container:Starscream.xcodeproj">
-            </BuildableReference>
-         </BuildActionEntry>
-      </BuildActionEntries>
-   </BuildAction>
-   <TestAction
-      buildConfiguration = "Debug"
-      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
-      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
-      <Testables>
-         <TestableReference
-            skipped = "NO">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "6B3E79F019D48B7F006071F7"
-               BuildableName = "Starscream iOSTests.xctest"
-               BlueprintName = "Starscream iOSTests"
-               ReferencedContainer = "container:Starscream.xcodeproj">
-            </BuildableReference>
-         </TestableReference>
-      </Testables>
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "6B3E79F019D48B7F006071F7"
-            BuildableName = "Starscream iOSTests.xctest"
-            BlueprintName = "Starscream iOSTests"
-            ReferencedContainer = "container:Starscream.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
-   </TestAction>
-   <LaunchAction
-      buildConfiguration = "Debug"
-      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
-      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      launchStyle = "0"
-      useCustomWorkingDirectory = "NO"
-      ignoresPersistentStateOnLaunch = "NO"
-      debugDocumentVersioning = "YES"
-      debugServiceExtension = "internal"
-      allowLocationSimulation = "YES">
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "6B3E79F019D48B7F006071F7"
-            BuildableName = "Starscream iOSTests.xctest"
-            BlueprintName = "Starscream iOSTests"
-            ReferencedContainer = "container:Starscream.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
-   </LaunchAction>
-   <ProfileAction
-      buildConfiguration = "Release"
-      shouldUseLaunchSchemeArgsEnv = "YES"
-      savedToolIdentifier = ""
-      useCustomWorkingDirectory = "NO"
-      debugDocumentVersioning = "YES">
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "6B3E79F019D48B7F006071F7"
-            BuildableName = "Starscream iOSTests.xctest"
-            BlueprintName = "Starscream iOSTests"
-            ReferencedContainer = "container:Starscream.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-   </ProfileAction>
-   <AnalyzeAction
-      buildConfiguration = "Debug">
-   </AnalyzeAction>
-   <ArchiveAction
-      buildConfiguration = "Release"
-      revealArchiveInOrganizer = "YES">
-   </ArchiveAction>
-</Scheme>

Starscream.xcodeproj/xcshareddata/xcschemes/StarscreamTv.xcscheme

@@ -1,113 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Scheme
-   LastUpgradeVersion = "0800"
-   version = "1.3">
-   <BuildAction
-      parallelizeBuildables = "YES"
-      buildImplicitDependencies = "YES">
-      <BuildActionEntries>
-         <BuildActionEntry
-            buildForTesting = "YES"
-            buildForRunning = "YES"
-            buildForProfiling = "YES"
-            buildForArchiving = "YES"
-            buildForAnalyzing = "YES">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "091277961BD673A70003036D"
-               BuildableName = "Starscream.framework"
-               BlueprintName = "Starscream tvOS"
-               ReferencedContainer = "container:Starscream.xcodeproj">
-            </BuildableReference>
-         </BuildActionEntry>
-         <BuildActionEntry
-            buildForTesting = "YES"
-            buildForRunning = "YES"
-            buildForProfiling = "NO"
-            buildForArchiving = "NO"
-            buildForAnalyzing = "YES">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "0912779F1BD673A70003036D"
-               BuildableName = "Starscream tvOSTests.xctest"
-               BlueprintName = "Starscream tvOSTests"
-               ReferencedContainer = "container:Starscream.xcodeproj">
-            </BuildableReference>
-         </BuildActionEntry>
-      </BuildActionEntries>
-   </BuildAction>
-   <TestAction
-      buildConfiguration = "Debug"
-      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
-      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
-      <Testables>
-         <TestableReference
-            skipped = "NO">
-            <BuildableReference
-               BuildableIdentifier = "primary"
-               BlueprintIdentifier = "0912779F1BD673A70003036D"
-               BuildableName = "Starscream tvOSTests.xctest"
-               BlueprintName = "Starscream tvOSTests"
-               ReferencedContainer = "container:Starscream.xcodeproj">
-            </BuildableReference>
-         </TestableReference>
-      </Testables>
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "091277961BD673A70003036D"
-            BuildableName = "Starscream.framework"
-            BlueprintName = "Starscream tvOS"
-            ReferencedContainer = "container:Starscream.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
-   </TestAction>
-   <LaunchAction
-      buildConfiguration = "Debug"
-      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
-      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      launchStyle = "0"
-      useCustomWorkingDirectory = "NO"
-      ignoresPersistentStateOnLaunch = "NO"
-      debugDocumentVersioning = "YES"
-      debugServiceExtension = "internal"
-      allowLocationSimulation = "YES">
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "091277961BD673A70003036D"
-            BuildableName = "Starscream.framework"
-            BlueprintName = "Starscream tvOS"
-            ReferencedContainer = "container:Starscream.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
-   </LaunchAction>
-   <ProfileAction
-      buildConfiguration = "Release"
-      shouldUseLaunchSchemeArgsEnv = "YES"
-      savedToolIdentifier = ""
-      useCustomWorkingDirectory = "NO"
-      debugDocumentVersioning = "YES">
-      <MacroExpansion>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "091277961BD673A70003036D"
-            BuildableName = "Starscream.framework"
-            BlueprintName = "Starscream tvOS"
-            ReferencedContainer = "container:Starscream.xcodeproj">
-         </BuildableReference>
-      </MacroExpansion>
-   </ProfileAction>
-   <AnalyzeAction
-      buildConfiguration = "Debug">
-   </AnalyzeAction>
-   <ArchiveAction
-      buildConfiguration = "Release"
-      revealArchiveInOrganizer = "YES">
-   </ArchiveAction>
-</Scheme>

Tests/CompressionTests.swift

@@ -0,0 +1,65 @@
+//////////////////////////////////////////////////////////////////////////////////////////////////
+//
+//  CompressionTests.swift
+//
+//  Created by Joseph Ross on 7/16/14.
+//  Copyright © 2017 Joseph Ross.
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+//////////////////////////////////////////////////////////////////////////////////////////////////
+
+import XCTest
+
+class CompressionTests: XCTestCase {
+    
+    override func setUp() {
+        super.setUp()
+        // Put setup code here. This method is called before the invocation of each test method in the class.
+    }
+    
+    override func tearDown() {
+        // Put teardown code here. This method is called after the invocation of each test method in the class.
+        super.tearDown()
+    }
+    
+    func testBasic() {
+        let compressor = Compressor(windowBits: 15)!
+        let decompressor = Decompressor(windowBits: 15)!
+        
+        let rawData = "Hello, World! Hello, World! Hello, World! Hello, World! Hello, World!".data(using: .utf8)!
+        
+        let compressed = try! compressor.compress(rawData)
+        let uncompressed = try! decompressor.decompress(compressed, finish: true)
+        
+        XCTAssert(rawData == uncompressed)
+    }
+    
+    func testHugeData() {
+        let compressor = Compressor(windowBits: 15)!
+        let decompressor = Decompressor(windowBits: 15)!
+        
+        // 2 Gigs!
+//        var rawData = Data(repeating: 0, count: 0x80000000)
+        var rawData = Data(repeating: 0, count: 0x80000)
+        rawData.withUnsafeMutableBytes { (ptr: UnsafeMutablePointer<UInt8>) -> Void in
+            arc4random_buf(ptr, rawData.count)
+        }
+        
+        let compressed = try! compressor.compress(rawData)
+        let uncompressed = try! decompressor.decompress(compressed, finish: true)
+        
+        XCTAssert(rawData == uncompressed)
+    }
+    
+}

examples/AutobahnTest/Autobahn.xcodeproj/project.pbxproj

@@ -59,6 +59,20 @@
 			remoteGlobalIDString = 6B3E79E519D48B7F006071F7;
 			remoteInfo = Starscream;
 		};
+		5C42C3D51D8DF51C00947AA2 /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = 5C178E411B62D0EF00A97204 /* Starscream.xcodeproj */;
+			proxyType = 2;
+			remoteGlobalIDString = 091277971BD673A70003036D;
+			remoteInfo = "Starscream tvOS";
+		};
+		5C42C3D71D8DF51C00947AA2 /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = 5C178E411B62D0EF00A97204 /* Starscream.xcodeproj */;
+			proxyType = 2;
+			remoteGlobalIDString = 091277A01BD673A70003036D;
+			remoteInfo = "Starscream tvOSTests";
+		};
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXFileReference section */
@@ -158,6 +172,8 @@
 				5C178E4B1B62D0EF00A97204 /* StarscreamTests.xctest */,
 				5C178E4D1B62D0EF00A97204 /* Starscream.framework */,
 				5C178E4F1B62D0EF00A97204 /* StarscreamOSXTests.xctest */,
+				5C42C3D61D8DF51C00947AA2 /* Starscream.framework */,
+				5C42C3D81D8DF51C00947AA2 /* Starscream tvOSTests.xctest */,
 			);
 			name = Products;
 			sourceTree = "<group>";
@@ -214,9 +230,11 @@
 				TargetAttributes = {
 					5C178E1B1B62D0B900A97204 = {
 						CreatedOnToolsVersion = 6.4;
+						LastSwiftMigration = 0800;
 					};
 					5C178E301B62D0B900A97204 = {
 						CreatedOnToolsVersion = 6.4;
+						LastSwiftMigration = 0800;
 						TestTargetID = 5C178E1B1B62D0B900A97204;
 					};
 				};
@@ -257,7 +275,7 @@
 		5C178E4B1B62D0EF00A97204 /* StarscreamTests.xctest */ = {
 			isa = PBXReferenceProxy;
 			fileType = wrapper.cfbundle;
-			path = StarscreamTests.xctest;
+			path = "Starscream iOSTests.xctest";
 			remoteRef = 5C178E4A1B62D0EF00A97204 /* PBXContainerItemProxy */;
 			sourceTree = BUILT_PRODUCTS_DIR;
 		};
@@ -271,10 +289,24 @@
 		5C178E4F1B62D0EF00A97204 /* StarscreamOSXTests.xctest */ = {
 			isa = PBXReferenceProxy;
 			fileType = wrapper.cfbundle;
-			path = StarscreamOSXTests.xctest;
+			path = "Starscream OSXTests.xctest";
 			remoteRef = 5C178E4E1B62D0EF00A97204 /* PBXContainerItemProxy */;
 			sourceTree = BUILT_PRODUCTS_DIR;
 		};
+		5C42C3D61D8DF51C00947AA2 /* Starscream.framework */ = {
+			isa = PBXReferenceProxy;
+			fileType = wrapper.framework;
+			path = Starscream.framework;
+			remoteRef = 5C42C3D51D8DF51C00947AA2 /* PBXContainerItemProxy */;
+			sourceTree = BUILT_PRODUCTS_DIR;
+		};
+		5C42C3D81D8DF51C00947AA2 /* Starscream tvOSTests.xctest */ = {
+			isa = PBXReferenceProxy;
+			fileType = wrapper.cfbundle;
+			path = "Starscream tvOSTests.xctest";
+			remoteRef = 5C42C3D71D8DF51C00947AA2 /* PBXContainerItemProxy */;
+			sourceTree = BUILT_PRODUCTS_DIR;
+		};
 /* End PBXReferenceProxy section */
 
 /* Begin PBXResourcesBuildPhase section */
@@ -440,6 +472,7 @@
 				INFOPLIST_FILE = Autobahn/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				SWIFT_VERSION = 3.0;
 			};
 			name = Debug;
 		};
@@ -450,6 +483,7 @@
 				INFOPLIST_FILE = Autobahn/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				SWIFT_VERSION = 3.0;
 			};
 			name = Release;
 		};
@@ -468,6 +502,7 @@
 				INFOPLIST_FILE = AutobahnTests/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				SWIFT_VERSION = 3.0;
 				TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Autobahn.app/Autobahn";
 			};
 			name = Debug;
@@ -483,6 +518,7 @@
 				INFOPLIST_FILE = AutobahnTests/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				SWIFT_VERSION = 3.0;
 				TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Autobahn.app/Autobahn";
 			};
 			name = Release;

examples/AutobahnTest/Autobahn/AppDelegate.swift

@@ -14,30 +14,30 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     var window: UIWindow?
 
 
-    func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
+    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
         // Override point for customization after application launch.
         return true
     }
 
-    func applicationWillResignActive(application: UIApplication) {
+    func applicationWillResignActive(_ application: UIApplication) {
         // Sent when the application is about to move from active to inactive state. This can occur for certain types of temporary interruptions (such as an incoming phone call or SMS message) or when the user quits the application and it begins the transition to the background state.
         // Use this method to pause ongoing tasks, disable timers, and throttle down OpenGL ES frame rates. Games should use this method to pause the game.
     }
 
-    func applicationDidEnterBackground(application: UIApplication) {
+    func applicationDidEnterBackground(_ application: UIApplication) {
         // Use this method to release shared resources, save user data, invalidate timers, and store enough application state information to restore your application to its current state in case it is terminated later.
         // If your application supports background execution, this method is called instead of applicationWillTerminate: when the user quits.
     }
 
-    func applicationWillEnterForeground(application: UIApplication) {
+    func applicationWillEnterForeground(_ application: UIApplication) {
         // Called as part of the transition from the background to the inactive state; here you can undo many of the changes made on entering the background.
     }
 
-    func applicationDidBecomeActive(application: UIApplication) {
+    func applicationDidBecomeActive(_ application: UIApplication) {
         // Restart any tasks that were paused (or not yet started) while the application was inactive. If the application was previously in the background, optionally refresh the user interface.
     }
 
-    func applicationWillTerminate(application: UIApplication) {
+    func applicationWillTerminate(_ application: UIApplication) {
         // Called when the application is about to terminate. Save data if appropriate. See also applicationDidEnterBackground:.
     }
 

examples/AutobahnTest/Autobahn/ViewController.swift

@@ -12,7 +12,6 @@ import Starscream
 class ViewController: UIViewController {
     
     let host = "localhost:9001"
-    let scheme = "ws"
     var socketArray = [WebSocket]()
     var caseCount = 300 //starting cases
     override func viewDidLoad() {
@@ -21,30 +20,31 @@ class ViewController: UIViewController {
         //getTestInfo(1)
     }
     
-    func removeSocket(s: WebSocket) {
-        self.socketArray = self.socketArray.filter{$0 != s}
+    func removeSocket(_ s: WebSocket?) {
+        socketArray = socketArray.filter{$0 != s}
     }
     
     func getCaseCount() {
-        let s = WebSocket(url: NSURL(scheme: scheme, host: host, path: "/getCaseCount")!, protocols: [])
+        
+        let s = WebSocket(url: URL(string: "ws://\(host)/getCaseCount")!, protocols: [])
         socketArray.append(s)
-        s.onText = {[unowned self] (text: String) in
+        s.onText = { [weak self]  (text: String) in
             if let c = Int(text) {
                 print("number of cases is: \(c)")
-                self.caseCount = c
+                self?.caseCount = c
             }
         }
-        s.onDisconnect = {[unowned self] (error: NSError?) in
-            self.getTestInfo(1)
-            self.removeSocket(s)
+        s.onDisconnect = { [weak self, weak s]  (error: Error?) in
+            self?.getTestInfo(1)
+            self?.removeSocket(s)
         }
         s.connect()
     }
     
-    func getTestInfo(caseNum: Int) {
+    func getTestInfo(_ caseNum: Int) {
         let s = createSocket("getCaseInfo",caseNum)
         socketArray.append(s)
-        s.onText = {(text: String) in
+        s.onText = { (text: String) in
 //            let data = text.dataUsingEncoding(NSUTF8StringEncoding)
 //            do {
 //                let resp: AnyObject? = try NSJSONSerialization.JSONObjectWithData(data!,
@@ -62,45 +62,52 @@ class ViewController: UIViewController {
 
         }
         var once = false
-        s.onDisconnect = {[unowned self] (error: NSError?) in
+        s.onDisconnect = { [weak self, weak s]  (error: Error?) in
             if !once {
                 once = true
-                self.runTest(caseNum)
+                self?.runTest(caseNum)
             }
-            self.removeSocket(s)
+            self?.removeSocket(s)
         }
         s.connect()
     }
     
-    func runTest(caseNum: Int) {
+    func runTest(_ caseNum: Int) {
         let s = createSocket("runCase",caseNum)
         self.socketArray.append(s)
-        s.onText = {(text: String) in
-            s.writeString(text)
+        s.onText = { [weak s]  (text: String) in
+            s?.write(string: text)
         }
-        s.onData = {(data: NSData) in
-            s.writeData(data)
+        s.onData = { [weak s]  (data: Data) in
+            s?.write(data: data)
         }
         var once = false
-        s.onDisconnect = {[unowned self] (error: NSError?) in
+        s.onDisconnect = {[weak self, weak s] (error: Error?) in
             if !once {
                 once = true
                 print("case:\(caseNum) finished")
-                self.verifyTest(caseNum)
-                self.removeSocket(s)
+                //self?.verifyTest(caseNum) //disabled since it slows down the tests
+                let nextCase = caseNum+1
+                if nextCase <= (self?.caseCount)! {
+                    self?.runTest(nextCase)
+                    //self?.getTestInfo(nextCase) //disabled since it slows down the tests
+                } else {
+                    self?.finishReports()
+                }
+                self?.removeSocket(s)
             }
         }
         s.connect()
     }
     
-    func verifyTest(caseNum: Int) {
+    func verifyTest(_ caseNum: Int) {
         let s = createSocket("getCaseStatus",caseNum)
         self.socketArray.append(s)
-        s.onText = {(text: String) in
-            let data = text.dataUsingEncoding(NSUTF8StringEncoding)
+        s.onText = { (text: String) in
+            let data = text.data(using: String.Encoding.utf8)
             do {
-                let resp: AnyObject? = try NSJSONSerialization.JSONObjectWithData(data!,
-                    options: NSJSONReadingOptions())
+                let resp: Any? = try JSONSerialization.jsonObject(with: data!,
+                    options: JSONSerialization.ReadingOptions())
                 if let dict = resp as? Dictionary<String,String> {
                     if let status = dict["behavior"] {
                         if status == "OK" {
@@ -115,17 +122,18 @@ class ViewController: UIViewController {
             }
         }
         var once = false
-        s.onDisconnect = {[unowned self] (error: NSError?) in
+        s.onDisconnect = { [weak self, weak s]  (error: Error?) in
             if !once {
                 once = true
                 let nextCase = caseNum+1
-                if nextCase <= self.caseCount {
-                    self.getTestInfo(nextCase)
+                print("next test is: \(nextCase)")
+                if nextCase <= (self?.caseCount)! {
+                    self?.getTestInfo(nextCase)
                 } else {
-                    self.finishReports()
+                    self?.finishReports()
                 }
             }
-            self.removeSocket(s)
+            self?.removeSocket(s)
         }
         s.connect()
     }
@@ -133,19 +141,18 @@ class ViewController: UIViewController {
     func finishReports() {
         let s = createSocket("updateReports",0)
         self.socketArray.append(s)
-        s.onDisconnect = {[unowned self] (error: NSError?) in
+        s.onDisconnect = { [weak self, weak s]  (error: Error?) in
             print("finished all the tests!")
-            self.removeSocket(s)
+            self?.removeSocket(s)
         }
         s.connect()
     }
     
-    func createSocket(cmd: String, _ caseNum: Int) -> WebSocket {
-        return WebSocket(url: NSURL(scheme: scheme,
-            host: host, path: buildPath(cmd,caseNum))!, protocols: [])
+    func createSocket(_ cmd: String, _ caseNum: Int) -> WebSocket {
+        return WebSocket(url: URL(string: "ws://\(host)\(buildPath(cmd,caseNum))")!, protocols: [])
     }
     
-    func buildPath(cmd: String, _ caseNum: Int) -> String {
+    func buildPath(_ cmd: String, _ caseNum: Int) -> String {
         return "/\(cmd)?case=\(caseNum)&agent=Starscream"
     }
 

examples/AutobahnTest/AutobahnTests/AutobahnTests.swift

@@ -28,7 +28,7 @@ class AutobahnTests: XCTestCase {
     
     func testPerformanceExample() {
         // This is an example of a performance test case.
-        self.measureBlock() {
+        self.measure() {
             // Put the code you want to measure the time of here.
         }
     }

examples/SimpleTest/SimpleTest.xcodeproj/project.pbxproj

@@ -37,6 +37,20 @@
 			remoteGlobalIDString = D9C3E36919E48FF1009FC285;
 			remoteInfo = StarscreamOSXTests;
 		};
+		5C42C3E01D8F31DC00947AA2 /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = 6B3E7A0819D48D00006071F7 /* Starscream.xcodeproj */;
+			proxyType = 2;
+			remoteGlobalIDString = 091277971BD673A70003036D;
+			remoteInfo = "Starscream tvOS";
+		};
+		5C42C3E21D8F31DC00947AA2 /* PBXContainerItemProxy */ = {
+			isa = PBXContainerItemProxy;
+			containerPortal = 6B3E7A0819D48D00006071F7 /* Starscream.xcodeproj */;
+			proxyType = 2;
+			remoteGlobalIDString = 091277A01BD673A70003036D;
+			remoteInfo = "Starscream tvOSTests";
+		};
 		6B3E7A0D19D48D00006071F7 /* PBXContainerItemProxy */ = {
 			isa = PBXContainerItemProxy;
 			containerPortal = 6B3E7A0819D48D00006071F7 /* Starscream.xcodeproj */;
@@ -129,9 +143,11 @@
 			isa = PBXGroup;
 			children = (
 				6B3E7A0E19D48D00006071F7 /* Starscream.framework */,
-				6B3E7A1019D48D00006071F7 /* StarscreamTests.xctest */,
+				6B3E7A1019D48D00006071F7 /* Starscream iOSTests.xctest */,
 				5C06AE8B1B08044600D41060 /* Starscream.framework */,
-				5C06AE8D1B08044600D41060 /* StarscreamOSXTests.xctest */,
+				5C06AE8D1B08044600D41060 /* Starscream OSXTests.xctest */,
+				5C42C3E11D8F31DC00947AA2 /* Starscream.framework */,
+				5C42C3E31D8F31DC00947AA2 /* Starscream tvOSTests.xctest */,
 			);
 			name = Products;
 			sourceTree = "<group>";
@@ -165,11 +181,12 @@
 			isa = PBXProject;
 			attributes = {
 				LastSwiftUpdateCheck = 0700;
-				LastUpgradeCheck = 0600;
+				LastUpgradeCheck = 0900;
 				ORGANIZATIONNAME = vluxe;
 				TargetAttributes = {
 					5C765ADA199A6DAA003D9110 = {
 						CreatedOnToolsVersion = 6.0;
+						LastSwiftMigration = 0800;
 					};
 				};
 			};
@@ -205,13 +222,27 @@
 			remoteRef = 5C06AE8A1B08044600D41060 /* PBXContainerItemProxy */;
 			sourceTree = BUILT_PRODUCTS_DIR;
 		};
-		5C06AE8D1B08044600D41060 /* StarscreamOSXTests.xctest */ = {
+		5C06AE8D1B08044600D41060 /* Starscream OSXTests.xctest */ = {
 			isa = PBXReferenceProxy;
 			fileType = wrapper.cfbundle;
-			path = StarscreamOSXTests.xctest;
+			path = "Starscream OSXTests.xctest";
 			remoteRef = 5C06AE8C1B08044600D41060 /* PBXContainerItemProxy */;
 			sourceTree = BUILT_PRODUCTS_DIR;
 		};
+		5C42C3E11D8F31DC00947AA2 /* Starscream.framework */ = {
+			isa = PBXReferenceProxy;
+			fileType = wrapper.framework;
+			path = Starscream.framework;
+			remoteRef = 5C42C3E01D8F31DC00947AA2 /* PBXContainerItemProxy */;
+			sourceTree = BUILT_PRODUCTS_DIR;
+		};
+		5C42C3E31D8F31DC00947AA2 /* Starscream tvOSTests.xctest */ = {
+			isa = PBXReferenceProxy;
+			fileType = wrapper.cfbundle;
+			path = "Starscream tvOSTests.xctest";
+			remoteRef = 5C42C3E21D8F31DC00947AA2 /* PBXContainerItemProxy */;
+			sourceTree = BUILT_PRODUCTS_DIR;
+		};
 		6B3E7A0E19D48D00006071F7 /* Starscream.framework */ = {
 			isa = PBXReferenceProxy;
 			fileType = wrapper.framework;
@@ -219,10 +250,10 @@
 			remoteRef = 6B3E7A0D19D48D00006071F7 /* PBXContainerItemProxy */;
 			sourceTree = BUILT_PRODUCTS_DIR;
 		};
-		6B3E7A1019D48D00006071F7 /* StarscreamTests.xctest */ = {
+		6B3E7A1019D48D00006071F7 /* Starscream iOSTests.xctest */ = {
 			isa = PBXReferenceProxy;
 			fileType = wrapper.cfbundle;
-			path = StarscreamTests.xctest;
+			path = "Starscream iOSTests.xctest";
 			remoteRef = 6B3E7A0F19D48D00006071F7 /* PBXContainerItemProxy */;
 			sourceTree = BUILT_PRODUCTS_DIR;
 		};
@@ -280,20 +311,30 @@
 				CLANG_CXX_LIBRARY = "libc++";
 				CLANG_ENABLE_MODULES = YES;
 				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES;
 				CLANG_WARN_BOOL_CONVERSION = YES;
+				CLANG_WARN_COMMA = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
 				CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
 				CLANG_WARN_EMPTY_BODY = YES;
 				CLANG_WARN_ENUM_CONVERSION = YES;
+				CLANG_WARN_INFINITE_RECURSION = YES;
 				CLANG_WARN_INT_CONVERSION = YES;
+				CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
+				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
+				CLANG_WARN_STRICT_PROTOTYPES = YES;
+				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
 				COPY_PHASE_STRIP = NO;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
+				ENABLE_TESTABILITY = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu99;
 				GCC_DYNAMIC_NO_PIC = NO;
+				GCC_NO_COMMON_BLOCKS = YES;
 				GCC_OPTIMIZATION_LEVEL = 0;
 				GCC_PREPROCESSOR_DEFINITIONS = (
 					"DEBUG=1",
@@ -323,13 +364,21 @@
 				CLANG_CXX_LIBRARY = "libc++";
 				CLANG_ENABLE_MODULES = YES;
 				CLANG_ENABLE_OBJC_ARC = YES;
+				CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES;
 				CLANG_WARN_BOOL_CONVERSION = YES;
+				CLANG_WARN_COMMA = YES;
 				CLANG_WARN_CONSTANT_CONVERSION = YES;
 				CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR;
 				CLANG_WARN_EMPTY_BODY = YES;
 				CLANG_WARN_ENUM_CONVERSION = YES;
+				CLANG_WARN_INFINITE_RECURSION = YES;
 				CLANG_WARN_INT_CONVERSION = YES;
+				CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES;
+				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
+				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
+				CLANG_WARN_STRICT_PROTOTYPES = YES;
+				CLANG_WARN_SUSPICIOUS_MOVE = YES;
 				CLANG_WARN_UNREACHABLE_CODE = YES;
 				CLANG_WARN__DUPLICATE_METHOD_MATCH = YES;
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
@@ -337,6 +386,7 @@
 				ENABLE_NS_ASSERTIONS = NO;
 				ENABLE_STRICT_OBJC_MSGSEND = YES;
 				GCC_C_LANGUAGE_STANDARD = gnu99;
+				GCC_NO_COMMON_BLOCKS = YES;
 				GCC_WARN_64_TO_32_BIT_CONVERSION = YES;
 				GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR;
 				GCC_WARN_UNDECLARED_SELECTOR = YES;
@@ -346,6 +396,7 @@
 				IPHONEOS_DEPLOYMENT_TARGET = 8.0;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				SDKROOT = iphoneos;
+				SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule";
 				TARGETED_DEVICE_FAMILY = "1,2";
 				VALIDATE_PRODUCT = YES;
 			};
@@ -358,7 +409,9 @@
 				ASSETCATALOG_COMPILER_LAUNCHIMAGE_NAME = LaunchImage;
 				INFOPLIST_FILE = SimpleTest/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
+				PRODUCT_BUNDLE_IDENTIFIER = "com.vluxe.io.$(PRODUCT_NAME:rfc1034identifier)";
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				SWIFT_VERSION = 4.0;
 			};
 			name = Debug;
 		};
@@ -369,7 +422,9 @@
 				ASSETCATALOG_COMPILER_LAUNCHIMAGE_NAME = LaunchImage;
 				INFOPLIST_FILE = SimpleTest/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
+				PRODUCT_BUNDLE_IDENTIFIER = "com.vluxe.io.$(PRODUCT_NAME:rfc1034identifier)";
 				PRODUCT_NAME = "$(TARGET_NAME)";
+				SWIFT_VERSION = 4.0;
 			};
 			name = Release;
 		};

examples/SimpleTest/SimpleTest.xcodeproj/xcuserdata/dalton.xcuserdatad/xcschemes/SimpleTest.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0600"
+   LastUpgradeVersion = "0900"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -37,10 +37,11 @@
       </BuildActionEntries>
    </BuildAction>
    <TestAction
+      buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES"
-      buildConfiguration = "Debug">
+      language = ""
+      shouldUseLaunchSchemeArgsEnv = "YES">
       <Testables>
          <TestableReference
             skipped = "NO">
@@ -62,17 +63,22 @@
             ReferencedContainer = "container:SimpleTest.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
+      <AdditionalOptions>
+      </AdditionalOptions>
    </TestAction>
    <LaunchAction
+      buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      language = ""
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
-      buildConfiguration = "Debug"
       ignoresPersistentStateOnLaunch = "NO"
       debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
       allowLocationSimulation = "YES">
-      <BuildableProductRunnable>
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
          <BuildableReference
             BuildableIdentifier = "primary"
             BlueprintIdentifier = "5C765ADA199A6DAA003D9110"
@@ -81,16 +87,24 @@
             ReferencedContainer = "container:SimpleTest.xcodeproj">
          </BuildableReference>
       </BuildableProductRunnable>
+      <EnvironmentVariables>
+         <EnvironmentVariable
+            key = "OS_ACTIVITY_MODE"
+            value = "disable"
+            isEnabled = "YES">
+         </EnvironmentVariable>
+      </EnvironmentVariables>
       <AdditionalOptions>
       </AdditionalOptions>
    </LaunchAction>
    <ProfileAction
+      buildConfiguration = "Release"
       shouldUseLaunchSchemeArgsEnv = "YES"
       savedToolIdentifier = ""
       useCustomWorkingDirectory = "NO"
-      buildConfiguration = "Release"
       debugDocumentVersioning = "YES">
-      <BuildableProductRunnable>
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
          <BuildableReference
             BuildableIdentifier = "primary"
             BlueprintIdentifier = "5C765ADA199A6DAA003D9110"

examples/SimpleTest/SimpleTest/AppDelegate.swift

@@ -14,30 +14,30 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     var window: UIWindow?
 
 
-    func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject : AnyObject]?) -> Bool {
+    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
         // Override point for customization after application launch.
         return true
     }
 
-    func applicationWillResignActive(application: UIApplication) {
+    func applicationWillResignActive(_ application: UIApplication) {
         // Sent when the application is about to move from active to inactive state. This can occur for certain types of temporary interruptions (such as an incoming phone call or SMS message) or when the user quits the application and it begins the transition to the background state.
         // Use this method to pause ongoing tasks, disable timers, and throttle down OpenGL ES frame rates. Games should use this method to pause the game.
     }
 
-    func applicationDidEnterBackground(application: UIApplication) {
+    func applicationDidEnterBackground(_ application: UIApplication) {
         // Use this method to release shared resources, save user data, invalidate timers, and store enough application state information to restore your application to its current state in case it is terminated later.
         // If your application supports background execution, this method is called instead of applicationWillTerminate: when the user quits.
     }
 
-    func applicationWillEnterForeground(application: UIApplication) {
+    func applicationWillEnterForeground(_ application: UIApplication) {
         // Called as part of the transition from the background to the inactive state; here you can undo many of the changes made on entering the background.
     }
 
-    func applicationDidBecomeActive(application: UIApplication) {
+    func applicationDidBecomeActive(_ application: UIApplication) {
         // Restart any tasks that were paused (or not yet started) while the application was inactive. If the application was previously in the background, optionally refresh the user interface.
     }
 
-    func applicationWillTerminate(application: UIApplication) {
+    func applicationWillTerminate(_ application: UIApplication) {
         // Called when the application is about to terminate. Save data if appropriate. See also applicationDidEnterBackground:.
     }
 

examples/SimpleTest/SimpleTest/Info.plist

@@ -7,7 +7,7 @@
 	<key>CFBundleExecutable</key>
 	<string>$(EXECUTABLE_NAME)</string>
 	<key>CFBundleIdentifier</key>
-	<string>com.vluxe.io.$(PRODUCT_NAME:rfc1034identifier)</string>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 	<key>CFBundleInfoDictionaryVersion</key>
 	<string>6.0</string>
 	<key>CFBundleName</key>

examples/SimpleTest/SimpleTest/ViewController.swift

@@ -10,7 +10,7 @@ import UIKit
 import Starscream
 
 class ViewController: UIViewController, WebSocketDelegate {
-    var socket = WebSocket(url: NSURL(string: "ws://localhost:8080/")!, protocols: ["chat", "superchat"])
+    var socket = WebSocket(url: URL(string: "ws://localhost:8080/")!, protocols: ["chat", "superchat"])
     
     override func viewDidLoad() {
         super.viewDidLoad()
@@ -20,11 +20,11 @@ class ViewController: UIViewController, WebSocketDelegate {
     
     // MARK: Websocket Delegate Methods.
     
-    func websocketDidConnect(ws: WebSocket) {
+    func websocketDidConnect(socket: WebSocketClient) {
         print("websocket is connected")
     }
     
-    func websocketDidDisconnect(ws: WebSocket, error: NSError?) {
+    func websocketDidDisconnect(socket: WebSocketClient, error: Error?) {
         if let e = error {
             print("websocket is disconnected: \(e.localizedDescription)")
         } else {
@@ -32,23 +32,23 @@ class ViewController: UIViewController, WebSocketDelegate {
         }
     }
     
-    func websocketDidReceiveMessage(ws: WebSocket, text: String) {
+    func websocketDidReceiveMessage(socket: WebSocketClient, text: String) {
         print("Received text: \(text)")
     }
     
-    func websocketDidReceiveData(ws: WebSocket, data: NSData) {
-        print("Received data: \(data.length)")
+    func websocketDidReceiveData(socket: WebSocketClient, data: Data) {
+        print("Received data: \(data.count)")
     }
     
     // MARK: Write Text Action
     
-    @IBAction func writeText(sender: UIBarButtonItem) {
-        socket.writeString("hello there!")
+    @IBAction func writeText(_ sender: UIBarButtonItem) {
+        socket.write(string: "hello there!")
     }
     
     // MARK: Disconnect Action
     
-    @IBAction func disconnect(sender: UIBarButtonItem) {
+    @IBAction func disconnect(_ sender: UIBarButtonItem) {
         if socket.isConnected {
             sender.title = "Connect"
             socket.disconnect()

examples/SimpleTest/ws-server.rb

@@ -22,4 +22,4 @@ EM.run {
       ws.send Faker::Hacker.say_something_smart
     }
   end
-}
+}

zlib/include.h

@@ -0,0 +1,2 @@
+#include <zlib.h>
+#include <CommonCrypto/CommonCrypto.h>

zlib/module.modulemap

@@ -0,0 +1,9 @@
+module SSCZLib [system] {
+    header "include.h"
+    link "z"
+    export *
+}
+module SSCommonCrypto [system] {
+    header "include.h"
+    export *
+}