diff options
| author | lurchi <lurchi@strangeplace.net> | 2018-02-01 20:09:13 +0100 |
|---|---|---|
| committer | lurchi <lurchi@strangeplace.net> | 2018-02-01 20:09:13 +0100 |
| commit | 4c6b07e810bd8b6245c152d6b3a161083105a165 (patch) | |
| tree | 747d3c8937130df76c10a48482758e13384f53e1 /src/util/scheduler.c | |
| parent | 89d1b38101ea52dfe7ef20ab8f6604a6f973bbbd (diff) | |
| download | gnunet-4c6b07e810bd8b6245c152d6b3a161083105a165.tar.gz gnunet-4c6b07e810bd8b6245c152d6b3a161083105a165.zip | |
improve documentation
Diffstat (limited to 'src/util/scheduler.c')
| -rw-r--r-- | src/util/scheduler.c | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/src/util/scheduler.c b/src/util/scheduler.c index 05a951e19..51afc85e5 100644 --- a/src/util/scheduler.c +++ b/src/util/scheduler.c | |||
| @@ -2128,12 +2128,13 @@ GNUNET_SCHEDULER_do_work (struct GNUNET_SCHEDULER_Handle *sh) | |||
| 2128 | * Function called by external event loop implementations to initialize | 2128 | * Function called by external event loop implementations to initialize |
| 2129 | * the scheduler. An external implementation has to provide @a driver | 2129 | * the scheduler. An external implementation has to provide @a driver |
| 2130 | * which contains callbacks for the scheduler (see definition of struct | 2130 | * which contains callbacks for the scheduler (see definition of struct |
| 2131 | * #GNUNET_SCHEDULER_Driver) for instructing the external implementation | 2131 | * #GNUNET_SCHEDULER_Driver). The callbacks are used to instruct the |
| 2132 | * to watch for events. If it detects any event it is expected to call | 2132 | * external implementation to watch for events. If it detects any of |
| 2133 | * #GNUNET_SCHEDULER_do_work to let the scheduler handle it. If an event | 2133 | * those events it is expected to call #GNUNET_SCHEDULER_do_work to let |
| 2134 | * is related to a specific task (e.g. the scheduler gave instructions | 2134 | * the scheduler handle it. If an event is related to a specific task |
| 2135 | * to watch a file descriptor), the external implementation is expected | 2135 | * (e.g. the scheduler gave instructions to watch a file descriptor), |
| 2136 | * to mark that task ready before by calling #GNUNET_SCHEDULER_task_ready. | 2136 | * the external implementation is expected to mark that task ready |
| 2137 | * before by calling #GNUNET_SCHEDULER_task_ready. | ||
| 2137 | 2138 | ||
| 2138 | * This function has to be called before any tasks are scheduled and | 2139 | * This function has to be called before any tasks are scheduled and |
| 2139 | * before GNUNET_SCHEDULER_do_work is called for the first time. It | 2140 | * before GNUNET_SCHEDULER_do_work is called for the first time. It |