Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raj457036/simple_worker
A package to make isolate usage as easy as possible.
https://github.com/raj457036/simple_worker
easiest-solution flutter isolate simple
Last synced: 2 months ago
JSON representation
A package to make isolate usage as easy as possible.
- Host: GitHub
- URL: https://github.com/raj457036/simple_worker
- Owner: raj457036
- License: mit
- Created: 2022-08-25T09:17:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-18T08:40:49.000Z (5 months ago)
- Last Synced: 2024-08-19T08:32:39.226Z (5 months ago)
- Topics: easiest-solution, flutter, isolate, simple
- Language: C++
- Homepage: https://pub.dev/packages/easy_worker
- Size: 240 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Easy Worker
Working with Dart Isolate is not very easy for beginners and tedious to write
big boilerplate code for veteran and even though there are lot of packages to
solve this issue none were exactly as straight forward as they try to be.
Well then **EasyWorker** might be the simplest way to work with dart isolate so far.
## Features
1. Easy to learn and use
2. Simple to start a long running process or a short computation.
3. easiest bidirectional communication
## Getting started
### Add `easy_worker` to `pubspec.yaml`
```yaml
dependencies:
flutter:
sdk: flutter
easy_worker:
...
```
## Usage
### For long running task and bidirectional communication between your main isolate and the worker isolate, You will need two things:
- **A static or top level function for example this factorial calculator**
```dart
/// This takes number (message/payload or whatever you wanna say) and a sender
void calculateFactorial(int number, Sender send) {
int temp = number;
number--;
while (number > 0) {
temp *= number;
number--;
// just to simulate long running task with blocking operation
// (operation that can freeze the ui thread)
sleep(const Duration(seconds: 1));
}
/// once done send the calculated result to the parent process
send(temp);
}
```
- **A EasyWorker or EasyCompute instance**
## A. With EasyWorker
1. Create an instance of EasyWorker
```dart
// EasyWorker
final worker = EasyWorker(
Entrypoint(calculateFactorial),
workerName: "Factorial Calculator",
initialMessage: 0, // Optional: Initial payload for this worker will be 0
);
await worker.waitUntilReady();
```
2. Now how to send and receive to and from this worker?
- get the first result only
```dart
final result = await worker.stream.first;
```
- Listen to all the results coming from isolate
```dart
worker.onMessage((message) {
print("Message From Worker: $message");
});
```
- Send Message to the worker
```dart
/// send 6 as payload to the worker to get the factorial of
/// 6.
worker.send(6);
```
## B. **(NEW)** With EasyCompute : Resuable isolates for high performance apps.
1. Create an instance of EasyCompute
```dart
// EasyCompute
final worker = EasyCompute(
ComputeEntrypoint(calculateFactorial),
workerName: "Factorial Calculator",
);
await worker.waitUntilReady();
```
2. Get results
```dart
final result = await worker.compute(6);
print(result); //
```
### Dispose when not needed anymore
```dart
worker.dispose()
```
## FAQs
1. What about simple one time tasks?
```dart
/// just call compute and pass your entrypoint and payload
final result = await EasyWorker.compute(calculateFactorial, 5);
print(result); // 120
```
## Additional information
FAQ:
1. Why this package if there are already other who are doing the same?
- Basically all of them just have a learning curve and there technicalities, this package doesn't.
2. I want to implement something. how to do it?
- You can create a feature request on github.
## License
- MIT