mintmr.h File Reference

#include "../dpdk/tsc.h"

Go to the source code of this file.

Data Structures
struct	MinTmr
	Timer on minute scheduler. More...
struct	MinSched
	Minute scheduler. More...

Typedefs
typedef struct MinTmr	MinTmr
	Timer on minute scheduler.
typedef void(*	MinTmrCb) (MinTmr *tmr, uintptr_t ctx)
typedef struct MinSched	MinSched
	Minute scheduler.

Functions
MinSched *	MinSched_New (int nSlotBits, TscDuration interval, MinTmrCb cb, uintptr_t ctx)
	Create a minute scheduler.
void	MinSched_Clear (MinSched *sched)
	Cancel all events.
void	MinSched_Close (MinSched *sched)
	Destroy a minute scheduler.
void	MinSched_Trigger_ (MinSched *sched, TscTime now)
void	MinTmr_Cancel_ (MinTmr *tmr)
bool	MinTmr_After (MinTmr *tmr, TscDuration after, MinSched *sched)
	Schedule a timer to expire after since current time.

Typedef Documentation

MinSched

typedef struct MinSched MinSched

Minute scheduler.

MinTmr

typedef struct MinTmr MinTmr

Timer on minute scheduler.

MinTmrCb

typedef void(* MinTmrCb) (MinTmr *tmr, uintptr_t ctx)

Function Documentation

MinSched_Clear()

void MinSched_Clear

(

MinSched *

sched

)

Cancel all events.

MinSched_Close()

void MinSched_Close

(

MinSched *

sched

)

Destroy a minute scheduler.

MinSched_New()

MinSched * MinSched_New	(	int	nSlotBits,
		TscDuration	interval,
		MinTmrCb	cb,
		uintptr_t	ctx )

Create a minute scheduler.

Parameters

nSlotBits	set the number of time slots to 1<<nSlotBits .
interval	duration between executing slots.
cb	callback function when a timer expires.

MinSched_Trigger_()

void MinSched_Trigger_	(	MinSched *	sched,
		TscTime	now )

MinTmr_After()

bool MinTmr_After	(	MinTmr *	tmr,
		TscDuration	after,
		MinSched *	sched )

Schedule a timer to expire after since current time.

Parameters

tmr	the timer; any previous setting will be cancelled.
after	expiration delay; negative value is changed to zero.

Return values

false

after >= MinSched_GetMaxDelay(sched)

MinTmr_Cancel_()

void MinTmr_Cancel_

(

MinTmr *

tmr

)