SocketKit 0.2

SocketKit 0.2

测试已测试
Lang语言 SwiftSwift
许可协议 MIT
发布最后发布Sep 2016
SPM支持 SPM

Yaxin Cheng 维护。



  • Yaxin Cheng

SocketKit

socket 连接的 Swift 工具包封装

要求

  • Xcode 8.0+
  • iOS 10.0+
  • Swift 3.0+

安装

SocketKit 可以通过 Cocoapods 或手动导入安装。

用户手册

套件导入

import SocketKit

Socket.swift

套件中唯一会被使用的类。所有请求都从这个套件发起。

构造函数

public init(address: String, port: Int) throws { ... }

当连接失败时,构造函数可能会抛出 SocketError.connectionFailed 错误。

从 socket 读取

public func read(complete: @escaping (String?) -> Void) throws { ... }

此函数接受一个回调闭包,当从 socket 服务器读取值时会调用该闭包
闭包接受一个可选字符串,如果 socket 丢失连接则可能抛出 SocketError.notConnected 错误

向 socket 写入

public func write(value: String) throws { ... }

此函数接受一个 UTF-8 字符串值,然后将字符串编码为二进制数据,然后写入 socket 服务器。
如果 socket 连接丢失,可能会抛出 SocketError.notConnected 错误
如果 socket 不允许写入值,可能会抛出 SocketError.notWritable 错误
如果字符串值无法编码,可能会抛出 SocketError.dataEncodingFailed 错误

连接状态

public var isConnected: Bool

此属性返回 socket 是否已连接,否则为 false

许可协议

SocketKit 在 MIT 许可协议下发布。有关详细信息,请参阅 LICENSE。