Async Operation Interface Atomic Operations Interface Base64 Interface Bit Operations Interface Buffer Interface Buffer Stream Interface Buffer Format Interface Condition Variable Interface Config File Interface Directory Interface Dynamic List Interface Shared Object Interface Environment Interface Errno Interface SilcExampleAPI Fd Stream Interface File Util Interface Finite State Machine GetOpt Interface Global Variable Interface Hash Table Interface HTTP PHP Translator HTTP Server Interface List Interface Local Network Stream Interface Logging Interface Memory Interface MIME Interface Mutex Interface Network Interface Random Number Interface Regex Interface Runtime Toolkit Interface Scheduler Interface Snprintf Interface Socket Stream Interface Memory Pool Interface Stream Interface Stringprep Interface String Utilities Thread Interface Thread Queue Interface Time Interface Timer Interface Binary Search Tree Interface Types and Definitions UTF-8 Interface Misc Utilities XML Interface

Scheduler Interface

DESCRIPTION

The SILC Scheduler is the heart of any application. The scheduler provides the application's main loop that can handle incoming data, outgoing data, timeouts and dispatch different kind of tasks.

The SILC Scheduler supports file descriptor based tasks, timeout tasks and asynchronous event tasks. File descriptor tasks are tasks that perform some operation over the specified file descriptor or socket. The timeout tasks are timeouts that are executed after the specified timeout has elapsed. Asynchronous event tasks are tasks that can be connected to and signalled to deliver messages and data to all connected entities.

The SILC Scheduler is designed to be the sole main loop of the application so that the application does not need any other main loop. However, SILC Scheduler does support running the scheduler only one iteration, so that the scheduler does not block, and thus providing a possiblity that some external main loop is run over the SILC Scheduler.

On Windows systems the SILC Scheduler is too designed to work as the main loop of the GUI application. It can handle all Windows messages and it dispatches them from the scheduler, and thus makes it possible to create GUI applications. The scheduler can also handle all kinds of WIN32 handles, this includes sockets created by the SILC Net API routines, WSAEVENT handle objects created by Winsock2 routines and arbitrary WIN32 HANDLE objects.

On Symbian OS the SILC Scheduler can work in cooperation with the Active Scheduler. However, the Symbian OS Active Scheduler must be started before starting SILC Scheduler.

The SILC Scheduler supports multi-threads. Each thread can have their own scheduler. Tasks registered to a scheduler are always executed in that same thread. However, tasks may be added to and removed from any scheduler from any thread. Each scheduler in worker thread should be a child scheduler created from the main thread's parent scheduler.

TABLE OF CONTENTS

• SilcSchedule
• SilcTask
• SilcTaskEvent
• SilcTaskCallback
• SilcTaskEventCallback
• SilcTaskNotifyCb
• SILC_ALL_TASKS
• SILC_TASK_CALLBACK
• SILC_TASK_EVENT_CALLBACK
• silc_schedule_init
• silc_schedule_uninit
• silc_schedule_stop
• silc_schedule
• silc_schedule_one
• silc_schedule_wakeup
• silc_schedule_get_parent
• silc_schedule_get_context
• silc_schedule_get_stack
• silc_schedule_set_notify
• silc_schedule_set_global
• silc_schedule_get_global
• silc_schedule_task_add_fd
• silc_schedule_task_add_timeout
• silc_schedule_task_add_signal
• silc_schedule_task_add_event
• silc_schedule_task_del
• silc_schedule_task_del_by_fd
• silc_schedule_task_del_by_callback
• silc_schedule_task_del_by_context
• silc_schedule_task_del_by_all
• silc_schedule_task_del_event
• silc_schedule_set_listen_fd
• silc_schedule_get_fd_events
• silc_schedule_unset_listen_fd
• silc_schedule_event_connect
• silc_schedule_event_disconnect
• silc_schedule_event_signal