gw-timer.h File Reference

#include "gwlib/gwlib.h"

Go to the source code of this file.

Typedefs
typedef struct Timer	Timer
typedef struct Timerset	Timerset

Functions
Timerset *	gw_timerset_create (void)
void	gw_timerset_destroy (Timerset *set)
void	gw_timerset_elapsed_destroy (Timerset *set)
long	gw_timerset_count (Timerset *set)
Timer *	gw_timer_create (Timerset *set, List *outputlist, void(*callback)(void *))
void	gw_timer_destroy (Timer *timer)
void	gw_timer_elapsed_destroy (Timer *timer)
void	gw_timer_elapsed_destroy_cb (Timer *timer)
void	gw_timer_start (Timer *timer, int interval, void *data)
void	gw_timer_elapsed_start (Timer *timer, int interval, void *data)
void	gw_timer_elapsed_start_cb (Timer *timer, int interval, void *data)
void	gw_timer_stop (Timer *timer)
void	gw_timer_elapsed_stop (Timer *timer)
void	gw_timer_elapsed_stop_cb (Timer *timer)
List *	gw_timer_break (Timerset *set)
void *	gw_timer_data (Timer *timer)

Typedef Documentation

Timer

typedef struct Timer Timer

Definition at line 92 of file gw-timer.h.

Timerset

typedef struct Timerset Timerset

Definition at line 93 of file gw-timer.h.

Function Documentation

gw_timer_break()

List* gw_timer_break

(

Timerset *

set

)

Definition at line 501 of file gw-timer.c.

References abort_elapsed(), Timer::elapses, gw_assert(), gwlist_append(), gwlist_create, heap_delete(), Timer::index, lock(), and unlock().

{
    List *ret = NULL;

    lock(set);

    if (set->heap->len == 0) {
        unlock(set);
        return NULL;
    }

    ret = gwlist_create();

    /* Stop all timers. */
    while (set->heap->len > 0) {
        Timer *timer = set->heap->tab[0];

        gwlist_append(ret, timer);

        /*
         * If the timer is active, make it inactive and remove it from
         * the heap.
         */
        if (timer->elapses > 0) {
            timer->elapses = -1;
            gw_assert(set->heap->tab[timer->index] == timer);
            heap_delete(set->heap, timer->index);
        }

        abort_elapsed(timer);
    }

    unlock(set);

    return ret;
}

gw_timer_create()

Timer* gw_timer_create	(	Timerset *	set,
		List *	outputlist,
		void(*)(void *)	callback
	)

Definition at line 255 of file gw-timer.c.

References Timer::callback, Timer::data, Timer::elapsed_data, Timer::elapses, gwlist_add_producer(), Timer::index, Timer::output, and Timer::timerset.

Referenced by main(), retry_consumer_thread(), and url_result_thread().

{
    Timer *t;

    t = gw_malloc(sizeof(*t));
    t->timerset = set;
    t->elapses = -1;
    t->data = NULL;
    t->elapsed_data = NULL;
    t->index = -1;
    t->output = outputlist;
    if (t->output != NULL)
        gwlist_add_producer(outputlist);
    t->callback = callback;

    return t;
}

gw_timer_data()

void* gw_timer_data

(

Timer *

timer

)

Definition at line 538 of file gw-timer.c.

References Timer::data, and gw_assert().

{
    gw_assert(timer != NULL);

    return timer->data;
}

gw_timer_destroy()

void gw_timer_destroy

(

Timer *

timer

)

Definition at line 273 of file gw-timer.c.

References gw_timer_stop(), gwlist_remove_producer(), and Timer::output.

{
    if (timer == NULL)
        return;

    gw_timer_stop(timer);
    if (timer->output != NULL)
        gwlist_remove_producer(timer->output);
    gw_free(timer);
}

gw_timer_elapsed_destroy()

void gw_timer_elapsed_destroy

(

Timer *

timer

)

Definition at line 284 of file gw-timer.c.

References gw_timer_elapsed_stop(), gwlist_remove_producer(), and Timer::output.

Referenced by gw_timerset_elapsed_destroy(), http_queue_thread(), and timer_consumer_thread().

{
    if (timer == NULL)
        return;

    gw_timer_elapsed_stop(timer);
    if (timer->output != NULL)
        gwlist_remove_producer(timer->output);
    gw_free(timer);
}

gw_timer_elapsed_destroy_cb()

void gw_timer_elapsed_destroy_cb

(

Timer *

timer

)

Definition at line 295 of file gw-timer.c.

References gw_timer_elapsed_stop_cb(), gwlist_remove_producer(), and Timer::output.

Referenced by timer_retry_cb().

{
    if (timer == NULL)
        return;

    gw_timer_elapsed_stop_cb(timer);
    if (timer->output != NULL)
        gwlist_remove_producer(timer->output);
    gw_free(timer);
}

gw_timer_elapsed_start()

void gw_timer_elapsed_start	(	Timer *	timer,
		int	interval,
		void *	data
	)

Definition at line 352 of file gw-timer.c.

References Timer::data, Timer::elapsed_data, Timer::elapses, gw_assert(), gwthread_wakeup(), Timerset::heap, heap_adjust(), heap_insert(), Timer::index, interval, lock(), TimerHeap::tab, Timerset::thread, Timer::timerset, and unlock().

Referenced by main(), retry_consumer_thread(), timer_consumer_thread(), and url_result_thread().

{
    int wakeup = 0;

    gw_assert(timer != NULL);

    if (timer == NULL)
        return;

    lock(timer->timerset);

    /* Convert to absolute time */
    interval += time(NULL);

    if (timer->elapses > 0) {
        /* Resetting an existing timer.  Move it to its new
         * position in the heap. */
        if (interval < timer->elapses && timer->index == 0)
            wakeup = 1;
        timer->elapses = interval;
        gw_assert(timer->index >= 0);
        gw_assert(timer->timerset->heap->tab[timer->index] == timer);
        wakeup |= heap_adjust(timer->timerset->heap, timer->index);
    } else {
        /* Setting a new timer, or resetting an elapsed one.
         * There should be no further elapse event on the
         * output list here. */
        /* abort_elapsed(timer); */
        timer->elapsed_data = NULL;

        /* Then activate the timer. */
        timer->elapses = interval;
        gw_assert(timer->index < 0);
        heap_insert(timer->timerset->heap, timer);
        wakeup = timer->index == 0;  /* Do we have a new top? */
    }

    if (data != NULL) {
        timer->data = data;
    }

    unlock(timer->timerset);

    if (wakeup)
        gwthread_wakeup(timer->timerset->thread);
}

gw_timer_elapsed_start_cb()

void gw_timer_elapsed_start_cb	(	Timer *	timer,
		int	interval,
		void *	data
	)

Definition at line 399 of file gw-timer.c.

References Timer::data, Timer::elapsed_data, Timer::elapses, gw_assert(), gwthread_wakeup(), Timerset::heap, heap_adjust(), heap_insert(), Timer::index, interval, TimerHeap::tab, Timerset::thread, and Timer::timerset.

{
    int wakeup = 0;

    gw_assert(timer != NULL);

    if (timer == NULL)
        return;

    /* Convert to absolute time */
    interval += time(NULL);

    if (timer->elapses > 0) {
        /* Resetting an existing timer.  Move it to its new
         * position in the heap. */
        if (interval < timer->elapses && timer->index == 0)
            wakeup = 1;
        timer->elapses = interval;
        gw_assert(timer->index >= 0);
        gw_assert(timer->timerset->heap->tab[timer->index] == timer);
        wakeup |= heap_adjust(timer->timerset->heap, timer->index);
    } else {
        /* Setting a new timer, or resetting an elapsed one.
         * There should be no further elapse event on the
         * output list here. */
        /* abort_elapsed(timer); */
        timer->elapsed_data = NULL;

        /* Then activate the timer. */
        timer->elapses = interval;
        gw_assert(timer->index < 0);
        heap_insert(timer->timerset->heap, timer);
        wakeup = timer->index == 0;  /* Do we have a new top? */
    }

    if (data != NULL) {
        timer->data = data;
    }

    if (wakeup)
        gwthread_wakeup(timer->timerset->thread);
}

gw_timer_elapsed_stop()

void gw_timer_elapsed_stop

(

Timer *

timer

)

Definition at line 462 of file gw-timer.c.

References Timer::elapsed_data, Timer::elapses, gw_assert(), Timerset::heap, heap_delete(), Timer::index, lock(), TimerHeap::tab, Timer::timerset, and unlock().

Referenced by gw_timer_elapsed_destroy().

{
    gw_assert(timer != NULL);
    lock(timer->timerset);

    /*
     * If the timer is active, make it inactive and remove it from
     * the heap.
     */
    if (timer->elapses > 0) {
        timer->elapses = -1;
        gw_assert(timer->timerset->heap->tab[timer->index] == timer);
        heap_delete(timer->timerset->heap, timer->index);
    }

    /* abort_elapsed(timer); */
    timer->elapsed_data = NULL;

    unlock(timer->timerset);
}

gw_timer_elapsed_stop_cb()

void gw_timer_elapsed_stop_cb

(

Timer *

timer

)

Definition at line 483 of file gw-timer.c.

References Timer::elapsed_data, Timer::elapses, gw_assert(), Timerset::heap, heap_delete(), Timer::index, TimerHeap::tab, and Timer::timerset.

Referenced by gw_timer_elapsed_destroy_cb().

{
    gw_assert(timer != NULL);

    /*
     * If the timer is active, make it inactive and remove it from
     * the heap.
     */
    if (timer->elapses > 0) {
        timer->elapses = -1;
        gw_assert(timer->timerset->heap->tab[timer->index] == timer);
        heap_delete(timer->timerset->heap, timer->index);
    }

    /* abort_elapsed(timer); */
    timer->elapsed_data = NULL;
}

gw_timer_start()

void gw_timer_start	(	Timer *	timer,
		int	interval,
		void *	data
	)

Definition at line 306 of file gw-timer.c.

References abort_elapsed(), Timer::data, Timer::elapses, gw_assert(), gwthread_wakeup(), Timerset::heap, heap_adjust(), heap_insert(), Timer::index, interval, lock(), TimerHeap::tab, Timerset::thread, Timer::timerset, and unlock().

{
    int wakeup = 0;

    gw_assert(timer != NULL);

    if (timer == NULL)
        return;
        
    lock(timer->timerset);

    /* Convert to absolute time */
    interval += time(NULL);

    if (timer->elapses > 0) {
        /* Resetting an existing timer.  Move it to its new
         * position in the heap. */
        if (interval < timer->elapses && timer->index == 0)
            wakeup = 1;
        timer->elapses = interval;
        gw_assert(timer->index >= 0);
        gw_assert(timer->timerset->heap->tab[timer->index] == timer);
        wakeup |= heap_adjust(timer->timerset->heap, timer->index);
    } else {
        /* Setting a new timer, or resetting an elapsed one.
         * First deal with a possible elapse event that may
         * still be on the output list. */
        abort_elapsed(timer);

        /* Then activate the timer. */
        timer->elapses = interval;
        gw_assert(timer->index < 0);
        heap_insert(timer->timerset->heap, timer);
        wakeup = timer->index == 0;  /* Do we have a new top? */
    }

    if (data != NULL) {
        timer->data = data;
    }

    unlock(timer->timerset);

    if (wakeup)
        gwthread_wakeup(timer->timerset->thread);
}

gw_timer_stop()

void gw_timer_stop

(

Timer *

timer

)

Definition at line 442 of file gw-timer.c.

References abort_elapsed(), Timer::elapses, gw_assert(), Timerset::heap, heap_delete(), Timer::index, lock(), TimerHeap::tab, Timer::timerset, and unlock().

Referenced by gw_timer_destroy(), and gw_timerset_destroy().

{
    gw_assert(timer != NULL);
    lock(timer->timerset);

    /*
     * If the timer is active, make it inactive and remove it from
     * the heap.
     */
    if (timer->elapses > 0) {
        timer->elapses = -1;
        gw_assert(timer->timerset->heap->tab[timer->index] == timer);
        heap_delete(timer->timerset->heap, timer->index);
    }

    abort_elapsed(timer);

    unlock(timer->timerset);
}

gw_timerset_count()

long gw_timerset_count

(

Timerset *

set

)

Definition at line 244 of file gw-timer.c.

References lock(), and unlock().

Referenced by main().

{
    long ret;

    lock(set);
    ret = set->heap->len;
    unlock(set);

    return ret;
}

gw_timerset_create()

Timerset* gw_timerset_create

(

void

)

Definition at line 190 of file gw-timer.c.

References gwthread_create, heap_create(), mutex_create, and watch_timers().

Referenced by main().

{
    Timerset *set;

    set = gw_malloc(sizeof(Timerset));
    set->mutex = mutex_create();
    set->heap = heap_create();
    set->stopping = 0;
    set->thread = gwthread_create(watch_timers, set);

    return set;
}

gw_timerset_destroy()

void gw_timerset_destroy

(

Timerset *

set

)

Definition at line 203 of file gw-timer.c.

References gw_timer_stop(), gwthread_join(), gwthread_wakeup(), heap_destroy(), and mutex_destroy().

Referenced by main().

{
    if (set == NULL)
        return;
       
    /* Stop all timers. */
    while (set->heap->len > 0)
        gw_timer_stop(set->heap->tab[0]);

    /* Kill timer thread */
    set->stopping = 1;
    gwthread_wakeup(set->thread);
    gwthread_join(set->thread);

    /* Free resources */
    heap_destroy(set->heap);
    mutex_destroy(set->mutex);
    gw_free(set);
}

gw_timerset_elapsed_destroy()

void gw_timerset_elapsed_destroy

(

Timerset *

set

)

Definition at line 223 of file gw-timer.c.

References gw_timer_elapsed_destroy(), gwthread_join(), gwthread_wakeup(), heap_destroy(), and mutex_destroy().

{
    if (set == NULL)
        return;

    /* Stop all timers. */
    while (set->heap->len > 0)
        gw_timer_elapsed_destroy(set->heap->tab[0]);

    /* Kill timer thread */
    set->stopping = 1;
    gwthread_wakeup(set->thread);
    gwthread_join(set->thread);

    /* Free resources */
    heap_destroy(set->heap);
    mutex_destroy(set->mutex);
    gw_free(set);
}