apt_timer_queue.h File Reference

Timer Queue. More...

#include "apt.h"

Go to the source code of this file.

Typedefs
typedef typedefAPT_BEGIN_EXTERN_C struct apt_timer_t	apt_timer_t
typedef struct apt_timer_queue_t	apt_timer_queue_t
typedef void(*	apt_timer_proc_f )(apt_timer_t *timer, void *obj)
Functions
apt_timer_queue_t *	apt_timer_queue_create (apr_pool_t *pool)
void	apt_timer_queue_destroy (apt_timer_queue_t *timer_queue)
void	apt_timer_queue_advance (apt_timer_queue_t *timer_queue, apr_uint32_t elapsed_time)
apt_bool_t	apt_timer_queue_is_empty (const apt_timer_queue_t *timer_queue)
apt_bool_t	apt_timer_queue_timeout_get (const apt_timer_queue_t *timer_queue, apr_uint32_t *timeout)
apt_timer_t *	apt_timer_create (apt_timer_queue_t *timer_queue, apt_timer_proc_f proc, void *obj, apr_pool_t *pool)
apt_bool_t	apt_timer_set (apt_timer_t *timer, apr_uint32_t timeout)
apt_bool_t	apt_timer_kill (apt_timer_t *timer)

---

Detailed Description

Timer Queue.

---

Typedef Documentation

typedef void(* apt_timer_proc_f)(apt_timer_t *timer, void *obj)

Prototype of timer callback

typedef struct apt_timer_queue_t apt_timer_queue_t

Opaque timer queue declaration

typedef typedefAPT_BEGIN_EXTERN_C struct apt_timer_t apt_timer_t

Opaque timer declaration

---

Function Documentation

apt_timer_t* apt_timer_create	(	apt_timer_queue_t *	timer_queue,
		apt_timer_proc_f	proc,
		void *	obj,
		apr_pool_t *	pool
	)

Create timer

apt_bool_t apt_timer_kill

(

apt_timer_t *

timer

)

Kill timer

void apt_timer_queue_advance	(	apt_timer_queue_t *	timer_queue,
		apr_uint32_t	elapsed_time
	)

Advance scheduled timers

apt_timer_queue_t* apt_timer_queue_create

(

apr_pool_t *

pool

)

Create timer queue

void apt_timer_queue_destroy

(

apt_timer_queue_t *

timer_queue

)

Destroy timer queue

apt_bool_t apt_timer_queue_is_empty

(

const apt_timer_queue_t *

timer_queue

)

Is timer queue empty

apt_bool_t apt_timer_queue_timeout_get	(	const apt_timer_queue_t *	timer_queue,
		apr_uint32_t *	timeout
	)

Get current timeout

apt_bool_t apt_timer_set	(	apt_timer_t *	timer,
		apr_uint32_t	timeout
	)

Set one-shot timer