arnebab / guile-a-sync Goto Github PK

Overview
--------

This library provides a thread safe event loop for guile
(event-loop.scm) with support for watches on ports/file descriptors
and timeouts, and which permits events to be posted by other tasks.
This includes tasks running on other threads.

It also provides a coroutines interface (coroutines.scm) which
provides await semantics on such events, so as to avoid inversion of
control (aka "callback hell").

See docs/coroutines and docs/event-loop for further details, and the
docs/example.scm file.

Installation
------------

Configure in the ordinary way with something like:

  ./configure --prefix=/usr

or on a 64-bit system, probably:

  ./configure --prefix=/usr --libdir=/usr/lib64

On a 64 bit system you may also need to include -fPIC in your CFLAGS
options if libtool doesn't do that for you (libtool normally does when
necessary).

If compiling from git rather than from a release tarball, you will
need to set up the library by running ./autogen.sh before running
configure.

After compiling, install with 'make install' as root.

By default, the scheme files provided by this library will be
pre-compiled to guile bytecode and installed with the scheme files in
guile's site directory.  If that behaviour is not wanted (say, because
a unix-like compile environment is not available which is acceptable
to the compile scripts), then configure with the
--disable-compile-to-bytecode option.

Documentation
-------------

Html documentation is available after installation in the default html
directory for the target installation (normally at
$(prefix)/share/doc/guile-a-sync/html/index.html).