/*
* Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
*
- * 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
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
*/
-/** \file sched.c Paraslash's task and scheduling functions */
+/** \file sched.h sched and task structures and exported symbols from sched.c */
/**
* paraslash's scheduler
*
- * desinged with KISS in mind. It maintains two lists: The pre_select list
- * and the post_select list. Tasks add hokks to these lists by registering
- * themselves to the scheduler.
+ * desinged with KISS in mind. It manages two lists of tasks. The pre_select
+ * list contains pointers to functions that are called before calling select()
+ * from the main loop. Similarly, \a post_select_list is a list of function
+ * pointers each of which is called after the select call. Tasks add hooks to
+ * these lists by registering themselves to the scheduler.
*/
struct sched {
/** initial value before any pre_select call */
* before registering a task to the scheduler, the task structure must be
* filled in properly by the caller.
*
- * The pre_select or the post_select pointer, but not both may be NULL. Once
- * a task is registered, its pre_select and post_select function gets called
- * from the scheduler's mainloop. The purpose of the pre_select loop is to add
- * file descriptors to the fd sets of the scheduler and to decrease the select
- * timeout if neccessary. The post_select function may then evaluate these fd
- * sets and act upon the results.
-
* If one of these functions return a negative value via \a t->ret the
* (optional) event_handler gets called (it may also be called in case another
* event happend). In many cases the only possible event is an error or an eof
struct task {
/** pointer to the struct this task is embedded in */
void *private_data;
- /** pre_select hook */
+ /**
+ * the pre select hook of \a t
+ *
+ * Its purpose is to add file descriptors to the fd sets of the
+ * scheduler and to decrease the select timeout if neccessary.
+ */
void (*pre_select)(struct sched *s, struct task *t);
- /** post_select hook */
+ /**
+ * the postselect hook of \a t
+ *
+ * evaluate and act upon the results of the previous select call.
+ */
void (*post_select)(struct sched *s, struct task *t);
- /** gets called */
+ /** gets called if pre_select or post_select returned an error */
void (*event_handler)(struct task *t);
/** pre_select() and post_select store their return value here */
int ret;
*/
extern struct timeval *now;
-void *register_task(struct task *t);
+void register_task(struct task *t);
void unregister_task(struct task *t);
int sched(struct sched *s);
-void init_sched(void);
char *get_task_list(void);
int kill_task(char *id);