Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gchauvet/vertx-async
:construction: Async helpers for Vert.x
https://github.com/gchauvet/vertx-async
async library vertx
Last synced: 3 months ago
JSON representation
:construction: Async helpers for Vert.x
- Host: GitHub
- URL: https://github.com/gchauvet/vertx-async
- Owner: gchauvet
- Created: 2016-06-03T12:53:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-12T07:34:27.000Z (almost 3 years ago)
- Last Synced: 2024-09-27T07:42:30.308Z (3 months ago)
- Topics: async, library, vertx
- Language: Java
- Homepage:
- Size: 382 KB
- Stars: 12
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- vertx-awesome - Vert.x Async - Portage of caolan/async nodejs module to Vert.x framework that provides helpers methods for common async patterns. (Utilities)
README
# vertx-async
[](https://travis-ci.org/gchauvet/vertx-async)
[](https://coveralls.io/github/gchauvet/vertx-async?branch=master)
[](https://www.codacy.com/app/gchauvet/vertx-async?utm_source=github.com&utm_medium=referral&utm_content=gchauvet/vertx-async&utm_campaign=Badge_Grade)
[](https://www.versioneye.com/user/projects/576e250f7bc681003c4900b1)
[](https://maven-badges.herokuapp.com/maven-central/io.zatarox/vertx-async)
vertx-async is a portage of caolan/async nodejs module to [Vert.x](http://vertx.io/) framework that provides helpers methods for common async patterns.
Async provides many methods that include the usual 'functional' suspects (`map`, `reduce`, `filter`, `each`…) as well as some common patterns for asynchronous control flow (`parallel`, `series`, `waterfall`…). All these functions assume you follow the [vert.x convention](http://vertx.io/docs/vertx-core/java/#_don_t_call_us_we_ll_call_you).
## Installation
vertx-async is available on maven central repository and OSSRH repository.
## Quick Examples
### Each
#### On a collection
```java
@Override
public void start(final Future startFuture) {
AsyncFactorySingleton.getInstance().createCollections(context)
.each(IntStream.iterate(0, i -> i + 1).limit(100).boxed().collect(Collectors.toList()), (item, handler) -> {
System.out.println("get " + item);
handler.handle(DefaultAsyncResult.succeed());
}, e -> {
System.out.println("done.");
startFuture.complete(e.result());
});
}
```
#### On a map
```java
@Override
public void start(final Future startFuture) {
AsyncFactorySingleton.getInstance().createCollections(context)
.each(IntStream.iterate(0, i -> i + 1).limit(100).boxed().collect(Collectors.toMap(p -> p.toString(), Function.identity())), (item, handler) -> {
System.out.println(item.getKey() + " -> " + item.getValue());
handler.handle(DefaultAsyncResult.succeed());
}, e -> {
System.out.println("done.");
startFuture.complete(e.result());
});
}
```
There are many more functions available so take a look at the wiki for a full list (work in progress) . This README aims to be comprehensive, so if you feel anything is missing please create a GitHub issue for it.
### Multiple callbacks
Make sure to always calling the callback handler once, instead of a `return` procedural programming statement style, otherwise you will cause multiple callbacks and unpredictable behavior in many cases.
## Documentation
See our wiki (:construction:).
### Collections
| | | | | | | | | | | |
|---|---|---|---|---|---|---|---|---|---|---|
| each | map | filter | reject | reduce | transform | detect | sort | some | every | concat |
### Control Flow
| | | | | | | | |
|---|---|---|---|---|---|---|---|
| series | parallel | whilst | until | during | forever | waterfall | seq |
| retry | queue | applyEach (each) | times | race | cargo | | |
# Utils
| | | | | | | | |
|---|---|---|---|---|---|---|---|
| asyncify | constant | memoize | timeout | | | | |