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

https://github.com/thislight/away

Portable asynchronous framework for Lua.
https://github.com/thislight/away

async asynchronous coroutine lua

Last synced: 11 months ago
JSON representation

Portable asynchronous framework for Lua.

Awesome Lists containing this project

README

          

# Away
Portable asynchronous framework for Lua.

Known supported version:
- Lua 5.3
- Lua 5.4

Pipeline status:
| Branch | Status |
|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| master | [![pipeline status](https://gitlab.com/thislight/away/badges/master/pipeline.svg)](https://gitlab.com/thislight/away/-/pipelines?scope=all&ref=master)![coverage report](https://gitlab.com/thislight/away/badges/master/coverage.svg) |
| develop | [![pipeline status](https://gitlab.com/thislight/away/badges/develop/pipeline.svg)](https://gitlab.com/thislight/away/-/pipelines?scope=all&ref=develop)![coverage report](https://gitlab.com/thislight/away/badges/develop/coverage.svg) |

## Install Away

````
luarocks install away
````

Or copy the files you need. Away is zero-dependency.

## Current versions
- 0.1.2 (current)
- 0.1.3 (developing)

## Drivers
Use away with any other asynchronous I/O library.

- [away-luv](https://github.com/thislight/away-luv)

## Helpers

- [away-dataqueue](https://github.com/thislight/away-dataqueue)

## Doucments
- [Designs](wiki/designs.md)
- [Usage](wiki/usage.md)
- [Example](example/)
- [Contribution Guide](wiki/contributing.md)

## Run Tests
Tests use [busted](http://olivinelabs.com/busted/).
To run tests, just use the command in project directory:
````shell
busted
````

## License
GNU General Public License, version 3 or later.

away - Portable asynchronous framework for Lua.
Copyright (C) 2020-2022 thisLight

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see .

> Note on GPLv3: although you have copied code from this project, you don't need to open source if you don't convey it (see GPLv3 for definition of "convey"). This is not a legal advice.

> All `.d.tl` files are licensed under MIT License, turn to https://github.com/teal-language/teal-types/blob/master/LICENSE for details

## Special Things

[Earlier Version of This Project](https://gist.github.com/thislight/220ce18f2e7f303c0b08e1e9c6f3c8ae)