通知
本站点除 Legacy 产品与方案外,已迁移至 声网新文档中心 ,当前页面不再维护
文档中心
全部产品
Console 官网 社区 技术支持

SDK 是否支持断线重连机制?

分类: 集成类    平台: Android / iOS / macOS / Windows / Unity / Cocos Creator / Cocos2d-x / Electron / React Native / Flutter / Flutter2   最后更新时间: 2023/01/12 00:41:13

在 app 断网或进程被杀时,SDK 会自动启用断线重连机制。本文展示声网 SDK 在这两个情况下连接状态的处理逻辑。

本文不适用于声网 RTC Web SDK。

断网

声网 SDK 在 v2.3.2 新增了 onConnectionStateChangedconnectionStateChangedToState 回调,用以报告当前的网络连接状态,及引起连接状态改变的原因。因此本文内容会分 v2.3.2 之前及 v2.3.3 之后两个版本来介绍。

v2.3.2 之前

下图展示从用户 UID 1 加入频道,到连接中断,再到重新加入频道过程中,本地及远端用户 UID 2 的应用层会收到的回调:

其中:

  • T0 = 0 s:SDK 接收到应用层发起的 joinChanneljoinChannelByToken 请求
  • T1 ≈ T0 + 200 ms:通常在调用 joinChanneljoinChannelByToken 200 毫秒后,应用层可以加入频道。加入频道后 UID 1 的应用层收到 onJoinChannelSuccessdidJoinChannel 回调
  • T2 ≈ T1 + 100 ms:因网间传输延迟,UID 2 感知 UID 1 加入频道约有 100 毫秒的延迟,此时 UID 2 的应用层收到 onUserJoineddidJoinedOfUid 回调
  • T3:某个时间点 UID 1 客户端因断网等原因导致上行网络变差。SDK 会尝试重新加入频道
  • T4 = T3 + 4 s:如果 UID 1 连续 4 秒没有收到服务器发送的任何数据,应用层会收到 onConnectionInterruptedrtcEngineConnectionDidInterrupted 回调;同时 SDK 继续尝试重新加入频道
  • T5 = T3 + 10 s:如果 UID 1 连续 10 秒没有收到服务器发送的任何数据,应用层会收到 onConnectionLostrtcEngineConnectionDidLost 回调;同时 SDK 继续尝试重新加入频道
  • T6 = T3 + 20 s:如果 UID 2 连续 20 秒没有收到 UID 1 的任何数据,SDK 判断远端用户掉线,UID 2 的应用层会收到 onUserOfflinedidOfflineOfUid 回调
  • T7:如果 UID 1 重新加入频道成功,UID 1 的应用层会收到 onRejoinChannelSuccessdidRejoinChannel 回调
  • T8 ≈ T7 + 100 ms:大约 100 毫秒的延迟后,UID 2 的应用层再次收到 onUserJoineddidJoinOfUid 回调,表示远端用户重新上线

v2.3.2 及之后

下图展示从用户 UID 1 加入频道,到连接中断,再到连接完全失败过程中,本地及远端用户 UID 2 的应用层会收到的回调:

其中:

  • T0 = 0 s:SDK 接收到应用层发起的 joinChanneljoinChannelByToken 请求
  • T1 ≈ T0 + 200 ms:通常在调用 joinChanneljoinChannelByToken 200 毫秒后,应用层可以加入频道。加入频道过程中,UID 1 的应用层会收到 onConnectionStateChanged(CONNECTION_STATE_CONNECTING, CONNECTION_CHANGED_CONNECTING)connectionChangedToState(AgoraConnectionStateConnecting, AgoraConnectionChangedConnecting);加入后收到 onConnectionStateChanged(CONNECTION_STATE_CONNECTED, CONNECTION_CHANGED_JOIN_SUCCESS)connectionChangedToState(AgoraConnectionStateConnected, AgoraConnectionChangedJoinSuccess)onJoinChannelSuccessdidJoinChannel 回调
  • T2 ≈ T1 + 100 ms:因网间传输延迟,UID 2 感知 UID 1 加入频道约有 100 毫秒的延迟,此时 UID 2 的应用层收到 onUserJoineddidJoinedOfUid 回调,
  • T3:某个时间点 UID 1 客户端因断网等原因导致上行网络变差。SDK 会尝试重新加入频道
  • T4 = T3 + 4 s:如果 UID 1 连续 4 秒没有收到服务器发送的任何数据,应用层会收到 onConnectionStateChanged(CONNECTION_STATE_RECONNECTING, CONNECTION_CHANGED_INTERRUPTED)connectionChangedToState(AgoraConnectionStateReconnecting, AgoraConnectionChangedInterrupted) 回调;同时 SDK 继续尝试重新加入频道
  • T5 = T4 + 10 s:如果 UID 1 收到 onConnectionStateChanged(CONNECTION_STATE_RECONNECTING, CONNECTION_CHANGED_INTERRUPTED)connectionChangedToState(AgoraConnectionStateReconnecting, AgoraConnectionChangedInterrupted) 后连续 10 秒没有收到服务器发送的任何数据,应用层会收到 onConnectionLostrtcEngineConnectionDidLost 回调;同时 SDK 继续尝试重新加入频道
  • T6 = T3 + 20 s:如果 UID 2 连续 20 秒没有收到 UID 1 的任何数据,SDK 判断远端用户掉线,UID 2 的应用层会收到 onUserOfflinedidOfflineOfUid 回调
  • T7 = T4 + 20 min:如果 UID 1 收到 onConnectionStateChanged(CONNECTION_STATE_RECONNECTING, CONNECTION_CHANGED_INTERRUPTED)connectionChangedToState(AgoraConnectionStateReconnecting, AgoraConnectionChangedInterrupted) 后连续 20 分钟无法重新加入频道,SDK 不再继续尝试。UID 1 的应用层收到 onConnectionStateChanged(CONNECTION_STATE_FAILED, CONNECTION_CHANGED_JOIN_FAILED)connectionChangedToState(AgoraConnectionStateFailed, AgoraConnectionChangedJoinFailed) 回调;用户需要退出当前频道,然后重新加入频道

如果 UID 2 是 Web 客户端,则 Web 端在 UID 1 加入和重新接入频道时,会收到 client.on("stream-added") 回调;如果 UID 2 在 10 秒内未收到 UID 1 的任何数据,会收到 client.on("stream-removed") 回调;如果服务器在 3 分钟内未收到 UID 1 的任何数据,会收到 client.on("peer-leave") 回调。

进程被杀

进程被杀包括以下各种情况:

  • 打开或关闭 voip 模式
  • 前台或后台运行时进程被杀
  • 网页关闭(Web 端)

假设有 UID 1, UID 2 两个用户处于同一个频道内进行音视频直播或通话。
当 UID 1 的进程被杀:

  • 如果 UID 1 是 iOS 或 macOS 平台:UID 1 自动触发 leaveChannel,UID 2 有回调:

    • 如果 UID 2 是 Android 或 Windows 平台:onUserOffline
    • 如果 UID 2 是 iOS 或 macOS 平台: didOfflineOfUid
    • 如果 UID 2 是 Web 平台: client.on("peer-leave")
  • 如果 UID 1 是 Android, Windows,或 Linux 平台,且 UID 2 使用的是 Native SDK:

    • 如果 20 秒内, UID 1 没有重启 app 并加入原频道,UID 2 有回调:
      • 如果 UID 2 是 Android 或 Windows 平台: onUserOffline
      • 如果 UID 2 是 iOS 或 macOS 平台:didOfflineOfUid
    • 如果 20 秒内, UID 1 重启 app 并加入原频道,UID 2 不会收到回调。
  • 如果 UID 1 是 Android 或 Windows 台,且 UID 2 使用的是 Web SDK:

    • 如果 10 秒内, UID 1 没有重启 app 并加入原频道,UID 2 有回调:client.on("stream-removed")
    • 如果 10 秒内, UID 1 重启 app 并加入原频道,UID 2 不会收到回调。
  • 如果 UID 1 使用的是 Web SDK,进程被杀与掉线的行为是一样的。

  • 如果 UID 1 是频道内最后一个用户,服务端会在 10s 后销毁频道。