X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilcschedule.h;h=8c2154a5619e405f63df48f7dc8152307922124e;hb=52e57c880aba9c5e89f59d962eb9af75670b76e0;hp=637f058101bf28f52e3587df8caef94e1b772b86;hpb=d130c376d5e2475fc3cbf30b9fe70d6274f4b7ea;p=silc.git diff --git a/lib/silcutil/silcschedule.h b/lib/silcutil/silcschedule.h index 637f0581..8c2154a5 100644 --- a/lib/silcutil/silcschedule.h +++ b/lib/silcutil/silcschedule.h @@ -4,7 +4,7 @@ Author: Pekka Riikonen - Copyright (C) 1998 - 2006 Pekka Riikonen + Copyright (C) 1998 - 2007 Pekka Riikonen This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -95,39 +95,6 @@ typedef struct SilcScheduleStruct *SilcSchedule; ***/ typedef struct SilcTaskStruct *SilcTask; -/****d* silcutil/SilcScheduleAPI/SilcTaskType - * - * NAME - * - * typedef enum { ... } SilcTaskType; - * - * DESCRIPTION - * - * SILC has two types of tasks, non-timeout tasks (tasks that perform - * over file descriptors), and timeout tasks. This type is sent as - * argument for the task registering function, silc_schedule_task_add. - * - * SOURCE - */ -typedef enum { - /* File descriptor task that performs some event over file descriptors. - These tasks are for example network connections. */ - SILC_TASK_FD = 0, - - /* Timeout tasks are tasks that are executed after the specified - time has elapsed. After the task is executed the task is removed - automatically from the scheduler. It is safe to re-register the - task in task callback. It is also safe to unregister a task in - the task callback. */ - SILC_TASK_TIMEOUT, - - /* Platform specific process signal task. On Unix systems this is one of - the signals described in signal(7). On other platforms this may not - be available at all. Only one callback per signal may be added. */ - SILC_TASK_SIGNAL -} SilcTaskType; -/***/ - /****d* silcutil/SilcScheduleAPI/SilcTaskEvent * * NAME @@ -181,11 +148,59 @@ typedef enum { * To specify task callback function in the application using the * SILC_TASK_CALLBACK macro is recommended. * + * The callback should not perform lenghty or blocking operations as + * this would also block all other waiting tasks. The task callback + * should either handle the operation fast or issue an asynchronous + * call (like to register 0 timeout task) to handle it later. + * ***/ typedef void (*SilcTaskCallback)(SilcSchedule schedule, void *app_context, SilcTaskEvent type, SilcUInt32 fd, void *context); +/****f* silcutil/SilcScheduleAPI/SilcTaskNotifyCb + * + * SYNOPSIS + * + * typedef void (*SilcTaskNotifyCb)(SilcSchedule schedule, + * SilcBool added, SilcTask task, + * SilcBool fd_task, SilcUInt32 fd, + * SilcTaskEvent event, + * long seconds, long useconds, + * void *context); + * + * DESCRIPTION + * + * Task notify callback. Callback of this type can be set to scheduler + * by calling silc_schedule_set_notify and will be called whenever new + * task is added or old task is removed. If `added' is TRUE then `task' + * is added to scheduler. If `added' is FALSE then `task' will be removed + * from the scheduler. If `fd_task' is TRUE the `task' is file descriptor + * task and has `fd' is its file descriptor. If `fd_task' is FALSE then + * the task is timeout task and `seconds' and `useconds' specify the + * timeout. The `context' is the context given to silc_schedule_set_notify. + * + * NOTES + * + * The `schedule' is locked while this callback is called. This means that + * new tasks cannot be added or removed inside this callback. + * + * When timeout task expires this callback is not called. This is called + * only when task is explicitly deleted from the scheduler. Note that, + * when timeout task expires it is removed from the scheduler and `task' + * will become invalid. + * + * If fd task changes its events, this will be called as if it was a new + * task with different `event' mask. + * + ***/ +typedef void (*SilcTaskNotifyCb)(SilcSchedule schedule, + SilcBool added, SilcTask task, + SilcBool fd_task, SilcUInt32 fd, + SilcTaskEvent event, + long seconds, long useconds, + void *app_context); + /* Macros */ /****d* silcutil/SilcScheduleAPI/SILC_ALL_TASKS @@ -212,8 +227,8 @@ typedef void (*SilcTaskCallback)(SilcSchedule schedule, void *app_context, * * DESCRIPTION * - * Generic macro to define task callback functions. This defines a - * static function with name `func' as a task callback function. + * Generic macro to declare task callback functions. This defines a + * function with name `func' as a task callback function. * * SOURCE */ @@ -224,6 +239,8 @@ void func(SilcSchedule schedule, void *app_context, SilcTaskEvent type, \ /* Prototypes */ +#include "silcschedule_i.h" + /****f* silcutil/SilcScheduleAPI/silc_schedule_init * * SYNOPSIS @@ -238,11 +255,11 @@ void func(SilcSchedule schedule, void *app_context, SilcTaskEvent type, \ * to all task callbacks. The caller must free that context. The * 'app_context' can be for example the application itself. * - * The `max_tasks' is the maximum number of SILC_TASK_FD tasks in the - * scheduler. Set value to 0 to use default. Operating system will - * enforce the final limit. On some operating systems the limit can - * be significantly increased when this function is called in priviliged - * mode (as super user). + * The `max_tasks' is the maximum number of file descriptor and socket + * tasks in the scheduler. Set value to 0 to use default. Operating + * system will enforce the final limit. On some operating systems the + * limit can be significantly increased when this function is called in + * priviliged mode (as super user). * ***/ SilcSchedule silc_schedule_init(int max_tasks, void *app_context); @@ -289,9 +306,18 @@ void silc_schedule_stop(SilcSchedule schedule); * * DESCRIPTION * - * The SILC scheduler. The program will run inside this function. - * When this returns the program is to be ended. Before this function can - * be called, one must call silc_schedule_init function. + * The SILC scheduler. The program will run inside this function. + * When this returns the program is to be ended. Before this function + * can be called, one must call silc_schedule_init function. + * + * NOTES + * + * On Windows this will block the calling thread but will continue + * to dispatch window messages, and thus can be used as the main loop + * of the program. + * + * On Symbian this will block the calling thread. The Symbian Active + * Scheduler must be running before calling this function. * ***/ void silc_schedule(SilcSchedule schedule); @@ -300,7 +326,7 @@ void silc_schedule(SilcSchedule schedule); * * SYNOPSIS * - * SilcBool silc_schedule_one(SilcSchedule schedule, int block); + * SilcBool silc_schedule_one(SilcSchedule schedule, int timeout_usecs); * * DESCRIPTION * @@ -311,6 +337,11 @@ void silc_schedule(SilcSchedule schedule); * scheduler. The function will not return in this timeout unless * some other event occurs. * + * Typically this would be called from a timeout or idle task + * periodically (typically from 5-50 ms) to schedule SILC tasks. In + * this case the `timeout_usecs' is usually 0 to make the function + * return immediately. + * ***/ SilcBool silc_schedule_one(SilcSchedule schedule, int timeout_usecs); @@ -322,12 +353,11 @@ SilcBool silc_schedule_one(SilcSchedule schedule, int timeout_usecs); * * DESCRIPTION * - * Wakes up the scheduler. This is used only in multi-threaded + * Wakes up the scheduler. This is may be used in multi-threaded * environments where threads may add new tasks or remove old tasks * from the scheduler. This is called to wake up the scheduler in the * main thread so that it detects the changes in the scheduler. * If threads support is not compiled in this function has no effect. - * Implementation of this function may be platform specific. * ***/ void silc_schedule_wakeup(SilcSchedule schedule); @@ -342,12 +372,28 @@ void silc_schedule_wakeup(SilcSchedule schedule); * * Returns the application specific context that was saved into the * scheduler in silc_schedule_init function. The context is also - * returned to application in task callback functions, but this function + * returned to application in the SilcTaskCallback, but this function * may be used to get it as well if needed. * ***/ void *silc_schedule_get_context(SilcSchedule schedule); +/****f* silcutil/SilcScheduleAPI/silc_schedule_set_notify + * + * SYNOPSIS + * + * void silc_schedule_set_notify(SilcSchedule schedule, + * SilcTaskNotifyCb notify, void *context); + * + * DESCRIPTION + * + * Set notify callback to scheduler. The `notify' will be called whenever + * task is added to or deleted from scheduler. + * + ***/ +void silc_schedule_set_notify(SilcSchedule schedule, + SilcTaskNotifyCb notify, void *context); + /****f* silcutil/SilcScheduleAPI/silc_schedule_task_add_fd * * SYNOPSIS @@ -363,6 +409,12 @@ void *silc_schedule_get_context(SilcSchedule schedule); * handle. To receive events for the file descriptor set the correct * request events with silc_schedule_set_listen_fd function. * + * The task will be initially set for SILC_TASK_READ events. Setting that + * event immediately after this call returns is not necessary. + * + * This returns the new task or NULL on error. If a task with `fd' has + * already been added this will return the existing task pointer. + * ***/ #define silc_schedule_task_add_fd(schedule, fd, callback, context) \ silc_schedule_task_add(schedule, fd, callback, context, 0, 0, SILC_TASK_FD) @@ -381,7 +433,7 @@ void *silc_schedule_get_context(SilcSchedule schedule); * Add timeout task to scheduler. The `callback' will be called once * the specified timeout has elapsed. The task will be removed from the * scheduler automatically once the task expires. The event returned - * to the `callback' is SILC_TASK_EXPIRE. The task added with zero (0) + * to the `callback' is SILC_TASK_EXPIRE. A task added with zero (0) * timeout will be executed immediately next time tasks are scheduled. * ***/ @@ -422,105 +474,112 @@ void *silc_schedule_get_context(SilcSchedule schedule); * * SYNOPSIS * - * void silc_schedule_task_del(SilcSchedule schedule, SilcTask task); + * SilcBool silc_schedule_task_del(SilcSchedule schedule, SilcTask task); * * DESCRIPTION * * Deletes the `task' from the scheduler indicated by the `schedule'. * After deleting the task it is guaranteed that the task callback * will not be called. If the `task' is SILC_ALL_TASKS then all - * tasks is removed from the scheduler. + * tasks is removed from the scheduler. Returns always TRUE. * * It is safe to call this function in any place. Tasks may be removed * in task callbacks (including in the task's own task callback) and * in multi-threaded environment in other threads as well. * ***/ -void silc_schedule_task_del(SilcSchedule schedule, SilcTask task); +SilcBool silc_schedule_task_del(SilcSchedule schedule, SilcTask task); /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del_by_fd * * SYNOPSIS * - * void silc_schedule_task_del_by_fd(SilcSchedule schedule, SilcUInt32 fd); + * SilcBool silc_schedule_task_del_by_fd(SilcSchedule schedule, + * SilcUInt32 fd); * * DESCRIPTION * - * Deletes a task from the scheduler by the specified `fd'. + * Deletes a task from the scheduler by the specified `fd'. Returns + * FALSE if such fd task does not exist. * * It is safe to call this function in any place. Tasks may be removed * in task callbacks (including in the task's own task callback) and * in multi-threaded environment in other threads as well. * ***/ -void silc_schedule_task_del_by_fd(SilcSchedule schedule, SilcUInt32 fd); +SilcBool silc_schedule_task_del_by_fd(SilcSchedule schedule, SilcUInt32 fd); /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del_by_callback * * SYNOPSIS * - * void silc_schedule_task_del_by_callback(SilcSchedule schedule, - * SilcTaskCallback callback); + * SilcBool silc_schedule_task_del_by_callback(SilcSchedule schedule, + * SilcTaskCallback callback); * * DESCRIPTION * * Deletes a task from the scheduler by the specified `callback' task - * callback function. + * callback function. Returns FALSE if such task with such callback + * does not exist. * * It is safe to call this function in any place. Tasks may be removed * in task callbacks (including in the task's own task callback) and * in multi-threaded environment in other threads as well. * ***/ -void silc_schedule_task_del_by_callback(SilcSchedule schedule, - SilcTaskCallback callback); +SilcBool silc_schedule_task_del_by_callback(SilcSchedule schedule, + SilcTaskCallback callback); /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del_by_context * * SYNOPSIS * - * void silc_schedule_task_del_by_context(SilcSchedule schedule, - * void *context); + * SilcBool silc_schedule_task_del_by_context(SilcSchedule schedule, + * void *context); * * DESCRIPTION * - * Deletes a task from the scheduler by the specified `context'. + * Deletes a task from the scheduler by the specified `context'. Returns + * FALSE if such task with such context does not exist. * * It is safe to call this function in any place. Tasks may be removed * in task callbacks (including in the task's own task callback) and * in multi-threaded environment in other threads as well. * ***/ -void silc_schedule_task_del_by_context(SilcSchedule schedule, void *context); +SilcBool silc_schedule_task_del_by_context(SilcSchedule schedule, + void *context); /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del_by_all * * SYNOPSIS * - * void silc_schedule_task_del_by_all(SilcSchedule schedule, int fd, - * SilcTaskCallback callback, - * void *context); + * SilcBool silc_schedule_task_del_by_all(SilcSchedule schedule, int fd, + * SilcTaskCallback callback, + * void *context); * * DESCRIPTION * * Deletes a task from the scheduler by the specified `fd', `callback' - * and `context'. + * and `context'. Returns FALSE if such task does not exist. * * It is safe to call this function in any place. Tasks may be removed * in task callbacks (including in the task's own task callback) and * in multi-threaded environment in other threads as well. * ***/ -void silc_schedule_task_del_by_all(SilcSchedule schedule, int fd, - SilcTaskCallback callback, void *context); +SilcBool silc_schedule_task_del_by_all(SilcSchedule schedule, int fd, + SilcTaskCallback callback, + void *context); /****f* silcutil/SilcScheduleAPI/silc_schedule_set_listen_fd * * SYNOPSIS * - * void silc_schedule_set_listen_fd(SilcSchedule schedule, SilcUInt32 fd, - * SilcTaskEvent mask, - * SilcBool send_events); + * SilcBool silc_schedule_set_listen_fd(SilcSchedule schedule, + * SilcUInt32 fd, + * SilcTaskEvent mask, + * SilcBool send_events); * * DESCRIPTION * @@ -538,9 +597,28 @@ void silc_schedule_task_del_by_all(SilcSchedule schedule, int fd, * after the event occurs in reality. In normal cases the `send_events' * is set to FALSE. * + * Returns FALSE if the operation could not performed and TRUE if it + * was a success. + * ***/ -void silc_schedule_set_listen_fd(SilcSchedule schedule, SilcUInt32 fd, - SilcTaskEvent mask, SilcBool send_events); +SilcBool silc_schedule_set_listen_fd(SilcSchedule schedule, SilcUInt32 fd, + SilcTaskEvent mask, SilcBool send_events); + +/****f* silcutil/SilcScheduleAPI/silc_schedule_get_fd_events + * + * SYNOPSIS + * + * SilcTaskEvent silc_schedule_get_fd_events(SilcSchedule schedule, + * SilcUInt32 fd); + * + * DESCRIPTION + * + * Returns the file descriptor `fd' current requested events mask, + * or 0 on error. + * + ***/ +SilcTaskEvent silc_schedule_get_fd_events(SilcSchedule schedule, + SilcUInt32 fd); /****f* silcutil/SilcScheduleAPI/silc_schedule_unset_listen_fd * @@ -557,6 +635,4 @@ void silc_schedule_set_listen_fd(SilcSchedule schedule, SilcUInt32 fd, ***/ void silc_schedule_unset_listen_fd(SilcSchedule schedule, SilcUInt32 fd); -#include "silcschedule_i.h" - #endif