Fixed note about res_alloc() with no resource pool active

[libucw.git] / ucw / mainloop.h

diff --git a/ucw/mainloop.h b/ucw/mainloop.h
index 336439beed7ed0cc881d628d581dd34c51e9f601..579876cc80a68a868b2dcfa70232681954aafa88 100644 (file)
--- a/ucw/mainloop.h
+++ b/ucw/mainloop.h
@@ -10,8 +10,8 @@
 #ifndef _UCW_MAINLOOP_H
 #define _UCW_MAINLOOP_H
 
-#include "ucw/clists.h"
-#include "ucw/process.h"
+#include <ucw/clists.h>
+#include <ucw/process.h>
 
 #include <signal.h>
 
@@ -25,8 +25,7 @@
 
 /** The main loop context **/
 struct main_context {
-  timestamp_t now;                     /* [*] Current time in milliseconds since the UNIX epoch. See main_get_time(). */
-  ucw_time_t now_seconds;              /* [*] Current time in seconds since the epoch. */
+  timestamp_t now;                     /* [*] Current time in milliseconds since an unknown epoch. See main_get_time(). */
   timestamp_t idle_time;               /* [*] Total time in milliseconds spent by waiting for events. */
   uns shutdown;                                /* [*] Setting this to nonzero forces the main_loop() function to terminate. */
   clist file_list;
@@ -112,7 +111,7 @@ static inline void main_shut_down(void)
 
 /**
  * Show the current state of a given context (use @main_debug() for the current context).
- * Available only if LibUCW has been compiled with `CONFIG_DEBUG`.
+ * Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`.
  **/
 void main_debug_context(struct main_context *m);
 
@@ -144,12 +143,6 @@ static inline timestamp_t main_get_now(void)
   return main_current()->now;
 }
 
-/** An analog of @main_get_now() returning the number of seconds since the system epoch. **/
-static inline ucw_time_t main_get_now_seconds(void)
-{
-  return main_current()->now_seconds;
-}
-
 /**
  * This is a description of a timer.
  * You define the handler function and possibly user-defined data you wish
@@ -169,7 +162,8 @@ struct main_timer {
  * timer. It is permitted (and usual) to call this function from the
  * timer's handler itself if you want the timer to trigger again.
  *
- * The @expire parameter is absolute, use @timer_add_rel() for a relative version.
+ * The @expire parameter is absolute (in the same time scale as @main_get_now()),
+ * use @timer_add_rel() for a relative version.
  **/
 void timer_add(struct main_timer *tm, timestamp_t expires);
 
@@ -197,7 +191,7 @@ static inline int timer_is_active(struct main_timer *tm)
  **/
 void main_get_time(void);
 
-/** Show current state of a timer. Available only if LibUCW has been compiled with `CONFIG_DEBUG`. **/
+/** Show current state of a timer. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/
 void timer_debug(struct main_timer *tm);
 
 /***
@@ -266,7 +260,7 @@ static inline int hook_is_active(struct main_hook *ho)
   return clist_is_linked(&ho->n);
 }
 
-/** Show current state of a hook. Available only if LibUCW has been compiled with `CONFIG_DEBUG`. **/
+/** Show current state of a hook. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/
 void hook_debug(struct main_hook *ho);
 
 
@@ -353,7 +347,7 @@ static inline int file_is_active(struct main_file *fi)
   return clist_is_linked(&fi->n);
 }
 
-/** Show current state of a file. Available only if LibUCW has been compiled with `CONFIG_DEBUG`. **/
+/** Show current state of a file. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/
 void file_debug(struct main_file *fi);
 
 /***
@@ -540,7 +534,7 @@ void rec_io_start_read(struct main_rec_io *rio);
 void rec_io_stop_read(struct main_rec_io *rio);
 
 /** Analogous to @block_io_set_timeout(). **/
-void rec_io_set_timeout(struct main_rec_io *bio, timestamp_t expires_delta);
+void rec_io_set_timeout(struct main_rec_io *rio, timestamp_t expires_delta);
 
 void rec_io_write(struct main_rec_io *rio, void *data, uns len);
 
@@ -638,7 +632,7 @@ static inline int process_is_active(struct main_process *mp)
   return clist_is_linked(&mp->n);
 }
 
-/** Show current state of a process. Available only if LibUCW has been compiled with `CONFIG_DEBUG`. **/
+/** Show current state of a process. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/
 void process_debug(struct main_process *pr);
 
 /***
@@ -687,7 +681,7 @@ static inline int signal_is_active(struct main_signal *ms)
   return clist_is_linked(&ms->n);
 }
 
-/** Show current state of a signal catcher. Available only if LibUCW has been compiled with `CONFIG_DEBUG`. **/
+/** Show current state of a signal catcher. Available only if LibUCW has been compiled with `CONFIG_UCW_DEBUG`. **/
 void signal_debug(struct main_signal *sg);
 
 #endif