iOS/Swift：为Stream连接设置超时时间

问题背景 #

我正在开发一款基于Swift 4的iOS应用，通过Stream.getStreamsToHost(withName: self.host!, port: self.port!, inputStream: &self.inputStream, outputStream: &self.outputStream)方法连接服务器，当前的连接实现代码如下：

if let instream = self.inputStream, let outstream = self.outputStream {
    instream.delegate = self
    outstream.delegate = self
    instream.schedule(in: .current, forMode: .commonModes)
    outstream.schedule(in: .current, forMode: .commonModes)
    instream.open()
    outstream.open()
}

当网络状况不佳时，我需要为打开Stream的操作设置超时时间，请问该如何实现？

解决方案 #

Stream本身并没有内置的超时配置项，我们可以通过定时器+代理回调的组合来手动实现超时逻辑。核心思路是：在打开流的同时启动一个定时器，若定时器触发时流还未成功连接，则主动关闭流并触发超时处理；如果流提前成功连接或出现错误，则立即销毁定时器。

具体实现步骤

1. 先定义超时时间常量和定时器属性：

// 定义超时时间，比如10秒
private let streamTimeoutInterval: TimeInterval = 10
// 弱引用定时器，避免循环引用
private weak var streamTimeoutTimer: Timer?

2. 修改你的连接代码，在打开流的同时启动定时器：

if let instream = self.inputStream, let outstream = self.outputStream {
    instream.delegate = self
    outstream.delegate = self
    instream.schedule(in: .current, forMode: .commonModes)
    outstream.schedule(in: .current, forMode: .commonModes)
    
    // 启动超时定时器
    streamTimeoutTimer = Timer.scheduledTimer(withTimeInterval: streamTimeoutInterval, repeats: false) { [weak self] _ in
        self?.handleStreamTimeout()
    }
    
    instream.open()
    outstream.open()
}

3. 实现超时处理方法，负责关闭流、清理资源：

private func handleStreamTimeout() {
    // 关闭输入输出流
    inputStream?.close()
    outputStream?.close()
    
    // 移除调度并清空代理
    inputStream?.remove(from: .current, forMode: .commonModes)
    outputStream?.remove(from: .current, forMode: .commonModes)
    inputStream?.delegate = nil
    outputStream?.delegate = nil
    
    // 这里可以添加你自己的超时回调逻辑，比如通知用户连接超时
    print("Stream连接超时，请检查网络后重试")
}

4. 在StreamDelegate的回调方法中，及时销毁定时器（当流成功打开或出现错误时）：

func stream(_ aStream: Stream, handle eventCode: Stream.Event) {
    switch eventCode {
    case .openCompleted:
        // 流成功打开，销毁定时器
        streamTimeoutTimer?.invalidate()
        print("Stream连接成功")
        // 这里添加连接成功后的逻辑
    case .errorOccurred:
        // 流出现错误，销毁定时器并处理错误
        streamTimeoutTimer?.invalidate()
        if let error = aStream.streamError {
            print("Stream连接错误：\(error.localizedDescription)")
        }
        // 清理流资源
        cleanupStreams()
    case .endEncountered:
        // 流结束，清理资源
        streamTimeoutTimer?.invalidate()
        cleanupStreams()
    default:
        break
    }
}

// 封装流清理逻辑
private func cleanupStreams() {
    inputStream?.close()
    outputStream?.close()
    inputStream?.remove(from: .current, forMode: .commonModes)
    outputStream?.remove(from: .current, forMode: .commonModes)
    inputStream?.delegate = nil
    outputStream?.delegate = nil
}

注意事项

• 定时器使用weak引用，配合闭包中的[weak self]，避免出现循环引用导致内存泄漏。
• 无论流是成功打开、出现错误还是超时，都要确保流资源被正确清理，避免资源浪费。
• 可以根据实际需求调整超时时间，比如网络环境较差的场景可以适当延长超时时间。

内容的提问来源于stack exchange，提问作者Simon Hessner