Browse code

core: fork_*_utimer()'s interval is in microseconds

Sync comments with code and function names

Alex Hermann authored on 10/10/2014 09:06:43
Showing 1 changed files
... ...
@@ -96,19 +96,19 @@ int fork_basic_timer(int child_id, char* desc, int make_sock,
96 96
 }
97 97
 
98 98
 /**
99
- * \brief Forks a separate simple milisecond-sleep() periodic timer
99
+ * \brief Forks a separate simple microsecond-sleep() periodic timer
100 100
  * 
101
- * Forks a very basic periodic timer process, that just ms-sleep()s for 
101
+ * Forks a very basic periodic timer process, that just us-sleep()s for 
102 102
  * the specified interval and then calls the timer function.
103
- * The new "basic timer" process execution start immediately, the ms-sleep()
103
+ * The new "basic timer" process execution start immediately, the us-sleep()
104 104
  * is called first (so the first call to the timer function will happen
105
- * \<interval\> seconds after the call to fork_basic_utimer)
105
+ * \<interval\> microseconds after the call to fork_basic_utimer)
106 106
  * @param child_id  @see fork_process()
107 107
  * @param desc      @see fork_process()
108 108
  * @param make_sock @see fork_process()
109 109
  * @param f         timer function/callback
110 110
  * @param param     parameter passed to the timer function
111
- * @param uinterval  interval in mili-seconds.
111
+ * @param uinterval  interval in micro-seconds.
112 112
  * @return pid of the new process on success, -1 on error
113 113
  * (doesn't return anything in the child process)
114 114
  */
... ...
@@ -244,19 +244,19 @@ int fork_sync_timer(int child_id, char* desc, int make_sock,
244 244
 
245 245
 
246 246
 /**
247
- * \brief Forks a separate simple milisecond-sleep() -&- sync periodic timer
247
+ * \brief Forks a separate simple microsecond-sleep() -&- sync periodic timer
248 248
  *
249
- * Forks a very basic periodic timer process, that just ms-sleep()s for 
249
+ * Forks a very basic periodic timer process, that just us-sleep()s for 
250 250
  * the specified interval and then calls the timer function.
251
- * The new "sync timer" process execution start immediately, the ms-sleep()
251
+ * The new "sync timer" process execution start immediately, the us-sleep()
252 252
  * is called first (so the first call to the timer function will happen
253
- * \<interval\> seconds after the call to fork_basic_utimer)
253
+ * \<interval\> microseconds after the call to fork_basic_utimer)
254 254
  * @param child_id  @see fork_process()
255 255
  * @param desc      @see fork_process()
256 256
  * @param make_sock @see fork_process()
257 257
  * @param f         timer function/callback
258 258
  * @param param     parameter passed to the timer function
259
- * @param uinterval  interval in mili-seconds.
259
+ * @param uinterval  interval in micro-seconds.
260 260
  * @return pid of the new process on success, -1 on error
261 261
  * (doesn't return anything in the child process)
262 262
  */