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

Requisitos previos

Antes de poder administrar el estado de su sesión de sincronización, debe realizar lo siguiente:

1. Configurar la sincronización flexible en el backend de Atlas App Services

2. Agrega Device Sync a tu aplicación

Espera a que los cambios se suban y se descarguen

Para esperar asincrónicamente a que todos los cambios se carguen a Atlas desde el dominio sincronizado, llama a Session.waitForUpload(). Para esperar asincrónicamente a que todos los cambios en Atlas se descarguen a tu dominio 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();

Pausar y reanudar una sesión de sincronización

Para pausar la sincronización de una sesión, llame a Session.pause(). El dominio no sincronizará los cambios con Atlas mientras la sesión esté pausada.

Para reanudar la sincronización de cambios, llame a Session.resume().

Debes llamar manualmente a Session.pause() y Session.resume() para cada reino cuya sesión de sincronización quieras pausar y reiniciar. El estado de sincronización de una sesión no afecta a las demás 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

Para supervisar el progreso de la sincronización, llame a SyncSession.getProgressStream(). Este método devuelve un flujo de objetos SyncProgress que proporcionan un progressEstimate para la carga o descarga actual.

El progressEstimate proporcionado es un valor doble cuyo valor oscila entre 0.0 y 1.0. En 1.0, el flujo de progreso se completa.

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:Establece que las notificaciones continúen hasta que se cancele el registro de la devolución de llamada.

  • 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();
});

Monitorear la conexión de red

Puede obtener el estado de la conexión de red actual con Session.connectionState. Esto devuelve una enumeración ConnectionState que contiene el estado de la conexión deconnected red:, disconnected connectingo.

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

Supervise el estado de la conexión de red con Session.connectionStateChanges. Esta propiedad devuelve un flujo de objetos ConnectionStateChange que se actualiza cuando cambia la conexión de red. Puede acceder al actual y al anterior ConnectionState ConnectionStateChangedesde.

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.

Puede optar por activar manualmente un intento de reconexión con App.reconnect() en lugar de esperar a que finalice el retroceso incremental. Esto es útil si comprende mejor las condiciones de la red y no desea depender de la detección automática de reconexión.

app.reconnect();

Cuando se llama a este método, el SDK fuerza a todas las sesiones de sincronización a intentar reconectarse inmediatamente y restablece todos los temporizadores utilizados para el retroceso incremental.