31 lines
1.1 KiB
Plaintext
31 lines
1.1 KiB
Plaintext
/* liblwevent/src/docs/MainPage.dox
|
|
*
|
|
* (c)2007, Laurence Withers, <l@lwithers.me.uk>.
|
|
* Released under the GNU GPLv2. See file COPYING or
|
|
* http://www.gnu.org/copyleft/gpl.html for details.
|
|
*/
|
|
|
|
/*! \mainpage Lightweight Event Library
|
|
|
|
This library is a lightweight wrapper around the \c epoll(7) facility. Its purpose is to provide a
|
|
slightly higher level interface for simplicity and speed of development. Effectively, it provides an
|
|
API consisting of the common operations used by programs written using an event-driven, finite state
|
|
machine (or other object-based) paradigm.
|
|
|
|
Its features are as follows:
|
|
\li simple event loop interface (see section \ref eventloop)
|
|
\li wrapper functions for adding and removing file descriptors (see section \ref fdevent)
|
|
\li signal functions (TODO)
|
|
\li timer functions (TODO)
|
|
\li safe inter-object actions (one object may free another at any time)
|
|
\li O(1) design to match that of \c epoll(7)
|
|
|
|
See the page \ref libdesign for detailed information on the implementation.
|
|
|
|
*/
|
|
|
|
/* options for text editors
|
|
kate: replace-trailing-space-save true; space-indent true; tab-width 4;
|
|
vim: expandtab:ts=4:sw=4:syntax=doxygen
|
|
*/
|