https://keplerproject.github.io/copas

Copas is a dispatcher based on coroutines that can be used by TCP/IP servers.
https://keplerproject.github.io/copas

Last synced: about 2 months ago
JSON representation

Copas is a dispatcher based on coroutines that can be used by TCP/IP servers.

• Host: GitHub
• URL: https://keplerproject.github.io/copas
• Owner: lunarmodules
• License: mit
• Created: 2009-09-24T01:49:35.000Z (about 15 years ago)
• Default Branch: master
• Last Pushed: 2024-03-11T18:12:29.000Z (9 months ago)
• Last Synced: 2024-04-14T13:03:31.728Z (8 months ago)
• Language: Lua
• Homepage: https://lunarmodules.github.io/copas
• Size: 524 KB
• Stars: 198
• Watchers: 17
• Forks: 70
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-lua - Copas - Copas is a dispatcher based on coroutines that can be used by TCP/IP servers. (Networking)

README

        
# Copas 4.7

[![Unix build](https://img.shields.io/github/actions/workflow/status/lunarmodules/copas/unix_build.yml?branch=master&label=Unix%20build&logo=linux)](https://github.com/lunarmodules/copas/actions)

[![Coveralls code coverage](https://img.shields.io/coveralls/github/lunarmodules/copas?logo=coveralls)](https://coveralls.io/github/lunarmodules/copas)

[![Luacheck](https://github.com/lunarmodules/copas/workflows/Luacheck/badge.svg)](https://github.com/lunarmodules/copas/actions)

[![SemVer](https://img.shields.io/github/v/tag/lunarmodules/copas?color=brightgreen&label=SemVer&logo=semver&sort=semver)](CHANGELOG.md)

[![Licence](http://img.shields.io/badge/Licence-MIT-brightgreen.svg)](LICENSE)

Copas is a dispatcher based on coroutines that can be used for asynchronous networking. For example TCP or UDP based servers. But it also features timers and client support for http(s), ftp and smtp requests.

It uses [LuaSocket](https://github.com/diegonehab/luasocket) as the interface with the TCP/IP stack and [LuaSec](https://github.com/brunoos/luasec) for ssl support.

A server or thread registered with Copas should provide a handler for requests and use Copas socket functions to send the response. Copas loops through requests and invokes the corresponding handlers. For a full implementation of a Copas HTTP server you can refer to [Xavante](http://keplerproject.github.io/xavante/) as an example.

Copas is free software and uses the same license as Lua (MIT), and can be downloaded from [its GitHub page](https://github.com/lunarmodules/copas).

The easiest way to install Copas is through [LuaRocks](https://luarocks.org/):

```

luarocks install copas

```

For more details see [the documentation](http://lunarmodules.github.io/copas/).

### Releasing a new version

 - update changelog in docs (`index.html`, update `history` and `status` sections)

 - update version in `copas.lua`

 - update version at the top of this README,

 - update copyright years if needed

 - update rockspec

 - commit as `release X.Y.Z`

 - tag as `vX_Y_Z` and as `X.Y.Z`

 - push commit and tag

 - upload to luarocks

 - test luarocks installation