lib/eggdrop/timer.c File Reference

#include <eggdrop/eggdrop.h>

Go to the source code of this file.

Defines
#define	TIMEBUFLEN   1024
Functions
int	timer_init ()
int	timer_shutdown ()
int	timer_get_time (egg_timeval_t *curtime)
long	timer_update_now (egg_timeval_t *_now)
void	timer_get_now (egg_timeval_t *_now)
long	timer_get_now_sec (long *sec)
int	timer_diff (egg_timeval_t *from_time, egg_timeval_t *to_time, egg_timeval_t *diff)
static int	timer_add_to_list (egg_timer_t *timer)
int	timer_create_secs (long secs, const char *name, Function callback)
int	timer_create_complex (egg_timeval_t *howlong, const char *name, Function callback, void *client_data, int flags, event_owner_t *owner)
int	timer_destroy (int timer_id)
int	timer_destroy_all ()
int	timer_destroy_by_owner (egg_module_t *module, void *script)
int	timer_get_shortest (egg_timeval_t *howlong)
int	timer_run ()
egg_timer_t *	timer_list ()
egg_timer_t *	timer_find (int id)
int	timer_set_timestamp (char *format)
char *	timer_get_timestamp (void)
Variables
static const char	rcsid [] = "$Id: timer.c,v 1.14 2006-10-11 01:54:04 sven Exp $"
static egg_timeval_t	now
static char *	timestamp_format = NULL
static char	timestamp [TIMEBUFLEN]
static egg_timer_t *	timer_list_head = NULL
static int	timer_next_id = 1

---

Define Documentation

#define TIMEBUFLEN   1024

Definition at line 26 of file timer.c.

Referenced by timer_get_timestamp().

---

Function Documentation

static int timer_add_to_list

(

egg_timer_t *

timer

)

[static]

Definition at line 108 of file timer.c.

References egg_timer::next, NULL, egg_timeval::sec, egg_timer::trigger_time, and egg_timeval::usec.

Referenced by timer_create_complex(), and timer_run().

{
  egg_timer_t *prev, *ptr;

  /* Find out where this should go in the list. */
  prev = NULL;
  for (ptr = timer_list_head; ptr; ptr = ptr->next) {
    if (timer->trigger_time.sec < ptr->trigger_time.sec) break;
    if (timer->trigger_time.sec == ptr->trigger_time.sec && timer->trigger_time.usec < ptr->trigger_time.usec) break;
    prev = ptr;
  }

  /* Insert into timer list. */
  if (prev) {
    timer->next = prev->next;
    prev->next = timer;
  }
  else {
    timer->next = timer_list_head;
    timer_list_head = timer;
  }
  return(0);
}

int timer_create_complex	(	egg_timeval_t *	howlong,
		const char *	name,
		Function	callback,
		void *	client_data,
		int	flags,
		event_owner_t *	owner
	)

Definition at line 142 of file timer.c.

References egg_timer::callback, egg_timer::client_data, egg_timer::flags, egg_timer::howlong, egg_timer::id, egg_timer::name, egg_timer::next, NULL, egg_timer::owner, egg_timeval::sec, timer_add_to_list(), timer_next_id, egg_timer::trigger_time, and egg_timeval::usec.

Referenced by attach(), chanserv_init(), dcc_accept_send(), dcc_listen(), script_timer(), and socktimer_on().

{
  static int wraparound = 0;
  egg_timer_t *timer;

  /* Make sure the timer uid is really unique */
  if (timer_next_id < 1) {
    timer_next_id = 1;
    wraparound = 1;
  }
  if (wraparound) {
    do {
      for (timer = timer_list_head; timer; timer = timer->next) {
        if (timer->id == timer_next_id) {
          timer_next_id++;
          if (timer_next_id < 1) timer_next_id = 1;
          break;
        }
      }
    } while (timer);
  }
  
  /* Fill out a new timer. */
  timer = malloc(sizeof(*timer));
  timer->id = timer_next_id++;
  if (name) timer->name = strdup(name);
  else timer->name = NULL;
  timer->callback = callback;
  timer->client_data = client_data;
  timer->flags = flags;
  timer->howlong.sec = howlong->sec;
  timer->howlong.usec = howlong->usec;
  timer->trigger_time.sec = now.sec + howlong->sec;
  timer->trigger_time.usec = now.usec + howlong->usec;
  timer->owner = owner;

  timer_add_to_list(timer);

  return(timer->id);
}

int timer_create_secs	(	long	secs,
		const char *	name,
		Function	callback
	)

Definition at line 132 of file timer.c.

References egg_timeval::sec, timer_create_repeater, and egg_timeval::usec.

Referenced by egg_dns_init().

{
  egg_timeval_t howlong;

  howlong.sec = secs;
  howlong.usec = 0;

  return timer_create_repeater(&howlong, name, callback);
}

int timer_destroy

(

int

timer_id

)

Definition at line 184 of file timer.c.

References egg_timer::client_data, egg_timer::id, egg_timer::name, egg_timer::next, NULL, event_owner_b::on_delete, and egg_timer::owner.

Referenced by dcc_listen_delete(), dcc_recv_connect(), dcc_recv_delete(), detach(), egg_on_delete(), events_shutdown(), main(), socktimer_off(), socktimer_on(), socktimer_on_delete(), and throttle_off().

{
  egg_timer_t *prev, *timer;

  prev = NULL;
  for (timer = timer_list_head; timer; timer = timer->next) {
    if (timer->id == timer_id) break;
    prev = timer;
  }

  if (!timer) return(1); /* Not found! */

  /* Unlink it. */
  if (prev) prev->next = timer->next;
  else timer_list_head = timer->next;

  if (timer->owner && timer->owner->on_delete) timer->owner->on_delete(timer->owner, timer->client_data);
  if (timer->name) free(timer->name);
  free(timer);
  return(0);
}

int timer_destroy_all

(

)

Definition at line 206 of file timer.c.

References egg_timer::client_data, egg_timer::name, egg_timer::next, NULL, event_owner_b::on_delete, and egg_timer::owner.

{
  egg_timer_t *timer, *next;

  for (timer = timer_list_head; timer; timer = next) {
    next = timer->next;

    if (timer->owner && timer->owner->on_delete) timer->owner->on_delete(timer->owner, timer->client_data);
    if (timer->name) free(timer->name);
    free(timer);
  }
  timer_list_head = NULL;

  return(0);
}

int timer_destroy_by_owner	(	egg_module_t *	module,
		void *	script
	)

Definition at line 222 of file timer.c.

References egg_timer::client_data, event_owner_b::client_data, event_owner_b::module, egg_timer::name, egg_timer::next, event_owner_b::on_delete, and egg_timer::owner.

Referenced by script_remove_events_by_owner().

{
  int removed = 0;
  egg_timer_t *timer, *prev = 0, *next;

  for (timer = timer_list_head; timer; timer = next) {
    next = timer->next;

    if (timer->owner && timer->owner->module == module && (!script || timer->owner->client_data == script)) {
      if (prev) prev->next = timer->next;
      else timer_list_head = timer->next;
      ++removed;

      if (timer->owner && timer->owner->on_delete) timer->owner->on_delete(timer->owner, timer->client_data);
      if (timer->name) free(timer->name);
      free(timer);
    } else {
      prev = timer;
    }
  }
  return removed;
}

int timer_diff	(	egg_timeval_t *	from_time,
		egg_timeval_t *	to_time,
		egg_timeval_t *	diff
	)

Definition at line 85 of file timer.c.

References egg_timeval::sec, and egg_timeval::usec.

Referenced by gotpong(), script_timer_info(), server_secondly(), and timer_get_shortest().

{
  diff->sec = to_time->sec - from_time->sec;
  if (diff->sec < 0) {
    diff->sec = 0;
    diff->usec = 0;
    return(1);
  }

  diff->usec = to_time->usec - from_time->usec;

  if (diff->usec < 0) {
    if (diff->sec == 0) {
      diff->usec = 0;
      return(1);
    }
    diff->sec -= 1;
    diff->usec += 1000000;
  }

  return(0);
}

egg_timer_t* timer_find

(

int

id

)

Definition at line 301 of file timer.c.

References egg_timer::id, egg_timer::next, and NULL.

Referenced by script_timer_info().

{
  egg_timer_t *timer;

  for (timer = timer_list_head; timer; timer = timer->next) {
    if (timer->id == id) return(timer);
  }
  return(NULL);
}

void timer_get_now

(

egg_timeval_t *

_now

)

Definition at line 72 of file timer.c.

References egg_timeval::sec, and egg_timeval::usec.

Referenced by script_timer_info(), sockbuf_got_readable_server(), sockbuf_on_connect(), sockbuf_on_newclient(), stats_in(), and stats_out().

{
  _now->sec = now.sec;
  _now->usec = now.usec;
}

long timer_get_now_sec

(

long *

sec

)

Definition at line 78 of file timer.c.

References egg_timeval::sec.

Referenced by blowfish_init(), cache_add(), cache_expired(), channel_add_member(), chanserv_update_stats(), cleanup_old_members(), dcc_accept_send(), dcc_recv_connect(), dcc_send_connect(), dcc_send_info(), dcc_start_send(), got_mode(), gottopic(), modefight_cleanup(), parse_chan_mode(), party_timers(), update_snapshot(), and update_stats().

{
  if (sec) *sec = now.sec;
  return(now.sec);
}

int timer_get_shortest

(

egg_timeval_t *

howlong

)

Definition at line 245 of file timer.c.

References timer_diff(), and egg_timer::trigger_time.

Referenced by main().

{
  egg_timer_t *timer = timer_list_head;

  /* No timers? Boo. */
  if (!timer) return(1);

  timer_diff(&now, &timer->trigger_time, howlong);

  return(0);
}

int timer_get_time

(

egg_timeval_t *

curtime

)

Definition at line 52 of file timer.c.

References NULL, egg_timeval::sec, and egg_timeval::usec.

Referenced by gotpong(), server_secondly(), and timer_update_now().

{
  struct timeval tv;

  (void) gettimeofday(&tv, NULL);
  curtime->sec = tv.tv_sec;
  curtime->usec = tv.tv_usec;
  return(0);
}

char* timer_get_timestamp

(

void

)

Definition at line 317 of file timer.c.

References egg_timeval::sec, TIMEBUFLEN, timestamp, and timestamp_format.

Referenced by flushlogs(), logfile_del(), on_putlog(), partyline_idx_chanmsg(), partyline_idx_join(), partyline_idx_nick(), partyline_idx_part(), partyline_idx_privmsg(), and partyline_idx_quit().

{
  time_t now_secs = (time_t)now.sec;
  int len;

  len = strftime(timestamp, TIMEBUFLEN, timestamp_format, localtime(&now_secs));
  /* Did it work and fit in the buffer? */
  if (!len) *timestamp = 0;

  return timestamp;
}

int timer_init

(

)

Definition at line 36 of file timer.c.

References timestamp_format.

Referenced by eggdrop_init().

{
  timestamp_format = strdup("[%H:%M] ");
  return(0);
}

egg_timer_t* timer_list

(

)

Definition at line 296 of file timer.c.

Referenced by party_timers(), and script_timers().

{
  return(timer_list_head);
}

int timer_run

(

)

Definition at line 257 of file timer.c.

References egg_timer::callback, egg_timer::client_data, egg_timer::flags, egg_timer::howlong, egg_timer::name, egg_timer::next, event_owner_b::on_delete, egg_timer::owner, egg_timeval::sec, timer_add_to_list(), TIMER_REPEAT, egg_timer::trigger_time, and egg_timeval::usec.

Referenced by main().

{
  egg_timer_t *timer;
  Function callback;
  void *client_data;

  while (timer_list_head) {
    timer = timer_list_head;
    if (timer->trigger_time.sec > now.sec || (timer->trigger_time.sec == now.sec && timer->trigger_time.usec > now.usec)) break;

    timer_list_head = timer_list_head->next;

    callback = timer->callback;
    client_data = timer->client_data;

    callback(client_data);

    if (timer->flags & TIMER_REPEAT) {
      /* Update timer. */
      timer->trigger_time.sec += timer->howlong.sec;
      timer->trigger_time.usec += timer->howlong.usec;
      if (timer->trigger_time.usec >= 1000000) {
        timer->trigger_time.usec -= 1000000;
        timer->trigger_time.sec += 1;
      }

      /* Add it back into the list. */
      timer_add_to_list(timer);
    }
    else {
      if (timer->owner && timer->owner->on_delete) timer->owner->on_delete(timer->owner, timer->client_data);
      if (timer->name) free(timer->name);
      free(timer);
    }

  }
  return(0);
}

int timer_set_timestamp

(

char *

format

)

Definition at line 311 of file timer.c.

References str_redup(), and timestamp_format.

{
  str_redup(&timestamp_format, format);
  return(0);
}

int timer_shutdown

(

)

Definition at line 42 of file timer.c.

References NULL, and timestamp_format.

Referenced by eggdrop_shutdown().

{
  if (timestamp_format) {
    free(timestamp_format);
    timestamp_format = NULL;
  }
  return(0);
}

long timer_update_now

(

egg_timeval_t *

_now

)

Definition at line 62 of file timer.c.

References egg_timeval::sec, timer_get_time(), and egg_timeval::usec.

Referenced by main().

{
  timer_get_time(&now);
  if (_now) {
    _now->sec = now.sec;
    _now->usec = now.usec;
  }
  return(now.sec);
}

---

Variable Documentation

egg_timeval_t now [static]

Definition at line 28 of file timer.c.

const char rcsid[] = "$Id: timer.c,v 1.14 2006-10-11 01:54:04 sven Exp $" [static]

Definition at line 21 of file timer.c.

egg_timer_t* timer_list_head = NULL [static]

Definition at line 33 of file timer.c.

int timer_next_id = 1 [static]

Definition at line 34 of file timer.c.

Referenced by timer_create_complex().

char timestamp[TIMEBUFLEN] [static]

Definition at line 30 of file timer.c.

Referenced by timer_get_timestamp().

char* timestamp_format = NULL [static]

Definition at line 29 of file timer.c.

Referenced by timer_get_timestamp(), timer_init(), timer_set_timestamp(), and timer_shutdown().