shared_map 1.0.1

Offers a versatile, synchronized Map for efficient sharing between Dart application parts, including Isolates or external apps.

shared_map

The package shared_map provides a versatile and synchronized Map data structure for Dart applications. This package is designed to facilitate efficient sharing and communication of synchronized key-value pairs between different parts of your Dart application, including Isolates or external applications.

Motivation

Modern Dart applications often involve complex architectures with multiple Isolates or concurrent execution environments. In such scenarios, efficient communication and synchronization of shared data become fundamental. The shared_map package was created with the following motivations:

1. Simplified Sharing: Sharing data across different parts of an application, especially Isolates, is often complex. The shared_map package simplifies this process by offering a shared and synchronized map structure.

2. Concurrency-Friendly: Managing concurrent execution requires careful consideration of data access and modification. The shared_map package is crafted to be concurrency-friendly, ensuring safe access and updates to shared data across multiple execution contexts.

3. Scalability: As applications grow and incorporate more concurrent patterns, having a dependable and scalable mechanism for sharing state becomes essential, especially across Isolates. The shared_map package plays a role in enhancing the scalability of Dart applications by providing an efficient tool for data sharing.

Usage

To use a SharedMap, first, create a SharedStore, then call getSharedMap. To pass it to another Isolate, use its SharedReference returned by SharedMap.shareReference(), then instantiate it with SharedMap.fromSharedReference(sharedMapReference).

Example:

import 'dart:io';
import 'dart:isolate';

import 'package:shared_map/shared_map.dart';

void main() async {
  var store1 = SharedStore('t1');

  var m1 = await store1.getSharedMap<String, int>('m1');

  var va1 = await m1!.get('a'); // return `null`
  print('va1: $va1');

  var va2 = m1.put('a', 11); // put and return `11`
  print('va2: $va2');

  final sharedMapReference = m1.shareReference();
  print('sharedMapReference: $sharedMapReference');

  // Use the `SharedMap` inside an `Isolate`:
  var va3 = await Isolate.run<int?>(() async {
    // Instantiate from `sharedMapReference`:
    var m2 = SharedMap<String, int>.fromSharedReference(sharedMapReference);
    var va3 = await m2.get('a'); // return `11`
    return va3;
  }); // Isolate returns 11

  print('va3: $va3');

  // Use the `SharedMap` inside another `Isolate`:
  var va4 = await Isolate.run<int?>(() async {
    // Instantiate from `sharedMapReference`:
    var m3 = SharedMap<String, int>.fromSharedReference(sharedMapReference);
    var va4 = await m3.put('a', 111); // put and return 111
    return va4;
  }); // Isolate returns 111

  print('va4: $va4');

  final sharedMapID = sharedMapReference.id;
  print('sharedMapID: $sharedMapID');

  final shareStoreReference = store1.shareReference();
  print('shareStoreReference: $shareStoreReference');

  // Use the `SharedStore` inside an `Isolate`:
  var va5 = await Isolate.run<int?>(() async {
    // Instantiate from `shareStoreReference`:
    var store2 = SharedStore.fromSharedReference(shareStoreReference);
    // Get the `SharedMap` through the `SharedStore`:
    var m4 = await store2.getSharedMap(sharedMapID);
    var va5 = await m4?.put('a', 222); // put and return `222`
    return va5;
  });

  print('va5: $va5'); // print `222`

  var va6 = await m1.get('a');
  print('va6: $va6'); // print `222`

  exit(0);
}

Output:

va1: null
va2: 11
sharedMapReference: SharedMapReference{id: m1, sharedStore: {id: t1}}
va3: 11
va4: 111
sharedMapID: m1
shareStoreReference: SharedStoreReference{id: t1}
va5: 222
va6: 222

Features and bugs

Please file feature requests and bugs at the issue tracker.

Author

Graciliano M. Passos: gmpassos@GitHub.

Sponsor

Don't be shy, show some love, and become our GitHub Sponsor. Your support means the world to us, and it keeps the code caffeinated! ☕✨

Thanks a million! 🚀😄

License

Apache License - Version 2.0