频道连接状态管理
在实时音视频场景下,App 端与声网 SD-RTN™ 之间的连接状态会随着客户端加入或离开频道而发生变化,也可能由于网络或鉴权问题而导致连接中断。
本文介绍各种频道连接状态,状态改变原因和处理方式,帮助你更好地管理用户和排除网络故障。
技术原理
连接状态
当连接状态发生变化时,声网会发送 onConnectionStateChanged
回调。下图展示各种连接状态,以及用户从加入到离开频道的过程中连接状态如何改变:
断线重连
通信过程中,如果因网络问题导致连接断开,SDK 会自动开启断线重连机制。下图展示本地用户 (UID1) 和远程用户 (UID2) 在以下过程中收到的回调:本地用户加入频道、发生网络异常、连接中断、重新加入频道。
图解如下:
- T0:SDK 接收到 UID1 的
joinChannel
请求。 - T1:调用
joinChannel
200 ms 后,UID1 加入频道。同时,UID1 收到onConnectionStateChanged(CONNECTING, CONNECTING)
回调。 成功加入频道后,UID1 收到onConnectionStateChanged(CONNECTED, JOIN_SUCCESS)
和onJoinChannelSuccess
回调。 - T2:因网间传输延迟,UID 2 感知 UID 1 加入频道约有 100 毫秒的延迟,此时 UID 2 收到
onUserJoined
回调。 - T3:某个时间点 UID 1 客户端因断网等原因导致上行网络变差。SDK 自动尝试重新加入频道。
- T4:如果 UID1 连续 4 秒没有收到服务器发送的任何数据,UID1 收到
onConnectionStateChanged(RECONNCTING, INTERRUPTED)
回调;同时 SDK 继续尝试重新加入频道。 - T5:如果 UID 1 收到
onConnectionStateChanged(RECONNCTING, INTERRUPTED)
后连续 10 秒没有收到服务器发送的任何数据,UID 1 会收到onConnectionLost
回调;同时 SDK 继续尝试重新加入频道。 - T6:如果 UID2 连续 20 秒没有收到来自 UID1 的任何数据,则 SDK 判断 UID1 离线。UID2 收到
onUserOffline
回调。 - T7:如果 UID 1 收到
onConnectionStateChanged(RECONNCTING, INTERRUPTED)
后连续 20 分钟无法重新加入频道,SDK 不再继续尝试。UID 1 收到onConnectionStateChanged(FAILED, JOIN_FAILED)
回调;用户需要退出当前频道,然后重新加入频道。
前提条件
在进行操作之前,请确保你已经在项目中实现了基本的实时音视频功能。详见实现音视频互动。
操作步骤
本节介绍如何使用 onConnectionStateChanged
回调来监控频道连接状态的变化。
在你的项目中,打开管理 IRtcEngineEventHandler
的文件,将以下代码复制到 IRtcEngineEventHandler
初始化进程中。
config.mEventHandler.onConnectionStateChanged = (
state: Constants.ConnectionState,
reason: Constants.ConnectionChangedReason
) => {
Logger.info(TAG, `onConnectionStateChanged state=${state} reason=${reason}`);
};
你可以从日志中读取当前连接状态,以及状态更改的触发原因。
另外,onConnectionStateChanged
中的 reason
参数也解释了连接状态改变的原因,可帮助你进行网络故障排除。 有关频道连接状态变化的原因以及排障方式,详见状态说明及排障指导。
参考信息
介绍更多相关信息和参考页面的链接。
连接状态
如前文图中所示,App 在加入和离开频道前后可能出现以下 5 种连接状态:
连接状态 | 描述 |
---|---|
DISCONNECTED | 初始连接状态。它通常发生在:
|
CONNECTING | 调用 joinChannel 方法后的瞬时状态。 |
CONNECTED | 发生在 App 成功加入频道后。SDK 还会触发 onJoinChannelSuccess 回调,上报本地客户端已经加入频道。 此时用户可以发布或订阅频道中的音频和视频。 |
RECONNECTING | 发生在连接中断时。SDK 会在中断后自动尝试重新连接。
|
FAILED | 连接失败。发生在 SDK 在 20 分钟内无法加入频道、并且 SDK 停止重新连接频道时。 此时需调用 leaveChannel 离开当前频道,再调用 joinChannel 再次加入频道。 |
状态说明及排障指导
onConnectionStateChanged
中的 reason
参数描述了连接状态更改原因。
下表列出了不同连接状态和状态变化原因之间的映射关系,以及发生网络中断时故障时的处理方法。
连接状态 | 状态说明和排障指导 |
---|---|
DISCONNECTED |
|
CONNECTING |
|
CONNECTED |
|
RECONNECTING |
|
FAILED |
|