Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/etcimon/libasync

Cross-platform event loop library of asynchronous objects
https://github.com/etcimon/libasync

Last synced: 15 days ago
JSON representation

Cross-platform event loop library of asynchronous objects

Awesome Lists containing this project

README 

        
[![CI](https://github.com/etcimon/libasync/actions/workflows/ci.yml/badge.svg)](https://github.com/etcimon/libasync/actions/workflows/ci.yml)



About

-----



The libasync asynchronous library is written completely in D, features a cross-platform event loop and enhanced connectivity and concurrency facilities for extremely lightweight asynchronous tasks. It embeds naturally to D projects (DMD >= 2.076.0, LDC >= 1.18.0), allows you to target a wide range of architectures through LDC, compiles statically with your project and has an open source license (MIT).



A fully functional, tested vibe.d driver is available in [the latest version of vibe.d](https://github.com/rejectedsoftware/vibe.d/), you can enable it by appending `"subConfigurations": { "vibe-d": "libasync"}` in your project's dub.json configuration file.



### Features



The following capabilities have been tested in a production environment:



(*) _Unit tests confirmed on Mac, Linux, Windows_ - Platforms used were Mac OS X (10.8+, 10.9+), Linux (Fedora 20+) and Windows 7+ 32/64 bit, although it should be compatible to 99% of Desktop OS users.



(*) _Compiles with DMD & LDC_ (DMD 2.076.0+, LDC 1.18.0+)



- **Multi-threading** support - EventLoop can be launched and run from an unlimited number of threads!



- **Asynchronous TCP connection** - handles multiple requests at a time in each individual thread



- **Buffered TCP connection** - Allows callbacks to be attached to a byte sized future



- **Asynchronous TCP listener** - delivers a new connection to the delegate of your choice



- **File Operations** - executes file read/write/append commands in a thread pool, notifies of completion in a handler



- **DNS resolver** - runs blocking DNS resolve operations in a thread pool, savings are the duration of a ping.



- **File/Folder Watcher** - watches directories for file changes (CREATE, DELETE, MODIFY, RENAME/MOVE)



- **UDP connection** - receives or sends packets from/to multiple peers



- **Timer** - sets a periodic or one-shot/periodic timer with high-precision (μs) to call a select delegate



- **Signal** - Wakes up the event loop in a foreign thread and passes a message to its delegate



- **Notifier** - Thread-local and lock-less adaptation of **Signal** which queues a message intended for a local delegate



### Limitations



Some or all of these limitations are possibly being implemented currently and may be available in a future release.



- **One EventLoop per thread** - There is a hard limit of one event loop per thread

- **Manual error management** - The entire library is `nothrow` and error management must be built on top of it.

- **No embedded HTTP or TLS handlers** - The support fort HTTP, TLS (and other protocols) is only available through vibe.d with Tasks as of yet.



Installation Instructions

-------------------------



- Download and install DMD from [dlang.org](http://dlang.org/download.html)

- Use Git to clone this repository

- Run `dub test` to test the library on your operating system (submit any issue with a log report by uncommenting `enum LOG = true` in `types.d`)

- Add the library to your project by including it in the dependencies, using `import libasync`

- The recommended editor is Visual Studio Code with the Code-D extension

- On another note, you can also try the vibe.d libasync built-in driver by adding `"subConfigurations": { "vibe-d": "libasync" }` to your vibe.d dub.json.



Tutorial

--------



There are many examples available in the `examples/` older. They must be tested by starting the server before the client.



All other usage examples are available in `source/libasync/test.d`. 



Documentation has been written throughout the code.