timer.h File Reference

#include <time.h>
#include "trbase.h"

Include dependency graph for timer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	TR_timerSetNan(timer, val)   (TR_timerSet((timer), TR_TBASE_NAN, (val)))
#define	TR_timerSetMic(timer, val)   (TR_timerSet((timer), TR_TBASE_MIC, (val)))
#define	TR_timerSetMil(timer, val)   (TR_timerSet((timer), TR_TBASE_MIL, (val)))
#define	TR_timerSetSec(timer, val)   (TR_timerSet((timer), TR_TBASE_SEC, (val)))

Enumerations
enum	TR_eTimeoutBase { TR_TBASE_NAN = 0, TR_TBASE_MIC, TR_TBASE_MIL, TR_TBASE_SEC }

Functions
	TR_CLASS (TR_Timer)
	TR_INSTANCE_INIT (TR_Timer)
	TR_CLASSVARS_DECL (TR_Timer)
void	TR_timerSet (TR_Timer, TR_eTimeoutBase, unsigned long)
unsigned long	TR_timerGet (TR_Timer, unsigned long *)

Detailed Description

A timer with second, millisec, microsec or nanosec granularity.

Author

Georg Hopp

Copyright

Copyright © 2014 Georg Hopp

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file timer.h.

Macro Definition Documentation

#define TR_timerSetMic	(		timer,
			val
	)		(TR_timerSet((timer), TR_TBASE_MIC, (val)))

Definition at line 64 of file timer.h.

#define TR_timerSetMil	(		timer,
			val
	)		(TR_timerSet((timer), TR_TBASE_MIL, (val)))

Definition at line 65 of file timer.h.

#define TR_timerSetNan	(		timer,
			val
	)		(TR_timerSet((timer), TR_TBASE_NAN, (val)))

Definition at line 63 of file timer.h.

#define TR_timerSetSec	(		timer,
			val
	)		(TR_timerSet((timer), TR_TBASE_SEC, (val)))

Definition at line 66 of file timer.h.

Enumeration Type Documentation

enum TR_eTimeoutBase

Enumerator
TR_TBASE_NAN
TR_TBASE_MIC
TR_TBASE_MIL
TR_TBASE_SEC

Definition at line 42 of file timer.h.

             {
    TR_TBASE_NAN = 0,
    TR_TBASE_MIC,
    TR_TBASE_MIL,
    TR_TBASE_SEC
} TR_eTimeoutBase;

Function Documentation

TR_CLASS

(

TR_Timer

)

Definition at line 49 of file timer.h.

                   {
    int             sec;
    int             nsec;
    TR_eTimeoutBase base;
    unsigned long   timeout;
};

TR_CLASSVARS_DECL

(

TR_Timer

)

Definition at line 57 of file timer.h.

{};

TR_INSTANCE_INIT

(

TR_Timer

)

unsigned long TR_timerGet	(	TR_Timer	,
		unsigned long *
	)

Definition at line 31 of file timer_get.c.

References TR_TBASE_MIC, TR_TBASE_MIL, TR_TBASE_NAN, and TR_TBASE_SEC.

{
    struct timespec    now;
    unsigned long long elapsed;
    unsigned long      sec_factor;
    long               nan_factor;
    unsigned long      _missed;

    clock_gettime(CLOCK_REALTIME, &now);

    switch (this->base) {
        case TR_TBASE_NAN:
            sec_factor = 1000 * 1000 * 1000;
            break;
        case TR_TBASE_MIC:
            sec_factor = 1000 * 1000;
            break;
        default:
        case TR_TBASE_MIL:
            sec_factor = 1000;
            break;
        case TR_TBASE_SEC:
            sec_factor = 1;
            break;
    }

    nan_factor = 1000 * 1000 * 1000 / sec_factor;
    elapsed = (now.tv_sec - this->sec) * sec_factor
        + (now.tv_nsec - this->nsec) / nan_factor;

    _missed = elapsed / this->timeout;
    if (_missed) {
        this->sec  += _missed * this->timeout * sec_factor / nan_factor;
        this->nsec += _missed * this->timeout * sec_factor % nan_factor;
        if (missed) *missed = _missed;
    } else {
        if (missed) *missed = 0;
    }

    return this->timeout - (elapsed % this->timeout);
}

void TR_timerSet	(	TR_Timer	,
		TR_eTimeoutBase	,
		unsigned	long
	)

Definition at line 30 of file timer_set.c.

Referenced by timerCtor().

{
    struct timespec set;
    clock_gettime(CLOCK_REALTIME, &set);
    this->sec     = set.tv_sec;
    this->nsec    = set.tv_nsec;
    this->base    = base;
    this->timeout = timeout;
}

Here is the caller graph for this function: