#Socket.IO-Client-Swift Socket.IO-client for iOS/OS X.
##Example
import SocketIO
let socket = SocketIOClient(socketURL: URL(string: "http://localhost:8080")!, config: [.log(true), .forcePolling(true)])
socket.on("connect") {data, ack in
print("socket connected")
}
socket.on("currentAmount") {data, ack in
if let cur = data[0] as? Double {
socket.emitWithAck("canUpdate", cur).timingOut(after: 0) {data in
socket.emit("update", ["amount": cur + 2.50])
}
ack.with("Got your currentAmount", "dude")
}
}
socket.connect()
##Objective-C Example
@import SocketIO;
NSURL* url = [[NSURL alloc] initWithString:@"http://localhost:8080"];
SocketIOClient* socket = [[SocketIOClient alloc] initWithSocketURL:url config:@{@"log": @YES, @"forcePolling": @YES}];
[socket on:@"connect" callback:^(NSArray* data, SocketAckEmitter* ack) {
NSLog(@"socket connected");
}];
[socket on:@"currentAmount" callback:^(NSArray* data, SocketAckEmitter* ack) {
double cur = [[data objectAtIndex:0] floatValue];
[[socket emitWithAck:@"canUpdate" with:@[@(cur)]] timingOutAfter:0 callback:^(NSArray* data) {
[socket emit:@"update" withItems:@[@{@"amount": @(cur + 2.50)}]];
}];
[ack with:@[@"Got your currentAmount, ", @"dude"]];
}];
[socket connect];
##Features
- Supports socket.io 1.0+
- Supports binary
- Supports Polling and WebSockets
- Supports TLS/SSL
- Can be used from Objective-C
##Installation Requires Swift 3/Xcode 8.x
If you need swift 2.3 use the swift2.3 tag (Pre-Swift 3 support is no longer maintained)
If you need swift 2.2 use 7.x (Pre-Swift 3 support is no longer maintained)
If you need Swift 2.1 use v5.5.0 (Pre-Swift 2.2 support is no longer maintained)
If you need Swift 1.2 use v2.4.5 (Pre-Swift 2 support is no longer maintained)
If you need Swift 1.1 use v1.5.2. (Pre-Swift 1.2 support is no longer maintained)
- Copy the Source folder into your Xcode project. (Make sure you add the files to your target(s))
- If you plan on using this from Objective-C, read this on exposing Swift code to Objective-C.
Add the project as a dependency to your Package.swift:
import PackageDescription
let package = Package(
name: "YourSocketIOProject",
dependencies: [
.Package(url: "https://github.com/socketio/socket.io-client-swift", majorVersion: 8)
]
)
Then import import SocketIO
.
Add this line to your Cartfile
:
github "socketio/socket.io-client-swift" ~> 8.3.3 # Or latest version
Run carthage update --platform ios,macosx
.
Create Podfile
and add pod 'Socket.IO-Client-Swift'
:
use_frameworks!
target 'YourApp' do
pod 'Socket.IO-Client-Swift', '~> 8.3.3' # Or latest version
end
Install pods:
$ pod install
Import the module:
Swift:
import SocketIO
Objective-C:
@import SocketIO;
Add this line to your Seedfile
:
github "socketio/socket.io-client-swift", "v8.3.3", :files => "Source/*.swift" # Or latest version
Run seed install
.
init(var socketURL: NSURL, config: SocketIOClientConfiguration = [])
- Creates a new SocketIOClient. If your socket.io server is secure, you need to specify https
in your socketURL.
convenience init(socketURL: NSURL, options: NSDictionary?)
- Same as above, but meant for Objective-C. See Options on how convert between SocketIOClientOptions and dictionary keys.
All options are a case of SocketIOClientOption. To get the Objective-C Option, convert the name to lowerCamelCase.
case connectParams([String: AnyObject]) // Dictionary whose contents will be passed with the connection.
case cookies([NSHTTPCookie]) // An array of NSHTTPCookies. Passed during the handshake. Default is nil.
case doubleEncodeUTF8(Bool) // Whether or not to double encode utf8. If using the node based server this should be true. Default is true.
case extraHeaders([String: String]) // Adds custom headers to the initial request. Default is nil.
case forcePolling(Bool) // `true` forces the client to use xhr-polling. Default is `false`
case forceNew(Bool) // Will a create a new engine for each connect. Useful if you find a bug in the engine related to reconnects
case forceWebsockets(Bool) // `true` forces the client to use WebSockets. Default is `false`
case handleQueue(dispatch_queue_t) // The dispatch queue that handlers are run on. Default is the main queue.
case log(Bool) // If `true` socket will log debug messages. Default is false.
case logger(SocketLogger) // Custom logger that conforms to SocketLogger. Will use the default logging otherwise.
case nsp(String) // The namespace to connect to. Must begin with /. Default is `/`
case path(String) // If the server uses a custom path. ex: `"/swift/"`. Default is `""`
case reconnects(Bool) // Whether to reconnect on server lose. Default is `true`
case reconnectAttempts(Int) // How many times to reconnect. Default is `-1` (infinite tries)
case reconnectWait(Int) // Amount of time to wait between reconnects. Default is `10`
case sessionDelegate(NSURLSessionDelegate) // Sets an NSURLSessionDelegate for the underlying engine. Useful if you need to handle self-signed certs. Default is nil.
case secure(Bool) // If the connection should use TLS. Default is false.
case security(SSLSecurity) // Allows you to set which certs are valid. Useful for SSL pinning.
case selfSigned(Bool) // Sets WebSocket.selfSignedSSL. Use this if you're using self-signed certs.
case voipEnabled(Bool) // Only use this option if you're using the client with VoIP services. Changes the way the WebSocket is created. Default is false
on(_ event: String, callback: NormalCallback) -> NSUUID
- Adds a handler for an event. Items are passed by an array.ack
can be used to send an ack when one is requested. See example. Returns a unique id for the handler.once(_ event: String, callback: NormalCallback) -> NSUUID
- Adds a handler that will only be executed once. Returns a unique id for the handler.onAny(callback:((event: String, items: AnyObject?)) -> Void)
- Adds a handler for all events. It will be called on any received event.emit(_ event: String, _ items: AnyObject...)
- Sends a message. Can send multiple items.emit(_ event: String, withItems items: [AnyObject])
-emit
for Objective-CemitWithAck(_ event: String, _ items: AnyObject...) -> OnAckCallback
- Sends a message that requests an acknowledgement from the server. Returns an object which you can use to add a handler. See example. Note: The message is not sent until you call timingOut(after:) on the returned object.emitWithAck(_ event: String, withItems items: [AnyObject]) -> OnAckCallback
-emitWithAck
for Objective-C. Note: The message is not sent until you call timingOutAfter on the returned object.connect()
- Establishes a connection to the server. A "connect" event is fired upon successful connection.connect(timeoutAfter timeoutAfter: Int, withTimeoutHandler handler: (() -> Void)?)
- Connect to the server. If it isn't connected after timeoutAfter seconds, the handler is called.disconnect()
- Closes the socket. Reopening a disconnected socket is not fully tested.reconnect()
- Causes the client to reconnect to the server.joinNamespace(_ namespace: String)
- Causes the client to join namespace. Shouldn't need to be called unless you change namespaces manually.leaveNamespace()
- Causes the client to leave the nsp and go back to /off(_ event: String)
- Removes all event handlers for event.off(id id: NSUUID)
- Removes the event that corresponds to id.removeAllHandlers()
- Removes all handlers.
connect
- Emitted when on a successful connection.disconnect
- Emitted when the connection is closed.error
- Emitted on an error.reconnect
- Emitted when the connection is starting to reconnect.reconnectAttempt
- Emitted when attempting to reconnect.
##Detailed Example A more detailed example can be found here
An example using the Swift Package Manager can be found here
##License MIT