# timer.h

Go to the documentation of this file.

    00001 /* Copyright (c) 2007 Axel Wachtler
    00002    All rights reserved.
    00003
    00004    Redistribution and use in source and binary forms, with or without
    00005    modification, are permitted provided that the following conditions
    00006    are met:
    00007
    00008    * Redistributions of source code must retain the above copyright
    00009      notice, this list of conditions and the following disclaimer.
    00010    * Redistributions in binary form must reproduce the above copyright
    00011      notice, this list of conditions and the following disclaimer in the
    00012      documentation and/or other materials provided with the distribution.
    00013    * Neither the name of the authors nor the names of its contributors
    00014      may be used to endorse or promote products derived from this software
    00015      without specific prior written permission.
    00016
    00017    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    00018    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    00019    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    00020    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    00021    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    00022    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    00023    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    00024    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    00025    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    00026    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    00027    POSSIBILITY OF SUCH DAMAGE. */
    00028
    00029 /*$Id$ */
    00038 #ifndef TIMER_H
    00039 #define TIMER_H
    00040 /* === includes ============================================================ */
    00041 #include <stdint.h>
    00042
    00043 /* === macros ============================================================== */
    00048 #define MSEC(v) ((time_t)(v / (1.0e3 * TIMER_TICK)))
    00049
    00050 #define USEC(v) ((time_t)(v / (1.0e6 * TIMER_TICK)))
    00051
    00052
    00053
    00054 /* === types =============================================================== */
    00055
    00056 /* === prototypes ========================================================== */
    00057 #ifdef __cplusplus
    00058 extern "C" {
    00059 #endif
    00060
    00064 typedef uint32_t time_t;
    00065
    00066
    00070 typedef struct time_stamp_tag
    00071 {
    00072     time_t  time_sec;
    00073     time_t  time_usec;
    00074 } time_stamp_t;
    00075
    00076
    00080 typedef uint32_t timer_arg_t;
    00081
    00086 typedef uint16_t timer_hdl_t;
    00087
    00095 typedef time_t (timer_handler_t)(timer_arg_t p);
    00096
    00098 #define NONE_TIMER (0)
    00099
    00100 /* === Prototypes ================================ */
    00104 void timer_init(void);
    00105
    00124 timer_hdl_t timer_start(timer_handler_t *thfunc, time_t duration,
    00125                         timer_arg_t arg);
    00126
    00127
    00143 timer_hdl_t timer_restart(timer_hdl_t th, time_t duration);
    00144
    00155 timer_hdl_t timer_stop(timer_hdl_t th);
    00156
    00160 time_t timer_systime(void);
    00161
    00162
    00166 void timer_set_systime(time_t sec);
    00167
    00177 void timer_get_tstamp(time_stamp_t *ts);
    00178
    00179 #ifdef __cplusplus
    00180 } /* extern "C" */
    00181 #endif
    00182
    00185 #endif /* TIMER_H */