The Equeue user's guide

Gerd Stolpmann

Equeue offers general purpose event queues and event queues for system events.

Download Equeue: . The free Equeue library can be downloaded at http://www.ocaml-programming.de/packages/. The user's guide is included. Newest releases of Equeue will be announced in The OCaml Link Database.

License

This document, and the described software, "Equeue", are copyright by Gerd Stolpmann.

Permission is hereby granted, free of charge, to any person obtaining a copy of this document and the "Equeue" software (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The Software is provided ``as is'', without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall Gerd Stolpmann be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the Software or the use or other dealings in the software.

Table of Contents

1. Introduction into event-driven programming

2. The Equeue module

2.1. Description
2.2. A silly example

3. The Unixqueue module

3.1. Description
3.2. Example: Copying several files in parallel

4. Engines

4.1. Modelling the abstract properties of engines
4.2. Examples for engine primitives and engine construction
4.3. The notification mechanism
4.4. Asynchronous channels
4.5. Receivers
4.6. Example: A simple HTTP client

5. Event-driven programming vs. multi-threaded programming

5.1. Combining both styles

6. Pitfalls

7. Using Unixqueue together with Tcl (labltk) and Glib (lablgtk)