5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 1998 - 2007 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
20 /****h* silcutil/SILC Schedule Interface
24 * The SILC Scheduler is the heart of any application. The scheduler provides
25 * the application's main loop that can handle incoming data, outgoing data,
26 * timeouts and dispatch different kind of tasks.
28 * The SILC Scheduler supports file descriptor based tasks and timeout tasks.
29 * File descriptor tasks are tasks that perform some operation over the
30 * specified file descriptor. These include network connections, for example.
31 * The timeout tasks are timeouts that are executed after the specified
32 * timeout has elapsed.
34 * The SILC Scheduler is designed to be the sole main loop of the application
35 * so that the application does not need any other main loop. However,
36 * SILC Scheduler does support running the scheduler only once, so that the
37 * scheduler does not block, and thus providing a possiblity that some
38 * external main loop is run over the SILC Scheduler.
40 * Typical application first initializes the scheduler and then registers
41 * the very first tasks to the scheduler and then run the scheduler. After
42 * the scheduler's run function returns the application is considered to be
45 * On WIN32 systems the SILC Scheduler is too designed to work as the main
46 * loop of the GUI application. It can handle all Windows messages and
47 * it dispatches them from the scheduler, and thus makes it possible to
48 * create GUI applications. The scheduler can also handle all kinds of
49 * WIN32 handles, this includes sockets created by the SILC Net API routines,
50 * WSAEVENT handle objects created by Winsock2 routines and arbitrary
51 * WIN32 HANDLE objects.
53 * The SILC Scheduler supports multi-threads as well. The actual scheduler
54 * must be run in single-thread but other threads may register new tasks
55 * and unregister old tasks. However, it is enforced that the actual
56 * task is always run in the main thread. The scheduler is context based
57 * which makes it possible to allocate several schedulers for one application.
58 * Since the scheduler must be run in single-thread, a multi-threaded
59 * application could be created by allocating own scheduler for each of the
64 #ifndef SILCSCHEDULE_H
65 #define SILCSCHEDULE_H
67 /****s* silcutil/SilcScheduleAPI/SilcSchedule
71 * typedef struct SilcScheduleStruct *SilcSchedule;
75 * This context is the actual Scheduler and is allocated by
76 * the silc_schedule_init funtion. The context is given as argument
77 * to all silc_schedule_* functions. It must be freed by the
78 * silc_schedule_uninit function.
81 typedef struct SilcScheduleStruct *SilcSchedule;
83 /****s* silcutil/SilcScheduleAPI/SilcTask
87 * typedef struct SilcTaskStruct *SilcTask;
91 * This object represents one task in the scheduler. It is allocated
92 * by the silc_schedule_task_add function and freed by one of the
93 * silc_schedule_task_del* functions.
96 typedef struct SilcTaskStruct *SilcTask;
98 /****d* silcutil/SilcScheduleAPI/SilcTaskEvent
102 * typedef enum { ... } SilcTaskEvent;
106 * SILC Task event types. The event type indicates the occurred
107 * event of the task. This type will be given as argument to the
108 * SilcTaskCallback function to indicate the event for the caller.
109 * The SILC_TASK_READ and SILC_TASK_WRITE may be set by the caller
110 * of the silc_schedule_set_listen_fd, if the caller needs to control
111 * the events for the task. The SILC_TASK_EXPIRE is set always only
112 * by the scheduler when timeout expires for timeout task. The
113 * SILC_TASK_INTERRUPT is set for signal callback.
118 SILC_TASK_READ = 0x0001, /* Reading */
119 SILC_TASK_WRITE = 0x0002, /* Writing */
120 SILC_TASK_EXPIRE = 0x0004, /* Timeout */
121 SILC_TASK_INTERRUPT = 0x0008, /* Signal */
125 /****f* silcutil/SilcScheduleAPI/SilcTaskCallback
129 * typedef void (*SilcTaskCallback)(SilcSchedule schedule,
131 * SilcTaskEvent type, SilcUInt32 fd,
136 * The task callback function. This function will be called by the
137 * scheduler when some event of the task is performed. For example,
138 * when data is available from the connection this will be called.
140 * The `schedule' is the scheduler context, the `type' is the indicated
141 * event, the `fd' is the file descriptor of the task and the `context'
142 * is a caller specified context. If multiple events occurred this
143 * callback is called separately for all events. The `app_context'
144 * is application specific context that was given as argument to the
145 * silc_schedule_init function. If the task is timeout task then `fd'
148 * To specify task callback function in the application using the
149 * SILC_TASK_CALLBACK macro is recommended.
151 * The callback should not perform lenghty or blocking operations as
152 * this would also block all other waiting tasks. The task callback
153 * should either handle the operation fast or issue an asynchronous
154 * call (like to register 0 timeout task) to handle it later.
157 typedef void (*SilcTaskCallback)(SilcSchedule schedule, void *app_context,
158 SilcTaskEvent type, SilcUInt32 fd,
161 /****f* silcutil/SilcScheduleAPI/SilcTaskNotifyCb
165 * typedef void (*SilcTaskNotifyCb)(SilcSchedule schedule,
166 * SilcBool added, SilcTask task,
167 * SilcBool fd_task, SilcUInt32 fd,
168 * SilcTaskEvent event,
169 * long seconds, long useconds,
174 * Task notify callback. Callback of this type can be set to scheduler
175 * by calling silc_schedule_set_notify and will be called whenever new
176 * task is added or old task is removed. If `added' is TRUE then `task'
177 * is added to scheduler. If `added' is FALSE then `task' will be removed
178 * from the scheduler. If `fd_task' is TRUE the `task' is file descriptor
179 * task and has `fd' is its file descriptor. If `fd_task' is FALSE then
180 * the task is timeout task and `seconds' and `useconds' specify the
181 * timeout. The `context' is the context given to silc_schedule_set_notify.
185 * The `schedule' is locked while this callback is called. This means that
186 * new tasks cannot be added or removed inside this callback.
188 * When timeout task expires this callback is not called. This is called
189 * only when task is explicitly deleted from the scheduler. Note that,
190 * when timeout task expires it is removed from the scheduler and `task'
191 * will become invalid.
193 * If fd task changes its events, this will be called as if it was a new
194 * task with different `event' mask.
197 typedef void (*SilcTaskNotifyCb)(SilcSchedule schedule,
198 SilcBool added, SilcTask task,
199 SilcBool fd_task, SilcUInt32 fd,
201 long seconds, long useconds,
206 /****d* silcutil/SilcScheduleAPI/SILC_ALL_TASKS
210 * #define SILC_ALL_TASKS ...
214 * Marks for all tasks in the scheduler. This can be passed to
215 * silc_schedule_task_del function to delete all tasks at once.
219 #define SILC_ALL_TASKS ((SilcTask)1)
222 /****d* silcutil/SilcScheduleAPI/SILC_TASK_CALLBACK
226 * #define SILC_TASK_CALLBACK ...
230 * Generic macro to declare task callback functions. This defines a
231 * function with name `func' as a task callback function.
235 #define SILC_TASK_CALLBACK(func) \
236 void func(SilcSchedule schedule, void *app_context, SilcTaskEvent type, \
237 SilcUInt32 fd, void *context)
242 #include "silcschedule_i.h"
244 /****f* silcutil/SilcScheduleAPI/silc_schedule_init
248 * SilcSchedule silc_schedule_init(int max_tasks, void *app_context,
253 * Initializes the scheduler. This returns the scheduler context that
254 * is given as argument usually to all silc_schedule_* functions.
255 * The `app_context' is application specific context that is delivered
256 * to all task callbacks. The caller must free that context. The
257 * 'app_context' can be for example the application itself.
259 * The `max_tasks' is the maximum number of file descriptor and socket
260 * tasks in the scheduler. Set value to 0 to use default. Operating
261 * system will enforce the final limit. On some operating systems the
262 * limit can be significantly increased when this function is called in
263 * priviliged mode (as super user).
265 * If `stack' is non-NULL all memory allocation for the scheduler is done
266 * from the `stack'. Scheduler's stack may be retrieved by calling
267 * silc_schedule_get_stack. A stack is created for scheduler always even
268 * if `stack' is NULL. If it is non-NULL the created stack is a child
269 * stack using `stack' as its parent. This means that memory allocated
270 * by the scheduler will be returned to the `stack' when scheduler is
274 SilcSchedule silc_schedule_init(int max_tasks, void *app_context,
277 /****f* silcutil/SilcScheduleAPI/silc_schedule_uninit
281 * SilcBool silc_schedule_uninit(SilcSchedule schedule);
285 * Uninitializes the scheduler. This is called when the program is ready
286 * to end. This removes all tasks from the scheduler. Returns FALSE if the
287 * scheduler could not be uninitialized. This happens when the scheduler
288 * is still valid and silc_schedule_stop has not been called.
290 * If SilcStack was given to silc_schedule_init all memory allocated
291 * during the life time of the scheduler will be returned back to the
295 SilcBool silc_schedule_uninit(SilcSchedule schedule);
297 /****f* silcutil/SilcScheduleAPI/silc_schedule_stop
301 * void silc_schedule_stop(SilcSchedule schedule);
305 * Stops the scheduler even if it is not supposed to be stopped yet.
306 * After calling this, one must call silc_schedule_uninit (after the
307 * silc_schedule has returned). After this is called it is guaranteed
308 * that next time the scheduler enters the main loop it will be stopped.
309 * However, untill it enters the main loop it will not detect that
310 * it is stopped for example if this is called from another thread.
313 void silc_schedule_stop(SilcSchedule schedule);
315 /****f* silcutil/SilcScheduleAPI/silc_schedule
319 * void silc_schedule(SilcSchedule schedule);
323 * The SILC scheduler. The program will run inside this function.
324 * When this returns the program is to be ended. Before this function
325 * can be called, one must call silc_schedule_init function.
329 * On Windows this will block the calling thread but will continue
330 * to dispatch window messages, and thus can be used as the main loop
333 * On Symbian this will block the calling thread. The Symbian Active
334 * Scheduler must be running before calling this function.
337 void silc_schedule(SilcSchedule schedule);
339 /****f* silcutil/SilcScheduleAPI/silc_schedule_one
343 * SilcBool silc_schedule_one(SilcSchedule schedule, int timeout_usecs);
347 * Same as the silc_schedule but runs the scheduler only one round
348 * and then returns. This function is handy when the SILC scheduler
349 * is used inside some other external scheduler, for example. If
350 * the `timeout_usecs' is non-negative a timeout will be added to the
351 * scheduler. The function will not return in this timeout unless
352 * some other event occurs.
354 * Typically this would be called from a timeout or idle task
355 * periodically (typically from 5-50 ms) to schedule SILC tasks. In
356 * this case the `timeout_usecs' is usually 0 to make the function
357 * return immediately.
360 SilcBool silc_schedule_one(SilcSchedule schedule, int timeout_usecs);
362 /****f* silcutil/SilcScheduleAPI/silc_schedule_wakeup
366 * void silc_schedule_wakeup(SilcSchedule schedule);
370 * Wakes up the scheduler. This is may be used in multi-threaded
371 * environments where threads may add new tasks or remove old tasks
372 * from the scheduler. This is called to wake up the scheduler in the
373 * main thread so that it detects the changes in the scheduler.
374 * If threads support is not compiled in this function has no effect.
377 void silc_schedule_wakeup(SilcSchedule schedule);
379 /****f* silcutil/SilcScheduleAPI/silc_schedule_get_context
383 * void *silc_schedule_get_context(SilcSchedule schedule);
387 * Returns the application specific context that was saved into the
388 * scheduler in silc_schedule_init function. The context is also
389 * returned to application in the SilcTaskCallback, but this function
390 * may be used to get it as well if needed.
393 void *silc_schedule_get_context(SilcSchedule schedule);
395 /****f* silcutil/SilcScheduleAPI/silc_schedule_get_stack
399 * SilcStack silc_schedule_get_stack(SilcSchedule schedule);
403 * Returns the stack of the `schedule'. If it is used to make memory
404 * allocations outside the scheduler, it is recommended that a new
405 * child stack is created by using the returned stack as a parent and
406 * using the child stack to make the memory allocations.
409 SilcStack silc_schedule_get_stack(SilcSchedule schedule);
411 /****f* silcutil/SilcScheduleAPI/silc_schedule_set_notify
415 * void silc_schedule_set_notify(SilcSchedule schedule,
416 * SilcTaskNotifyCb notify, void *context);
420 * Set notify callback to scheduler. The `notify' will be called whenever
421 * task is added to or deleted from scheduler.
424 void silc_schedule_set_notify(SilcSchedule schedule,
425 SilcTaskNotifyCb notify, void *context);
427 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_add_fd
432 * silc_schedule_task_add_fd(SilcSchedule schedule, SilcUInt32 fd,
433 * SilcTaskCallback callback, void *context);
437 * Add file descriptor task to scheduler. The `fd' may be either real
438 * file descriptor, socket or on some platforms an opaque file descriptor
439 * handle. To receive events for the file descriptor set the correct
440 * request events with silc_schedule_set_listen_fd function.
442 * The task will be initially set for SILC_TASK_READ events. Setting that
443 * event immediately after this call returns is not necessary.
445 * This returns the new task or NULL on error. If a task with `fd' has
446 * already been added this will return the existing task pointer.
449 #define silc_schedule_task_add_fd(schedule, fd, callback, context) \
450 silc_schedule_task_add(schedule, fd, callback, context, 0, 0, SILC_TASK_FD)
452 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_add_timeout
457 * silc_schedule_task_add_timeout(SilcSchedule schedule,
458 * SilcTaskCallback callback, void *context,
459 * long seconds, long useconds);
463 * Add timeout task to scheduler. The `callback' will be called once
464 * the specified timeout has elapsed. The task will be removed from the
465 * scheduler automatically once the task expires. The event returned
466 * to the `callback' is SILC_TASK_EXPIRE. A task added with zero (0)
467 * timeout will be executed immediately next time tasks are scheduled.
470 #define silc_schedule_task_add_timeout(schedule, callback, context, s, u) \
471 silc_schedule_task_add(schedule, 0, callback, context, s, u, \
474 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_add_signal
479 * silc_schedule_task_add_signal(SilcSchedule schedule, int signal,
480 * SilcTaskCallback callback, void *context);
484 * Add platform specific process signal handler to scheduler. On Unix
485 * systems the `signal' is one of the signal specified in signal(7). On
486 * other platforms this function may not be available at all, and has no
487 * effect when called. The event delivered to the `callback' is
488 * SILC_TASK_INTERRUPT.
492 * One signal may be registered only one callback. Adding second callback
493 * for signal that already has one will fail.
495 * This function always returns NULL. To remove signal from scheduler by
496 * the signal call silc_schedule_task_del_by_fd.
499 #define silc_schedule_task_add_signal(schedule, sig, callback, context) \
500 silc_schedule_task_add(schedule, sig, callback, context, 0, 0, \
503 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del
507 * SilcBool silc_schedule_task_del(SilcSchedule schedule, SilcTask task);
511 * Deletes the `task' from the scheduler indicated by the `schedule'.
512 * After deleting the task it is guaranteed that the task callback
513 * will not be called. If the `task' is SILC_ALL_TASKS then all
514 * tasks is removed from the scheduler. Returns always TRUE.
516 * It is safe to call this function in any place. Tasks may be removed
517 * in task callbacks (including in the task's own task callback) and
518 * in multi-threaded environment in other threads as well.
521 SilcBool silc_schedule_task_del(SilcSchedule schedule, SilcTask task);
523 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del_by_fd
527 * SilcBool silc_schedule_task_del_by_fd(SilcSchedule schedule,
532 * Deletes a task from the scheduler by the specified `fd'. Returns
533 * FALSE if such fd task does not exist.
535 * It is safe to call this function in any place. Tasks may be removed
536 * in task callbacks (including in the task's own task callback) and
537 * in multi-threaded environment in other threads as well.
540 SilcBool silc_schedule_task_del_by_fd(SilcSchedule schedule, SilcUInt32 fd);
542 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del_by_callback
546 * SilcBool silc_schedule_task_del_by_callback(SilcSchedule schedule,
547 * SilcTaskCallback callback);
551 * Deletes a task from the scheduler by the specified `callback' task
552 * callback function. Returns FALSE if such task with such callback
555 * It is safe to call this function in any place. Tasks may be removed
556 * in task callbacks (including in the task's own task callback) and
557 * in multi-threaded environment in other threads as well.
560 SilcBool silc_schedule_task_del_by_callback(SilcSchedule schedule,
561 SilcTaskCallback callback);
563 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del_by_context
567 * SilcBool silc_schedule_task_del_by_context(SilcSchedule schedule,
572 * Deletes a task from the scheduler by the specified `context'. Returns
573 * FALSE if such task with such context does not exist.
575 * It is safe to call this function in any place. Tasks may be removed
576 * in task callbacks (including in the task's own task callback) and
577 * in multi-threaded environment in other threads as well.
580 SilcBool silc_schedule_task_del_by_context(SilcSchedule schedule,
583 /****f* silcutil/SilcScheduleAPI/silc_schedule_task_del_by_all
587 * SilcBool silc_schedule_task_del_by_all(SilcSchedule schedule, int fd,
588 * SilcTaskCallback callback,
593 * Deletes a task from the scheduler by the specified `fd', `callback'
594 * and `context'. Returns FALSE if such task does not exist.
596 * It is safe to call this function in any place. Tasks may be removed
597 * in task callbacks (including in the task's own task callback) and
598 * in multi-threaded environment in other threads as well.
601 SilcBool silc_schedule_task_del_by_all(SilcSchedule schedule, int fd,
602 SilcTaskCallback callback,
605 /****f* silcutil/SilcScheduleAPI/silc_schedule_set_listen_fd
609 * SilcBool silc_schedule_set_listen_fd(SilcSchedule schedule,
611 * SilcTaskEvent mask,
612 * SilcBool send_events);
616 * Sets a file descriptor `fd' to be listened by the scheduler for
617 * `mask' events. To tell scheduler not to listen anymore for this
618 * file descriptor call the silc_schedule_unset_listen_fd function.
619 * When new task is created with silc_schedule_task_add the event
620 * for the task's fd is initially set to SILC_TASK_READ. If you need
621 * to control the task's fd's events you must call this function
622 * whenever you need to change the events. This can be called multiple
623 * times to change the events.
625 * If the `send_events' is TRUE then this function sends the events
626 * in `mask' to the application. If FALSE then they are sent only
627 * after the event occurs in reality. In normal cases the `send_events'
630 * Returns FALSE if the operation could not performed and TRUE if it
634 SilcBool silc_schedule_set_listen_fd(SilcSchedule schedule, SilcUInt32 fd,
635 SilcTaskEvent mask, SilcBool send_events);
637 /****f* silcutil/SilcScheduleAPI/silc_schedule_get_fd_events
641 * SilcTaskEvent silc_schedule_get_fd_events(SilcSchedule schedule,
646 * Returns the file descriptor `fd' current requested events mask,
650 SilcTaskEvent silc_schedule_get_fd_events(SilcSchedule schedule,
653 /****f* silcutil/SilcScheduleAPI/silc_schedule_unset_listen_fd
657 * void silc_schedule_unset_listen_fd(SilcSchedule schedule, SilcUInt32 fd);
661 * Tells the scheduler not to listen anymore for the specified
662 * file descriptor `fd'. No events will be detected for the `fd'
663 * after calling this function.
666 void silc_schedule_unset_listen_fd(SilcSchedule schedule, SilcUInt32 fd);