Gerenciar uma sessão de sincronização - SDK Flutter

Pré-requisitos

Antes de managed o estado da sessão de sincronização, você deve fazer o seguinte:

1. Configurar o Flexible Sync no backend do Atlas App Services

2. Adicionar Device Sync ao seu aplicativo

Aguarde as alterações para fazer upload e download

Para esperar de forma assíncrona que todas as alterações sejam carregadas no Atlas a partir do seu domínio sincronizado, chame Session.waitForUpload(). Para esperar de forma assíncrona que todas as alterações no Atlas sejam baixadas para seu domínio sincronizado, chame Session.waitForDownload().

// Wait to download all pending changes from Atlas
await realm.syncSession.waitForDownload();
// Add data locally
realm.write(() {
  realm.addAll<Car>([
    Car(ObjectId(), "Hyundai"),
    Car(ObjectId(), "Kia"),
    Car(ObjectId(), "Lincoln")
  ]);
});
// Wait for changes to upload to Atlas before continuing execution.
await realm.syncSession.waitForUpload();

Você pode adicionar um CancellationToken opcional para waitForUpload() e waitForDownload().

final cancellationToken = CancellationToken();
final waitForDownloadFuture =
    realm.syncSession.waitForDownload(cancellationToken);
cancellationToken.cancel();
final waitForUploadFuture =
    realm.syncSession.waitForUpload(cancellationToken);
cancellationToken.cancel();

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

Para pausar a sincronização para uma sessão, chame Session.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 alterações, chame Session.resume().

Você deve chamar manualmente Session.pause() e Session.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
realm.syncSession.pause();
// Data that you add while the sync session is paused does not sync to Atlas.
// However, the data is still added to the realm locally.
realm.write(() {
  realm.addAll<Car>([
    Car(ObjectId(), "Volvo"),
    Car(ObjectId(), "Genesis"),
    Car(ObjectId(), "VW")
  ]);
});
// Resume sync session. Now, the data you wrote to the realm
// syncs to Atlas.
realm.syncSession.resume();

Monitore o progresso do upload e download da sincronização

Para monitorar o progresso da sincronização, chame SyncSession.getProgressStream(). Este método retorna um fluxo de SyncProgress objetos que fornecem um progressEstimate para o upload ou download atual.

O progressEstimate fornecido é um duplo cujo valor varia de 0.0 a 1.0. Em 1.0, o fluxo de progresso está completo.

SyncSession.getProgressStream() recebe dois argumentos:

• Uma direção de progresso enum que pode ser definido upload como ou download. Especifica se o fluxo de progresso monitora o progresso do upload ou download.

• Um ProgressMode enum que pode ser definido como um dos seguintes:

  • reportIndefinitely: define as notificações para continuar até que a chamada de resposta seja cancelada.

  • forCurrentlyOutstandingWork: define as notificações para continuar até que o progressEstimate atinja 1.0.

final stream = realm.syncSession.getProgressStream(
    ProgressDirection.upload, ProgressMode.forCurrentlyOutstandingWork);
double progressEstimate = -1;
late StreamSubscription streamListener;
streamListener = stream.listen((syncProgressEvent) {
  progressEstimate = syncProgressEvent.progressEstimate;
  if (progressEstimate < 1.0) {
    print('Upload progress: ${progressEstimate * 100}%');
  }
}, onDone: () {
  print('Upload progress: ${progressEstimate * 100}%');
  print("Upload complete");
}, onError: (error) {
  print("An error occurred: $error");
  streamListener.cancel();
});

Monitorar conexão de rede

Você pode obter o estado da conexão de rede atual com Session.connectionState. Isso retorna um ConnectionState enum que contém o estado da conexão de rede: connected, disconnected ou connecting.

if (realm.syncSession.connectionState == ConnectionState.connected) {
  // ... do stuff
}

Monitore o estado da conexão de rede com Session.connectionStateChanges. Esta propriedade retorna um fluxo de ConnectionStateChange objetos que são atualizados quando a conexão de rede é alterada. Você pode acessar o ConnectionState atual e anterior de ConnectionStateChange.

final connectionStream = realm.syncSession.connectionStateChanges;
late StreamSubscription streamListener;
streamListener = connectionStream.listen((connectionStateChange) {
  if (connectionStateChange.current == ConnectionState.connected) {
    print("Connected to Atlas Device Sync server");
    streamListener.cancel();
  }
});

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

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

Você pode optar por manualmente trigger uma tentativa de reconexão com o App.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 e não quiser confiar na detecção automática de reconexão.

app.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.