modules/tm/timer.h

Go to the documentation of this file.

/*
 * $Id: timer.h 5003 2008-09-26 11:01:51Z henningw $
 *
 * Copyright (C) 2001-2003 FhG Fokus
 *
 * This file is part of Kamailio, a free SIP server.
 *
 * Kamailio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version
 *
 * Kamailio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * History:
 * --------
 *  2003-09-12  timer_link.tg exists only if EXTRA_DEBUG (andrei)
 *  2004-02-13  timer_link.payload removed (bogdan)
 *  2007-02-02  retransmission timers have milliseconds resolution (bogdan)
 */

/*! \file
 * \brief TM :: Timer handling
 *
 * \ingroup tm
 * - Module: \ref tm
 */



#ifndef _TIMER_H
#define _TIMER_H

#include "../../timer.h"
#include "lock.h"

#define MIN_TIMER_VALUE  2

/* identifiers of timer lists;*/
/* fixed-timer retransmission lists (benefit: fixed timer$
   length allows for appending new items to the list as$
   opposed to inserting them which is costly */
enum lists
{
   FR_TIMER_LIST, FR_INV_TIMER_LIST,
   WT_TIMER_LIST,
   DELETE_LIST,
   RT_T1_TO_1, RT_T1_TO_2, RT_T1_TO_3,
   RT_T2,
   NR_OF_TIMER_LISTS
};


/* all you need to put a cell in a timer list
   links to neighbors and timer value */
typedef struct timer_link
{
   struct timer_link     *next_tl;
   struct timer_link     *prev_tl;
   struct timer_link     *ld_tl;
   volatile utime_t      time_out;
   struct timer          *timer_list;
   unsigned int          deleted;
#ifdef EXTRA_DEBUG
   enum timer_groups  tg;
#endif
}timer_link_type ;


/* timer list: includes head, tail and protection semaphore */
typedef struct  timer
{
   struct timer_link  first_tl;
   struct timer_link  last_tl;
   ser_lock_t*        mutex;
   enum lists         id;
} timer_type;


/* transaction table */
struct timer_table
{
   /* table of timer lists */
   struct timer   timers[ NR_OF_TIMER_LISTS ];
};





extern int timer_group[NR_OF_TIMER_LISTS];
extern unsigned int timer_id2timeout[NR_OF_TIMER_LISTS];



struct timer_table * tm_init_timers(void);
void unlink_timer_lists(void);
void free_timer_table(void);
void init_timer_list( enum lists list_id);
void reset_timer_list( enum lists list_id);

void reset_timer( struct timer_link* tl );

/* determine timer length and put on a correct timer list */
void set_timer( struct timer_link *new_tl, enum lists list_id,
      utime_t* ext_timeout );

/* similar to set_timer, except it allows only one-time
   timer setting and all later attempts are ignored */
void set_1timer( struct timer_link *new_tl, enum lists list_id,
      utime_t* ext_timeout );

void timer_routine( unsigned int, void*);

void utimer_routine( utime_t, void*);

struct timer_table *get_timertable(void);

#endif