diff options
Diffstat (limited to 'lib/coro.h')
-rw-r--r-- | lib/coro.h | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/lib/coro.h b/lib/coro.h new file mode 100644 index 00000000..b36f1d2c --- /dev/null +++ b/lib/coro.h @@ -0,0 +1,31 @@ +/* + * BIRD Coroutines + * + * (c) 2017 Martin Mares <mj@ucw.cz> + * (c) 2020-2021 Maria Matejka <mq@jmq.cz> + * + * Can be freely distributed and used under the terms of the GNU GPL. + */ + +#ifndef _BIRD_CORO_H_ +#define _BIRD_CORO_H_ + +#include "lib/resource.h" + +/* A completely opaque coroutine handle. */ +struct coroutine; + +/* Coroutines are independent threads bound to pools. + * You request a coroutine by calling coro_run(). + * It is forbidden to free a running coroutine from outside. + * The running coroutine must free itself by rfree() before returning. + */ +struct coroutine *coro_run(pool *, void (*entry)(void *), void *data); + +/* Get self. */ +extern _Thread_local struct coroutine *this_coro; + +/* Just wait for a little while. Not intended for general use; use events if possible. */ +void coro_yield(void); + +#endif |