Build Status

Socket.IO-Client-Swift

适用于 iOS/OS X 的 Socket.IO 客户端。

示例

import SocketIO

let manager = SocketManager(socketURL: URL(string: "https://:8080")!, config: [.log(true), .compress])
let socket = manager.defaultSocket

socket.on(clientEvent: .connect) {data, ack in
    print("socket connected")
}

socket.on("currentAmount") {data, ack in
    guard let cur = data[0] as? Double else { return }
    
    socket.emitWithAck("canUpdate", cur).timingOut(after: 0) {data in
        if data.first as? String ?? "passed" == SocketAckStatus.noAck {
            // Handle ack timeout 
        }

        socket.emit("update", ["amount": cur + 2.50])
    }

    ack.with("Got your currentAmount", "dude")
}

socket.connect()

功能特性

常见问题解答

查看 常见问题解答 以获取常见问题。

查看 12to13 指南,了解如何从 v12 迁移到 v13+。

查看 15to16 指南,了解如何从 v15 迁移到 v16+。

安装

需要 Swift 4/5 和 Xcode 10.x

Swift 包管理器

将此项目作为依赖项添加到您的 Package.swift

// swift-tools-version:4.2

import PackageDescription

let package = Package(
    name: "socket.io-test",
    products: [
        .executable(name: "socket.io-test", targets: ["YourTargetName"])
    ],
    dependencies: [
        .package(url: "https://github.com/socketio/socket.io-client-swift", .upToNextMinor(from: "16.1.1"))
    ],
    targets: [
        .target(name: "YourTargetName", dependencies: ["SocketIO"], path: "./Path/To/Your/Sources")
    ]
)

然后导入 import SocketIO

Carthage

将此行添加到您的 Cartfile

github "socketio/socket.io-client-swift" ~> 16.1.1

运行 carthage update --platform ios,macosx

StarscreamSocketIO 框架添加到您的项目,并遵循通常的 Carthage 流程。

CocoaPods 1.0.0 或更高版本

创建 Podfile 并添加 pod 'Socket.IO-Client-Swift'

use_frameworks!

target 'YourApp' do
    pod 'Socket.IO-Client-Swift', '~> 16.1.1'
end

安装 pods

$ pod install

导入模块

Swift

import SocketIO

Objective-C

@import SocketIO;

文档

详细示例

更详细的示例可以在 这里 找到

使用 Swift 包管理器的示例可以在 这里 找到

许可证

MIT