sched: Use (0,0) as the timeval for a minimal delay.
[paraslash.git] / sched.h
diff --git a/sched.h b/sched.h
index 36d0769..e018c2f 100644 (file)
--- a/sched.h
+++ b/sched.h
@@ -1,14 +1,14 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file sched.h sched and task structures and exported symbols from sched.c */
+/** \file sched.h Sched and task structures and exported symbols from sched.c. */
 
 
 /**
- * paraslash's scheduler
+ * Paraslash's scheduler.
  *
  * Designed with KISS in mind. It manages two lists of tasks.  The pre_select
  * list contains pointers to functions that are called before calling select()
  * these lists by registering themselves to the scheduler.
  */
 struct sched {
-       /** initial value before any pre_select call */
+       /** Initial value before any pre_select call. */
        struct timeval default_timeout;
-       /** the current timeout for the upcoming select call */
-       struct timeval timeout;
-       /** fds that should be watched for readability */
+       /** The current timeout for the upcoming select call. */
+       struct timeval select_timeout;
+       /** fds that should be watched for readability. */
        fd_set rfds;
-       /** fds that should be watched for writability */
+       /** fds that should be watched for writability. */
        fd_set wfds;
-       /** highest numbered file descriptor in any of the above fd sets */
+       /** Highest numbered file descriptor in any of the above fd sets. */
        int max_fileno;
+       /** If non-NULL, use this function instead of para_select. */
+       int (*select_function)(int, fd_set *, fd_set *, struct timeval *);
 };
 
 /**
- * paraslash's task structure
+ * Paraslash's task structure.
  *
- * before registering a task to the scheduler, the task structure must be
+ * Before registering a task to the scheduler, the task structure must be
  * filled in properly by the caller.
  *
- * 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 happened). In many cases the only possible event is an error or an eof
- * condition and the event handler simply unregisters the task from the
- * scheduler.
+ * If one of these functions sets \a t->error to a negative value, the
+ * task gets unregistered automatically.
  *
- * \sa struct sched
+ * \sa struct sched.
  */
 struct task {
        /**
-        * the pre select hook of \a t
+        * 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 necessary.
         */
        void (*pre_select)(struct sched *s, struct task *t);
        /**
-        * the postselect hook of \a t
+        * The postselect hook of \a t.
         *
-        * evaluate and act upon the results of the previous select call.
+        * Evaluate and act upon the results of the previous select call.
         */
        void (*post_select)(struct sched *s, struct task *t);
        /** Whether this task is in error state. */
        int error;
-       /** position of the task in the pre_select list of the scheduler */
+       /** Position of the task in the pre_select list of the scheduler. */
        struct list_head pre_select_node;
-       /** position of the task in the post_select list of the scheduler */
+       /** Position of the task in the post_select list of the scheduler. */
        struct list_head post_select_node;
-       /** descriptive text and current status of the task */
-       char status[MAXLINE];
+       /** Descriptive text and current status of the task. */
+       char status[255];
 };
 
 /**
@@ -76,7 +75,11 @@ struct task {
 extern struct timeval *now;
 
 void register_task(struct task *t);
-void unregister_task(struct task *t);
 int schedule(struct sched *s);
 char *get_task_list(void);
-int kill_task(char *id);
+void sched_shutdown(void);
+void sched_min_delay(struct sched *s);
+void sched_request_timeout(struct timeval *to, struct sched *s);
+void sched_request_timeout_ms(long unsigned ms, struct sched *s);
+void sched_request_barrier(struct timeval *barrier, struct sched *s);
+void sched_request_barrier_or_min_delay(struct timeval *barrier, struct sched *s);