diff options
| author | Tyge Løvset <[email protected]> | 2023-05-02 23:11:20 +0200 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2023-05-02 23:11:20 +0200 |
| commit | e4efe2f9cc87e70e981ee75ec5c4d6db4cb60c49 (patch) | |
| tree | cc27dad2e46b424f14de92bf7a31319624b2dca2 /docs | |
| parent | 028b113df1e09cb56ac56b4ad60f633b8fabaded (diff) | |
| download | STC-modified-e4efe2f9cc87e70e981ee75ec5c4d6db4cb60c49.tar.gz STC-modified-e4efe2f9cc87e70e981ee75ec5c4d6db4cb60c49.zip | |
Changed cco_with_..() API again, final.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ccommon_api.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md index f4a2c349..7014def8 100644 --- a/docs/ccommon_api.md +++ b/docs/ccommon_api.md @@ -358,18 +358,18 @@ To resume the coroutine from where it was suspended with *cco_yield()*, simply c | `bool` | `cco_done(ctx)` | Is coroutine done? | | | `cco_begin(ctx)` | Begin coroutine block | | | `cco_end(retval)` | End coroutine block and return retval | -| | `cco_end()` | End coroutine block (return void) | +| | `cco_end()` | End coroutine block | | | `cco_yield(retval)` | Suspend execution and return retval | -| | `cco_yield()` | Suspend execution (return void) | -| | `cco_await(promise)` | Suspend and return false until promise is true | -| | `cco_await_void(promise)` | Suspend until promise is true (return void) | -| | `cco_await_while(cond, retval)` | Suspend and return retval while cond is true | +| | `cco_yield()` | Suspend execution | +| | `cco_await(promise)` | Suspend until promise is true | +| | `cco_await_with(promise, retval)` | Suspend with retval until promise is true | | | Semaphores: | | -| | `cco_semaphore` | Semaphore type | -| | `cco_await_sem(sem)` | Await for the semaphore count > 0 | +| | `cco_semaphore` | Semaphore type | +| | `cco_await_sem(sem)` | Await for the semaphore count > 0 | +| | `cco_await_sem_with(sem, retval)` | Await with retval for the semaphore | | | `cco_signal_sem(sem)` | Signal the semaphore by increasing count| | | From caller side: | | -| `void` | `cco_stop(ctx)` | Next call of coroutine returns `cco_end()` | +| `void` | `cco_stop(ctx)` | Next call of coroutine returns `cco_end()` | | `void` | `cco_reset(ctx)` | Reset state to initial (for reuse) | --- |