queuekit 1.2.0
queuekit: ^1.2.0 copied to clipboard
A persistent task queue for Dart and Flutter. Runs events in order, retries failures, keeps dependent events in order and restores the queue across app restarts.
import 'dart:async';
import 'package:flutter/material.dart';
import 'package:queuekit/queuekit.dart';
import 'package:shared_preferences/shared_preferences.dart';
final startListenable = QueueStartListenable();
late final HydratedQueue queue;
class ExampleEvent extends Event<String> {
ExampleEvent({String? id}) : id = id ?? '${DateTime.now().microsecondsSinceEpoch}-${_created++}';
static int _created = 0;
static const typeName = 'ExampleEvent';
static final serializer = EventSerializer<ExampleEvent>(
type: typeName,
fromJson: (json) {
return ExampleEvent(id: json['id'] as String)
..retryConfig = linearRetryConfigSerializer.fromJson(
json['retryConfig'] as Map<String, dynamic>,
);
},
toJson: (event) {
return {
'id': event.id,
'retryConfig': linearRetryConfigSerializer.toJson(event.retryConfig!),
};
},
);
// Ids must be unique among pending events, including the ones restored from storage.
@override
final String id;
@override
String get type => typeName;
@override
LinearRetryConfig? retryConfig = LinearRetryConfig(
maxRetries: 10,
delay: const Duration(seconds: 1),
);
@override
Future<String> run() {
return Future.delayed(const Duration(seconds: 1), () => 'Hello World!');
}
}
Future<void> main() async {
WidgetsFlutterBinding.ensureInitialized();
final prefs = await SharedPreferences.getInstance();
queue = HydratedQueue(
startListenable,
eventSerializers: [ExampleEvent.serializer],
saveCurrentQueue: (data) async {
await prefs.setString('currentQueue', data);
},
hydrateCurrentQueue: () {
return prefs.getString('currentQueue');
},
saveRetryQueue: (data) async {
await prefs.setString('retryQueue', data);
},
hydrateRetryQueue: () {
return prefs.getString('retryQueue');
},
);
await queue.hydrate();
startListenable.start();
runApp(const MainApp());
}
class MainApp extends StatefulWidget {
const MainApp({super.key});
@override
State<MainApp> createState() => _MainAppState();
}
class _MainAppState extends State<MainApp> {
late final StreamSubscription subscription;
final data = <String>[];
@override
void initState() {
super.initState();
subscription = queue.listenWhere<ExampleEvent, String>((params) {
setState(() {
data.add(params.result);
});
});
}
@override
void dispose() {
subscription.cancel();
super.dispose();
}
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
if (data.isEmpty) const Text('Press the button to add an event'),
for (final item in data) Text(item),
],
),
),
floatingActionButton: FloatingActionButton(
onPressed: () {
queue.add(ExampleEvent());
},
child: const Icon(Icons.add),
),
),
);
}
}