documented fbpool briefly

[libucw.git] / lib / mainloop.h

diff --git a/lib/mainloop.h b/lib/mainloop.h
index 146c4ca71563e013a00ba189fe921107e482aef2..136d90e04858c1c3b4112c41d8c21dd9c53475d4 100644 (file)
--- a/lib/mainloop.h
+++ b/lib/mainloop.h
@@ -7,9 +7,11 @@
  *     of the GNU Lesser General Public License.
  */
 
+#ifndef _UCW_MAINLOOP_H
+#define _UCW_MAINLOOP_H
+
 #include "lib/clists.h"
 
-typedef s64 timestamp_t;                       /* We measure time in milliseconds */
 extern timestamp_t main_now;                   /* Current time in milliseconds since UNIX epoch */
 extern sh_time_t main_now_seconds;             /* Current time in seconds since the epoch */
 extern uns main_shutdown;
@@ -29,6 +31,8 @@ struct main_timer {
 void timer_add(struct main_timer *tm, timestamp_t expires);    /* Can modify a running timer, too */
 void timer_del(struct main_timer *tm);
 
+void main_get_time(void);                      /* Refresh main_now */
+
 /* Files to poll */
 
 struct main_file {
@@ -60,15 +64,23 @@ void file_del(struct main_file *fi);
 void file_read(struct main_file *fi, void *buf, uns len);
 void file_write(struct main_file *fi, void *buf, uns len);
 void file_set_timeout(struct main_file *fi, timestamp_t expires);
+void file_close_all(void);                     /* Close all known main_file's; frequently used before fork() */
 
 /* Hooks to be called in each iteration of the main loop */
 
 struct main_hook {
   cnode n;
-  int (*handler)(struct main_hook *ho);                /* [*] Hook function; returns 1 if should be called again */
+  int (*handler)(struct main_hook *ho);                /* [*] Hook function; returns HOOK_xxx */
   void *data;                                  /* [*] For use by the handler */
 };
 
+enum main_hook_return {
+  HOOK_IDLE,                                   /* Call again when the main loop becomes idle again */
+  HOOK_RETRY,                                  /* Call again as soon as possible */
+  HOOK_DONE = -1,                              /* Shut down the main loop if all hooks return this value */
+  HOOK_SHUTDOWN = -2                           /* Shut down the main loop immediately */
+};
+
 void hook_add(struct main_hook *ho);
 void hook_del(struct main_hook *ho);
 
@@ -92,3 +104,5 @@ int process_fork(struct main_process *mp);
 void main_init(void);
 void main_loop(void);
 void main_debug(void);
+
+#endif