managed uma sessão de sincronização - Kotlin SDK

Sessões de sincronização

Quando você usa o Flexible Sync, o Realm Kotlin SDK sincroniza os dados com o Atlas em segundo plano usando uma sessão de sincronização. A sessão de sincronização começa sempre que você abre um Realm sincronizado.

val app = App.create(YOUR_APP_ID)
val user = app.login(credentials)
val config = SyncConfiguration.Builder(user, setOf(Task::class))
    .build()
// Open the synced realm
val realm = Realm.open(config)
// Sync session is now active
// ... do something with the synced realm

A sessão de sincronização managed o seguinte:

• Carregar e baixar alterações no Realm

• Pausando e retomando a sincronização

• Monitoramento da conectividade de rede

Você pode acessar a SyncSession de um único domínio sincronizado por meio da propriedade realm.syncSession .

Aguarde as alterações para fazer upload e download

Para aguardar de forma assíncrona que todas as alterações sejam carregadas no Atlas a partir do seu domínio sincronizado, chame uploadAllLocalChanges. Este método retorna true quando todas as alterações tiverem sido carregadas.

Para aguardar de forma assíncrona que todas as alterações no Atlas sejam baixadas do servidor do Device Sync para o domínio sincronizado, chame downloadAllServerChanges. Este método retorna true quando todas as alterações tiverem sido baixadas.

Você também pode incluir um parâmetro timeout opcional em qualquer um dos métodos para determinar a quantidade máxima de tempo antes de retornar false. Observe que o upload ou download continua em segundo plano mesmo depois de retornar false.

O exemplo a seguir demonstra chamar ambos os métodos com um tempo limite definido:

// Wait to download all pending changes from Atlas
realm.syncSession.downloadAllServerChanges(1.minutes)
// Add data locally
realm.write {
    this.copyToRealm(Task().apply {
        taskName = "Review proposal"
        assignee = "Emma"
        progressMinutes = 0
    })
}
// Wait for local changes to be uploaded to Atlas
realm.syncSession.uploadAllLocalChanges(1.minutes)

Pausar e retomar uma sessão de sincronização

Para pausar a sincronização de uma sessão, ligue para syncSession.pause(). O domínio não sincronizará as alterações com o Atlas enquanto a sessão estiver pausada.

Para retomar a sincronização de uma alteração, ligue para syncSession.resume().

Você deve chamar manualmente syncSession.pause() e syncSession.resume() para cada realm cuja sessão de sincronização você deseja pausar e reiniciar. O estado de sincronização de uma sessão não tem impacto em outras sessões abertas.

O seguinte bloco de código demonstra a chamada destes métodos:

// Pause the sync session
// Data that you write while session is paused does not sync to Atlas
realm.syncSession.pause()
// Add data locally
realm.write {
    this.copyToRealm(Task().apply {
        taskName = "Submit expense report"
        assignee = "Kevin"
        progressMinutes = 0
    })
}
// Resume sync session
// Local changes now sync to Atlas
realm.syncSession.resume()

Monitorar conexão de rede

Você pode obter o estado da conexão de rede atual verificando o SyncSession.connectionState propriedade. Isso retorna um valor de enum ConnectionState que indica o estado da conexão de rede. Os estados possíveis são: CONNECTED, DISCONNECTED ou CONNECTING.

if (realm.syncSession.connectionState == ConnectionState.CONNECTED) {
    Log.i("Connected to network")
    // ... do something
}

Monitore o estado da conexão de rede com connectionStateAsFlow. Esta propriedade retorna um fluxo de objetos ConnectionStateChange que é atualizado quando a conexão de rede é alterada. Você pode acessar o novo e o antigo ConnectionState em ConnectionStateChange.

val connectionFlow = realm.syncSession.connectionStateAsFlow()
connectionFlow.collect { ConnectionStateChange ->
    if (ConnectionStateChange.newState == ConnectionState.CONNECTED) {
        Log.i("Connected to Atlas Device Sync server")
    }
}

Reconectar manualmente todas as sessões de sincronização

O Realm detecta automaticamente quando um dispositivo recupera a conectividade depois de estar offline e tenta se reconectar usando uma estratégia de backoff incremental.

No Kotlin SDK versão 1.11.0 e posterior, você pode optar por trigger manualmente uma tentativa de reconexão com o App.Sync.reconnect() em vez de esperar pela duração do backoff incremental. Isso é útil se você tiver uma compreensão mais precisa das condições da rede (por exemplo, ao monitorar alterações de rede com o ConnectivityManager no Android) e não quiser confiar na detecção automática de reconexão do Realm. O SDK também chama automaticamente esse método quando um dispositivo sai do modo avião.

Para trigger manualmente uma tentativa de reconexão, chame o método App.Sync.reconnect() método, que é acessado por meio da interface App.Sync . Ao contrário do SyncSession, que permite acessar uma única sessão de sincronização do domínio, a interface App.Sync controla todas as sessões de sincronização do seu aplicativo.

app.sync.reconnect()

Quando você chama esse método, o SDK força todas as sessões de sincronização a tentar se reconectar imediatamente e redefine todos os cronômetros usados para backoff incremental.