7 Author: Pekka Riikonen <priikone@silcnet.org>
9 Copyright (C) 1998 - 2001 Pekka Riikonen
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
23 /****h* silcutil/SilcScheduleAPI
27 * The SILC Scheduler is the heart of any application. The scheduler provides
28 * the application's main loop that can handle incoming data, outgoing data,
29 * timeouts and dispatch different kind of tasks.
31 * The SILC Scheduler supports file descriptor based tasks, timeout tasks
32 * and generic tasks. File descriptor tasks are tasks that perform some
33 * operation over the specified file descriptor. These include network
34 * connections, for example. The timeout tasks are timeouts that are executed
35 * after the specified timeout has elapsed. The generic tasks are tasks that
36 * apply to all registered file descriptors thus providing one task that
37 * applies to many independent connections.
39 * The SILC Scheduler is designed to be the sole main loop of the application
40 * so that the application does not need any other main loop. However,
41 * SILC Scheduler does support running the scheduler only once, so that the
42 * scheduler does not block, and thus providing a possiblity that some
43 * external main loop is run over the SILC Scheduler. However, these
44 * applications are considered to be special cases.
46 * Typical application first initializes the scheduler and then registers
47 * the very first tasks to the scheduler and then run the scheduler. After
48 * the scheduler's run function returns the application is considered to be
51 * On WIN32 systems the SILC Scheduler is too designed to work as the main
52 * loop of the GUI application. It can handle all Windows messages and
53 * it dispatches them from the scheduler, and thus makes it possible to
54 * create GUI applications. The scheduler can also handle all kinds of
55 * WIN32 handles, this includes sockets created by the SILC Net API routines,
56 * WSAEVENT handle objects created by Winsock2 routines and arbitrary
57 * WIN32 HANDLE objects.
59 * The SILC Scheduler supports multi-threads as well. The actual scheduler
60 * must be run in single-thread but other threads may register new tasks
61 * and unregister old tasks. However, it is enforced that the actual
62 * task is always run in the main thread. The scheduler is context based
63 * which makes it possible to allocate several schedulers for one application.
64 * Since the scheduler must be run in single-thread, a multi-threaded
65 * application could be created by allocating own scheduler for each of the
70 #ifndef SILCSCHEDULE_H
71 #define SILCSCHEDULE_H
73 /****s* silcutil/SilcScheduleAPI/SilcSchedule
77 * typedef struct SilcScheduleStruct *SilcSchedule;
81 * This context is the actual Scheduler and is allocated by
82 * the silc_schedule_init funtion. The context is given as argument
83 * to all silc_schedule_* functions. It must be freed by the
84 * silc_schedule_uninit function.
87 typedef struct SilcScheduleStruct *SilcSchedule;
89 /****s* silcutil/SilcScheduleAPI/SilcTask
93 * typedef struct SilcTaskStruct *SilcTask;
97 * This object represents one task in the scheduler. It is allocated
98 * by the silc_schedule_task_add function and freed by one of the
99 * silc_schedule_task_del* functions.
102 typedef struct SilcTaskStruct *SilcTask;
104 /****d* silcutil/SilcScheduleAPI/SilcTaskType
108 * typedef enum { ... } SilcTaskType;
112 * SILC has three types of tasks, non-timeout tasks (tasks that perform
113 * over file descriptors), timeout tasks and generic tasks (tasks that
114 * apply to every file descriptor). This type is sent as argument for the
115 * task registering function, silc_schedule_task_add.
120 /* File descriptor task that performs some event over file descriptors.
121 These tasks are for example network connections. */
124 /* Timeout tasks are tasks that are executed after the specified
125 time has elapsed. After the task is executed the task is removed
126 automatically from the scheduler. It is safe to re-register the
127 task in task callback. It is also safe to unregister a task in
128 the task callback. */
131 /* Generic tasks are non-timeout tasks and they apply to all file
132 descriptors, except to those that have explicitly registered a
133 non-timeout task. These tasks are there to make it simpler and faster
134 to execute common code that applies to all connections. These are,
135 for example, receiving packets from network and sending packets to
136 network. It doesn't make much sense to register a task that receives
137 a packet from network to every connection when you can have one task
138 that applies to all connections. This is what generic tasks are for.
139 Generic tasks are not bound to any specific file descriptor, however,
140 the correct file descriptor must be passed as argument to task
141 registering function. */
146 /****d* silcutil/SilcScheduleAPI/SilcTaskEvent
150 * typedef enum { ... } SilcTaskEvent;
154 * SILC Task event types. The event type indicates the occurred
155 * event of the task. This type will be given as argument to the
156 * SilcTaskCallback function to indicate the event for the caller.
157 * The SILC_TASK_READ and SILC_TASK_WRITE may be set by the caller
158 * of the silc_schedule_set_listen_fd, if the caller needs to control
159 * the events for the task. The SILC_TASK_EXPIRE is set always only
160 * by the scheduler when timeout expires for timeout task.
165 SILC_TASK_READ = 0x0001, /* Reading */
166 SILC_TASK_WRITE = 0x0002, /* Writing */
167 SILC_TASK_EXPIRE = 0x0004, /* Timeout */
171 /****d* silcutil/SilcScheduleAPI/SilcTaskPriority
175 * typedef enum { ... } SilcTaskPriority;
179 * Task priorities. Tasks may be registered with different priorities.
180 * This type defines the different task priorities. The priorities
181 * behaves same for all type of tasks, fd tasks, timeout tasks and
187 /* Lowest priority. The task is scheduled to run after its timeout
188 has expired only and only when every other task with higher priority
189 has already been run. For non-timeout tasks this priority behaves
190 same way. Life is not fair for tasks with this priority. */
193 /* Normal priority that is used mostly in SILC. This is priority that
194 should always be used unless you specificly need some other priority.
195 The scheduler will run this task as soon as its timeout has expired.
196 For non-timeout tasks this priority behaves same way. Tasks are run
197 in FIFO (First-In-First-Out) order. */
198 SILC_TASK_PRI_NORMAL,
202 /****f* silcutil/SilcScheduleAPI/SilcTaskCallback
206 * typedef void (*SilcTaskCallback)(SilcSchedule schedule,
207 * SilcTaskEvent type, uint32 fd,
212 * The task callback function. This function will be called by the
213 * scheduler when some event of the task is performed. For example,
214 * when data is available from the connection this will be called.
216 * The `schedule' is the scheduler context, the `type' is the indicated
217 * event, the `fd' is the file descriptor of the task and the `context'
218 * is a caller specified context. If multiple events occurred this
219 * callback is called separately for all events.
221 * To specify task callback function in the application using the
222 * SILC_TASK_CALLBACK and SILC_TASK_CALLBACK_GLOBAL macros is
226 typedef void (*SilcTaskCallback)(SilcSchedule schedule, SilcTaskEvent type,
227 uint32 fd, void *context);
231 /****d* silcutil/SilcScheduleAPI/SILC_ALL_TASKS
235 * #define SILC_ALL_TASKS ...
239 * Marks for all tasks in the scheduler. This can be passed to
240 * silc_schedule_task_del function to delete all tasks at once.
244 #define SILC_ALL_TASKS ((SilcTask)1)
247 /****d* silcutil/SilcScheduleAPI/SILC_TASK_CALLBACK
251 * #define SILC_TASK_CALLBACK ...
255 * Generic macro to define task callback functions. This defines a
256 * static function with name `func' as a task callback function.
260 #define SILC_TASK_CALLBACK(func) \
261 static void func(SilcSchedule schedule, SilcTaskEvent type, \
262 uint32 fd, void *context)
265 /****d* silcutil/SilcScheduleAPI/SILC_TASK_CALLBACK_GLOBAL
269 * #define SILC_TASK_CALLBACK_GLOBAL ...
273 * Generic macro to define task callback functions. This defines a
274 * function with name `func' as a task callback function. This
275 * differs from SILC_TASK_CALLBACK in that the defined function is
280 #define SILC_TASK_CALLBACK_GLOBAL(func) \
281 void func(SilcSchedule schedule, SilcTaskEvent type, \
282 uint32 fd, void *context)
287 /****f* silcutil/SilcScheduleAPI/silc_schedule_init
291 * SilcSchedule silc_schedule_init(int max_tasks);
295 * Initializes the scheduler. This returns the scheduler context that
296 * is given as argument usually to all silc_schedule_* functions.
297 * The `max_tasks' indicates the number of maximum tasks that the
298 * scheduler can handle.
301 SilcSchedule silc_schedule_init(int max_tasks);
303 /****f* silcutil/SilcScheduleAPI/silc_schedule_uninit
307 * bool silc_schedule_uninit(SilcSchedule schedule);
311 * Uninitializes the scheduler. This is called when the program is ready
312 * to end. This removes all tasks from the scheduler. Returns FALSE if the
313 * scheduler could not be uninitialized. This happens when the scheduler
314 * is still valid and silc_schedule_stop has not been called.
317 bool silc_schedule_uninit(SilcSchedule schedule);
319 /****f* silcutil/SilcScheduleAPI/silc_schedule_stop
323 * void silc_schedule_stop(SilcSchedule schedule);
327 * Stops the scheduler even if it is not supposed to be stopped yet.
328 * After calling this, one must call silc_schedule_uninit (after the
329 * silc_schedule has returned). After this is called it is guaranteed
330 * that next time the scheduler enters the main loop it will be stopped.
331 * However, untill it enters the main loop it will not detect that
332 * it is stopped for example if this is called from another thread.
335 void silc_schedule_stop(SilcSchedule schedule);
337 /****f* silcutil/SilcScheduleAPI/silc_schedule
341 * void silc_schedule(SilcSchedule schedule);
345 * The SILC scheduler. This is actually the main routine in SILC programs.
346 * When this returns the program is to be ended. Before this function can
347 * be called, one must call silc_schedule_init function.
350 void silc_schedule(SilcSchedule schedule);
352 /****f* silcutil/SilcScheduleAPI/silc_schedule_one
356 * bool silc_schedule_one(SilcSchedule schedule, int block);
360 * Same as the silc_schedule but runs the scheduler only one round
361 * and then returns. This function is handy when the SILC scheduler
362 * is used inside some other external scheduler, for example. If
363 * the `timeout_usecs' is non-negative a timeout will be added to the
364 * scheduler. The function will not return in this timeout unless
365 * some other event occurs.
368 bool silc_schedule_one(SilcSchedule schedule, int timeout_usecs);
370 /****f* silcutil/SilcScheduleAPI/silc_schedule_wakeup
374 * void silc_schedule_wakeup(SilcSchedule schedule);
378 * Wakes up the scheduler. This is used only in multi-threaded
379 * environments where threads may add new tasks or remove old tasks
380 * from the scheduler. This is called to wake up the scheduler in the
381 * main thread so that it detects the changes in the scheduler.
382 * If threads support is not compiled in this function has no effect.
383 * Implementation of this function may be platform specific.
386 void silc_schedule_wakeup(SilcSchedule schedule);
388 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_add
392 * SilcTask silc_schedule_task_add(SilcSchedule schedule, uint32 fd,
393 * SilcTaskCallback callback,
395 * long seconds, long useconds,
397 * SilcTaskPriority priority);
401 * Registers a new task to the scheduler. This same function is used
402 * to register all types of tasks. The `type' argument tells what type
403 * of the task is. Note that when registering non-timeout tasks one
404 * should also pass 0 as timeout, as the timeout will be ignored anyway.
405 * Also, note, that one cannot register timeout task with 0 timeout.
406 * There cannot be zero timeouts, passing zero means no timeout is used
407 * for the task and SILC_TASK_FD is used as default task type in
410 * The `schedule' is the scheduler context. The `fd' is the file
411 * descriptor of the task. On WIN32 systems the `fd' is not actual
412 * file descriptor but some WIN32 event handle. On WIN32 system the `fd'
413 * may be a socket created by the SILC Net API routines, WSAEVENT object
414 * created by Winsock2 network routines or arbitrary WIN32 HANDLE object.
415 * On Unix systems the `fd' is always the real file descriptor.
417 * The `callback' is the task callback that will be called when some
418 * event occurs for this task. The `context' is sent as argument to
419 * the task `callback' function. For timeout tasks the callback is
420 * called after the specified timeout has elapsed.
422 * If the `type' is SILC_TASK_TIMEOUT then `seconds' and `useconds'
423 * may be non-zero. Otherwise they should be zero. The `priority'
424 * indicates the priority of the task.
426 * It is always safe to call this function in any place. New tasks
427 * may be added also in task callbacks, and in multi-threaded environment
428 * in other threads as well.
431 SilcTask silc_schedule_task_add(SilcSchedule schedule, uint32 fd,
432 SilcTaskCallback callback, void *context,
433 long seconds, long useconds,
435 SilcTaskPriority priority);
437 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del
441 * void silc_schedule_task_del(SilcSchedule schedule, SilcTask task);
445 * Deletes the `task' from the scheduler indicated by the `schedule'.
446 * After deleting the task it is guaranteed that the task callback
447 * will not be called. If the `task' is SILC_ALL_TASKS then all
448 * tasks is removed from the scheduler.
450 * It is safe to call this function in any place. Tasks may be removed
451 * in task callbacks (including in the task's own task callback) and
452 * in multi-threaded environment in other threads as well.
455 void silc_schedule_task_del(SilcSchedule schedule, SilcTask task);
457 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del_by_fd
461 * void silc_schedule_task_del_by_fd(SilcSchedule schedule, uint32 fd);
465 * Deletes a task from the scheduler by the specified `fd'.
467 * It is safe to call this function in any place. Tasks may be removed
468 * in task callbacks (including in the task's own task callback) and
469 * in multi-threaded environment in other threads as well.
471 * Note that generic tasks cannot be deleted using this function
472 * since generic tasks does not match any specific fd.
475 void silc_schedule_task_del_by_fd(SilcSchedule schedule, uint32 fd);
477 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del_by_callback
481 * void silc_schedule_task_del_by_callback(SilcSchedule schedule,
482 * SilcTaskCallback callback);
486 * Deletes a task from the scheduler by the specified `callback' task
489 * It is safe to call this function in any place. Tasks may be removed
490 * in task callbacks (including in the task's own task callback) and
491 * in multi-threaded environment in other threads as well.
494 void silc_schedule_task_del_by_callback(SilcSchedule schedule,
495 SilcTaskCallback callback);
497 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del_by_context
501 * void silc_schedule_task_del_by_context(SilcSchedule schedule,
506 * Deletes a task from the scheduler by the specified `context'.
508 * It is safe to call this function in any place. Tasks may be removed
509 * in task callbacks (including in the task's own task callback) and
510 * in multi-threaded environment in other threads as well.
513 void silc_schedule_task_del_by_context(SilcSchedule schedule, void *context);
515 /****f* silcutil/SilcScheduleAPI/silc_schedule_set_listen_fd
519 * void silc_schedule_set_listen_fd(SilcSchedule schedule, uint32 fd,
520 * SilcTaskEvent mask);
524 * Sets a file descriptor `fd' to be listened by the scheduler for
525 * `mask' events. To tell scheduler not to listen anymore for this
526 * file descriptor call the silc_schedule_unset_listen_fd function.
527 * When new task is created with silc_schedule_task_add the event
528 * for the task's fd is initially set to SILC_TASK_READ. If you need
529 * to control the task's fd's events you must call this function
530 * whenever you need to change the events. This can be called multiple
531 * times to change the events.
534 void silc_schedule_set_listen_fd(SilcSchedule schedule, uint32 fd,
537 /****f* silcutil/SilcScheduleAPI/silc_schedule_unset_listen_fd
541 * void silc_schedule_unset_listen_fd(SilcSchedule schedule, uint32 fd);
545 * Tells the scheduler not to listen anymore for the specified
546 * file descriptor `fd'. No events will be detected for the `fd'
547 * after calling this function.
550 void silc_schedule_unset_listen_fd(SilcSchedule schedule, uint32 fd);