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/include | |
parent | 89d1b38101ea52dfe7ef20ab8f6604a6f973bbbd (diff) | |
download | gnunet-4c6b07e810bd8b6245c152d6b3a161083105a165.tar.gz gnunet-4c6b07e810bd8b6245c152d6b3a161083105a165.zip |
improve documentation
Diffstat (limited to 'src/include')
-rw-r--r-- | src/include/gnunet_scheduler_lib.h | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/src/include/gnunet_scheduler_lib.h b/src/include/gnunet_scheduler_lib.h index e5c361567..f9b2736e4 100644 --- a/src/include/gnunet_scheduler_lib.h +++ b/src/include/gnunet_scheduler_lib.h | |||
@@ -330,13 +330,14 @@ typedef void | |||
330 | * Function called by external event loop implementations to initialize | 330 | * Function called by external event loop implementations to initialize |
331 | * the scheduler. An external implementation has to provide @a driver | 331 | * the scheduler. An external implementation has to provide @a driver |
332 | * which contains callbacks for the scheduler (see definition of struct | 332 | * which contains callbacks for the scheduler (see definition of struct |
333 | * #GNUNET_SCHEDULER_Driver) for instructing the external implementation | 333 | * #GNUNET_SCHEDULER_Driver). The callbacks are used to instruct the |
334 | * to watch for events. If it detects any event it is expected to call | 334 | * external implementation to watch for events. If it detects any of |
335 | * #GNUNET_SCHEDULER_do_work to let the scheduler handle it. If an event | 335 | * those events it is expected to call #GNUNET_SCHEDULER_do_work to let |
336 | * is related to a specific task (e.g. the scheduler gave instructions | 336 | * the scheduler handle it. If an event is related to a specific task |
337 | * to watch a file descriptor), the external implementation is expected | 337 | * (e.g. the scheduler gave instructions to watch a file descriptor), |
338 | * to mark that task ready before by calling #GNUNET_SCHEDULER_task_ready. | 338 | * the external implementation is expected to mark that task ready |
339 | 339 | * before by calling #GNUNET_SCHEDULER_task_ready. | |
340 | * | ||
340 | * This function has to be called before any tasks are scheduled and | 341 | * This function has to be called before any tasks are scheduled and |
341 | * before GNUNET_SCHEDULER_do_work is called for the first time. It | 342 | * before GNUNET_SCHEDULER_do_work is called for the first time. It |
342 | * allocates resources that have to be freed again by calling | 343 | * allocates resources that have to be freed again by calling |