Timer de temporisation

Detailed Description

Ce module fournit les fonctions de temporisation.

Functions
bool	bTimerIsActive (const xTimer *tm)
	Teste si un timer est en marche. More...
bool	bTimerIsSingleShot (const xTimer *tm)
	Teste si single shot actif. More...
bool	bTimerIsTimeout (xTimer *tm)
	Teste la fin d'un timer single shot. More...
int	iTimerDelete (xTimer *tm)
	Suppression d'un timer. More...
int	iTimerSetCallback (xTimer *tm, iTimerCallback callback, void *udata)
	Installation d'un gestionnaire de timeout. More...
int	iTimerStart (xTimer *tm)
	Démarre un timer. More...
int	iTimerStop (xTimer *tm)
	Arrête un timer. More...
int	iTimerUnsetCallback (xTimer *tm)
	Retire un gestionnaire de timeout. More...
int	iTimerWait (xTimer *tm)
	Attente d'un timer. More...
long	lTimerInterval (const xTimer *tm)
	Lecture de l'intervalle d'un timer. More...
long	lTimerRemainingTime (const xTimer *tm)
	Renvoie la valeur restante de la minuterie en millisecondes. More...
void *	pvTimerUserData (xTimer *tm)
	Données utilisateur d'un timer. More...
void	vTimerSetInterval (xTimer *tm, long msec)
	Modifie l'intervalle d'un timer. More...
void	vTimerSetSingleShot (xTimer *tm, bool singleShot)
	Valide/Invalide le single shot. More...
xTimer *	xTimerNew (void)
	Création d'un timer. More...

Typedefs
typedef int(*	iTimerCallback) (xTimer *tm)
typedef struct xTimer	xTimer
	Objet timer Structure opaque pour l'utilisateur.

Typedef Documentation

typedef int(* iTimerCallback) (xTimer *tm)

#include <timer.h>

Gestionnaire utilisateur d'événement timer

Déclenché sur modification de niveau d'une ou plusieurs broches. Seuls le ou les fronts valides définis lors de l'appel à iDinSetCallback() déclenchent un traitement.

Parameters

edge	front déclenchant
udata	pointeur sur les données utilisateur défini lors de l'appel à iDinSetCallback()

Returns

doit retourner 0 si l'événement a été traité, -1 sinon.

Definition at line 46 of file timer.h.

Function Documentation

bool bTimerIsActive

(

const xTimer *

tm

)

#include <timer.h>

Teste si un timer est en marche.

Parameters

tm	pointeur sur le timer

Returns

true si en marche

bool bTimerIsSingleShot

(

const xTimer *

tm

)

#include <timer.h>

Teste si single shot actif.

Parameters

tm	pointeur sur le timer

Returns

true si actif (par défaut)

bool bTimerIsTimeout

(

xTimer *

tm

)

#include <timer.h>

Teste la fin d'un timer single shot.

Parameters

tm	pointeur sur le timer

Returns

true si le décompte est terminé

int iTimerDelete

(

xTimer *

tm

)

#include <timer.h>

Suppression d'un timer.

Parameters

tm	pointeur sur le timer

Returns

0, -1 si erreur (errno contient l'erreur)

int iTimerSetCallback	(	xTimer *	tm,
		iTimerCallback	callback,
		void *	udata
	)

#include <timer.h>

Installation d'un gestionnaire de timeout.

Parameters

tm	pointeur sur le timer
callback	nom du gestionnaire (fonction définie par l'utilisateur)
udata	pointeur sur des données qui seront passées lors de l'exécution du gestionnaire (NULL si inutilisé)

Returns

0, -1 si erreur

int iTimerStart

(

xTimer *

tm

)

#include <timer.h>

Démarre un timer.

Parameters

tm	pointeur sur le timer

Returns

0, -1 si erreur (errno contient l'erreur)

int iTimerStop

(

xTimer *

tm

)

#include <timer.h>

Arrête un timer.

Parameters

tm	pointeur sur le timer

Returns

0, -1 si erreur (errno contient l'erreur)

int iTimerUnsetCallback

(

xTimer *

tm

)

#include <timer.h>

Retire un gestionnaire de timeout.

Parameters

tm	pointeur sur le timer

Returns

0, -1 si erreur

int iTimerWait

(

xTimer *

tm

)

#include <timer.h>

Attente d'un timer.

Parameters

tm	pointeur sur le timer

Returns

le nombre de déclenchement pendant l'attente, -1 si erreur

long lTimerInterval

(

const xTimer *

tm

)

#include <timer.h>

Lecture de l'intervalle d'un timer.

Parameters

tm	pointeur sur le timer

Returns

intervalle en ms

long lTimerRemainingTime

(

const xTimer *

tm

)

#include <timer.h>

Renvoie la valeur restante de la minuterie en millisecondes.

Renvoie la valeur restante de la minuterie en millisecondes restant jusqu'à la fin du délai. Si la minuterie est inactive, la valeur renvoyée sera -1. Si la minuterie est en retard, la valeur retournée sera 0.

Parameters

tm	pointeur sur le timer

Returns

valeur restante de la minuterie en millisecondes, -1 si erreur

void* pvTimerUserData

(

xTimer *

tm

)

#include <timer.h>

Données utilisateur d'un timer.

Parameters

tm	pointeur sur le timer

Returns

pointeur sur les données utilisateur

void vTimerSetInterval	(	xTimer *	tm,
		long	msec
	)

#include <timer.h>

Modifie l'intervalle d'un timer.

Parameters

tm	pointeur sur le timer
msec	intervalle en ms

void vTimerSetSingleShot	(	xTimer *	tm,
		bool	singleShot
	)

#include <timer.h>

Valide/Invalide le single shot.

Parameters

tm	pointeur sur le timer
singleShot	true pour valider

xTimer* xTimerNew

(

void

)

#include <timer.h>

Création d'un timer.

Returns

pointeur sur le nouveau timer, NULL si erreur