托管同步会话 — C++ SDK

先决条件

在托管同步会话状态之前，您必须：

1. 在 Atlas App Services 后端配置 Flexible Sync

2. 打开同步 Realm

获取同步会话

您可以使用成员函数get_sync_session()来获取任何同步域的sync_session对象。 SDK 将此对象作为可选项返回。 它是一个轻量级处理，可以按值传递。

auto syncSession = realm.get_sync_session();

检查网络连接

要检查连接状态，可以直接读取同步会话实例的connection_state()属性。

syncSession->connection_state();

您还可以使用watch_connection_change()函数观察连接状态。 此函数注册一个回调，当底层同步会话更改其连接状态时，SDK 会调用该回调。

auto connectionToken = syncSession->observe_connection_change(
    [&](enum realm::sync_session::connection_state,
        enum realm::sync_session::connection_state new_state) {
      // Register a block to execute when connection state changes.
    });

如果您注册了连接更改侦听器，则可以在侦听完更改后取消注册。 调用同步会话实例的unregister_connection_change_observer()方法取消注册观察令牌。

syncSession->unregister_connection_change_observer(connectionToken);

网络连接状态与 Device Sync 连接状态不同，您可以使用state()方法检查后者。 有关同步连接状态的更多信息，请参阅本页上的“检查同步状态”文档。

暂停或恢复同步会话

您可以暂停和恢复 Realm 上的同步会话。 暂停同步会话只会暂停该 Realm 的同步会话。 如果您有多个打开 Realm，则暂停不会影响其他 Realm 的同步会话。

要暂停同步会话，请调用同步会话的Pause()方法。

syncSession->pause();

要恢复同步会话，请调用同步会话的resume()方法。

syncSession->resume();

等待更改上传和下载

您可以使用sync_session的wait_for_upload_completion()和wait_for_download_completion()方法等待更改上传到 Atlas 或从Atlas下载。 这两个方法都可以选择在上传或下载完成时执行回调。

要等待所有更改从同步域上传到Atlas，请使用成员函数wait_for_upload_completion() 。

syncSession->wait_for_upload_completion().get();

要等待所有更改从 Atlas 下载到同步 Realm，请使用成员函数wait_for_download_completion() 。 下载任何更改后刷新域，确保其反映最新数据。

syncSession->wait_for_download_completion().get();
realm.refresh();

检查同步状态

您可以使用sync_session的公共成员函数state()来检查同步会话是否处于活动状态。 这会返回一个枚举，其值反映可能的 Device Sync 状态。

syncSession->state();

同步连接状态不同于网络连接状态，您可以使用connection_state()方法检查网络连接状态。 有关网络连接状态的更多信息，请参阅本页上的“检查网络连接”文档。

手动重新连接所有同步会话

Realm 会自动检测设备何时在离线后重新获得连接，并尝试使用增量退避策略重新连接。

您可以选择使用同步会话的trigger reconnect() 方法手动 重新连接尝试，而不是等待增量回退的持续时间。如果您对网络状况有更准确的了解并且不想依赖 Realm 的自动重新连接检测，这非常有用。

syncSession->reconnect();

调用此方法时，SDK 会强制所有同步会话立即尝试重新连接。 这会重置用于增量退避的所有计时器。

调用此方法并不能保证设备可以重新连接。 如果 SDK 出现致命错误，或者设备已连接或正在尝试连接，则调用此方法无效。