Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ricardopereira/SocketIO-Kit
Socket.io iOS and OSX Client compatible with v1.0 and later
https://github.com/ricardopereira/SocketIO-Kit
Last synced: 14 days ago
JSON representation
Socket.io iOS and OSX Client compatible with v1.0 and later
- Host: GitHub
- URL: https://github.com/ricardopereira/SocketIO-Kit
- Owner: ricardopereira
- License: mit
- Archived: true
- Created: 2015-04-02T18:13:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-22T20:10:20.000Z (over 7 years ago)
- Last Synced: 2024-10-10T17:13:14.208Z (29 days ago)
- Language: Swift
- Homepage: https://ricardopereira.github.io/SocketIO-Kit
- Size: 504 KB
- Stars: 139
- Watchers: 6
- Forks: 12
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-swift-cn - SocketIO-Kit - Socket.io iOS and OSX Client. (Libs / Network)
- awesome-swift - SocketIO-Kit - Socket.io iOS/OSX Client compatible with v1.0 and later (HTTP)
README
#  SocketIO-Kit
⚠️ **This project is no longer maintained. Please use the official framework [Socket.IO-Client-Swift](https://github.com/socketio/socket.io-client-swift).**
SocketIO-Kit is a [Socket.io](http://socket.io) iOS client with type safe, clean syntax and speed in mind. WebSocket is the only transport that is implemented and it uses [SwiftWebSocket](https://github.com/tidwall/SwiftWebSocket).
[](https://github.com/Carthage/Carthage) [](http://cocoapods.org/pods/SocketIOKit) [](https://www.bitrise.io/app/d4c6b6bba39b8539) [](/LICENSE.md)
## Installation
#### 
[Carthage]
[Carthage]: https://github.com/Carthage/Carthage
```ruby
github "ricardopereira/SocketIO-Kit"
```
Then run `carthage update`.
Follow the current instructions in [Carthage's README][carthage-installation]
for up to date installation instructions.
[carthage-installation]: https://github.com/Carthage/Carthage#adding-frameworks-to-an-application
#### 
[CocoaPods]
[CocoaPods]: http://cocoapods.org
To install it, simply add the following line to your **Podfile**:
```ruby
pod "SocketIOKit"
```
You will also need to make sure you're opting into using frameworks:
```ruby
use_frameworks!
```
Then run `pod install` with CocoaPods 0.36 or newer.
#### Manually
[Download](https://github.com/ricardopereira/SocketIO-Kit/archive/master.zip) the project and copy the `SocketIO-Kit` folder into your project and use the `Source` files. You need [Runes] v2.0.0 (Swift 1.2) framework to run SocketIO-Kit because it uses infix operators for monadic functions and you need [SwiftWebSocket] v0.1.18 (Swift 1.2).
There is no need for `import SocketIOKit` when manually installing.
[Runes]: https://github.com/thoughtbot/Runes
[SwiftWebSocket]: https://github.com/tidwall/SwiftWebSocket
## Requirements
* iOS 8.0+ / Mac OS X 10.10+
* Xcode 6.3 (Swift 1.2)
⚠️ Swift 2.0 version, please use branch [`Swift2`](https://github.com/ricardopereira/SocketIO-Kit/tree/Swift2).
## Usage
```swift
import SocketIOKit
// Type safety events
enum AppEvents: String, Printable {
case ChatMessage = "chat message"
case GetImage = "getimage"
case Image = "image"
var description: String {
return self.rawValue
}
}
// Mutable
var socket: SocketIO!
socket = SocketIO(url: "http://localhost:8000/")
// or
// Immutable
let socket = SocketIO(url: "http://localhost:8000/")
socket.on(.ConnectError) {
switch $0 {
case .Failure(let error):
println(error)
default:
break
}
}.on(.TransportError) {
switch $0 {
case .Failure(let error):
println("WebSocket error: \(error)")
default:
break
}
}.on(.Connected) { result in
println("Connected")
socket.emit(.ChatMessage, withMessage: "I'm iOS")
}.on(.Disconnected) { result in
switch result {
case .Message(let reason):
println("Disconnected: \(reason)")
default:
break
}
}
socket.on(.ChatMessage) {
switch $0 {
case .Message(let message):
println("Remote: \(message)")
default:
println("Not supported")
}
}
socket.connect()
```
**Options**
```swift
socket = SocketIO(url: "http://localhost:8001/", withOptions: SocketIOOptions().namespace("/gallery"))
```
----
#### Examples
**Retrieving an image**
```js
// NodeJS Server
var io = require('socket.io')(http)
var fs = require('fs')
io.on('connection', function(socket) {
socket.on('getimage', function(msg) {
// Image
fs.readFile(__dirname + '/image.png', function(err, buf){
// It's possible to embed binary data within arbitrarily-complex objects
socket.emit('image', { image: true, buffer: buf.toString('base64') });
});
});
});
```
```swift
// SocketIO-Kit Client
socket.on(.Image) {
switch $0 {
case .JSON(let json):
if let image = json["buffer"] as? String >>- SocketIOUtilities.base64EncodedStringToUIImage {
println(image)
}
default:
println("Not supported")
}
}
```
----
**Working with structs**
```swift
struct ImageInfo: SocketIOObject {
let buffer: String
init(buffer: String) {
self.buffer = buffer
}
init(dict: NSDictionary) {
self.init(buffer: dict["buffer"] as! String) //Force casts should be avoided!
}
var asDictionary: NSDictionary {
return ["buffer": buffer]
}
}
```
```swift
// Example using ImageInfo
socket.on(.Image) {
switch $0 {
case .JSON(let json):
let imageInfo = ImageInfo(dict: json) //<---
if let image = imageInfo.buffer >>- SocketIOUtilities.base64EncodedStringToUIImage {
println(image)
}
default:
println("Not supported")
}
}
```
----
**Working with classes**
```swift
class Person: SocketIOObject {
let name: String
init(name: String) {
self.name = name
}
convenience required init(dict: NSDictionary) {
self.init(name: dict["name"] as! String) //Force casts should be avoided!
}
var asDictionary: NSDictionary {
return ["name": name]
}
}
```
```swift
// Example sending John instance
let john = Person(name: "John")
socket.emit(.Login, withObject: john)
```
## Features
###### To implement
- [ ] Reconnect automatically
- [x] Complete documentation
- [ ] Test on iOS 7.0+ and Mac OS X 10.9+
- [ ] BDD Tests
## Debugging
You can opt into seeing messages by supplying the DEBUG flag. Just add `-D DEBUG` in `Build Settings > Swift Compiler - Custom Flags: Other Swift Flags`.
## Contributing
See the [CONTRIBUTING] document. Thank you, [contributors]!
[CONTRIBUTING]: CONTRIBUTING.md
[contributors]: https://github.com/ricardopereira/SocketIO-Kit/graphs/contributors
## Author
Ricardo Pereira, [@ricardopereiraw](https://twitter.com/ricardopereiraw)