Copas

Coroutine Oriented Portable Asynchronous Services for Lua

Contents

• Overview
• Current Version
• Download
• What's new
• Reference
• Examples
• Credits
• Contact us

Overview

Copas offers a dispatcher based on coroutines that can be used by socket request/response server programs. A server registered with Copas should provide a handler for requests and use Copas socket functions to send the response.

Since Copas is coroutine based, using it within a pcall or xpcall context does not work with Lua 5.0 yielding. If you need to use those functions we strongly suggest using Xavante's coxpcall, a coroutine safe version of the Lua 5.0 protected calls.

Copas follows the package proposal for Lua 5.1, therefore this package should be "installed". In other words, if you are using Lua 5.0, the file compat-5.1.lua must be installed in the LUA_PATH. If you are using Lua 5.1, nothing should be done.

Copas is free software and uses the same license as Lua 5.0.

Current version

Current version is 1.0 Beta. It was developed for Lua 5.0 and Lua 5.1.

Download

Copas can be downloaded from its LuaForge page.

What's new

• [17/Feb/2005] Version 1.0 beta released
  First public version

Reference

Copas functions are separated in two groups. The first one is relative to the use of the dispatcher:

• copas.addserver(server, handler, timeout)
  Adds a new server and its handler to the dispatcher using an optional timeout.
• copas.loop()
  Listen to client requests and handles them.

The second group is used by the handlers to exchange data with clients:

• copas.flush(client)
  Flushes a client write buffer.
• copas.receive(client, pattern)
  Reads a pattern from a client and yields to the reading set on timeouts.
• copas.send(client, data)
  Sends data to a client. The operation is buffered and yields to the writing set on timeouts.
• copas.wrap (skt)
  Wraps a socket to use Copas' methods.

Examples

(to do)

Credits

Copas was designed and implemented by André Carregal and Javier Guerra as part of the Kepler Project which holds its copyright. Copas development had significative contributions from Diego Nehab, Mike Pall and David Burgess

Contact us

For more information please contact us. Comments are welcome!