Administrar una sesión de sincronización - SDK de Flutter

Requisitos previos

Before you can manage your sync session state, you must perform the following:

1. Configure Flexible Sync on the Atlas App Services backend

2. Agrega Device Sync a tu aplicación

Espera a que los cambios se suban y se descarguen

Para esperar de forma asíncrona que todos los cambios se suban a Atlas desde tu realm sincronizado, llama a Session.waitForUpload(). Para esperar de forma asincrónica a que todos los cambios en Atlas se descarguen a tu realm sincronizado, llama a 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();

Puede agregar un CancellationToken opcional a waitForUpload() y waitForDownload().

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

Pause and Resume a Sync Session

To pause syncing for a session, call Session.pause(). The realm will not sync changes with Atlas while the session is paused.

To resume syncing a changes, call Session.resume().

Debes llamar manualmente a Session.pause() y Session.resume() para cada realm cuya sesión de sincronización desees pausar y reiniciar. El estado de sincronización de una sesión no tiene impacto sobre otras sesiones abiertas.

El siguiente bloque de código demuestra cómo llamar a estos 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();

Supervisar el progreso de carga y descarga de sincronización

To monitor Sync progress, call SyncSession.getProgressStream(). This method returns a Stream of SyncProgress objects that provide a progressEstimate for the current upload or download.

The provided progressEstimate is a double whose value ranges from 0.0 to 1.0. At 1.0, the progress stream is complete.

SyncSession.getProgressStream() toma dos argumentos:

• Una enumeración ProgressDirection que puede establecerse upload en download o. Especifica si el flujo de progreso supervisa el progreso de carga o descarga.

• Una enumeración ProgressMode que se puede configurar en uno de los siguientes:

  • reportIndefinitely: Sets notifications to continue until the callback is unregistered.

  • forCurrentlyOutstandingWork:Establece que las notificaciones continúen hasta que progressEstimate llegue a 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();
});

Monitor Network Connection

You can get the state of the current network connection with Session.connectionState. This returns a ConnectionState enum that contains the network connection's state: connected, disconnected, or connecting.

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

Supervisa el estado de la conexión de red con Session.connectionStateChanges. Esta propiedad retorna un Stream de objetos ConnectionStateChange que se actualizan cuando la conexión de red cambia. Puedes acceder al ConnectionState actual y anterior desde 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 las sesiones de sincronización

El SDK de Flutter detecta automáticamente cuando un dispositivo recupera la conectividad después de estar sin conexión e intenta volver a conectarse utilizando una estrategia de backoff incremental.

You can choose to manually trigger a reconnect attempt with the App.reconnect() instead of waiting for the duration of the incremental backoff. This is useful if you have a more accurate understanding of the network conditions and don't want to rely on automatic reconnect detection.

app.reconnect();

Al llamar a este método, el SDK obliga a que todas las sesiones de sincronización intenten reconectarse inmediatamente y restablece cualquier temporizador utilizado para el retroceso incremental.