dlg_timer.h File Reference

Timer related functions for the dialog moduleModule: dialog :: Kamailio dialog module. More...

#include "../../locking.h"

Include dependency graph for dlg_timer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

• struct dlg_timer

  dialog timer More...
  

• struct dlg_tl

  dialog timeout list More...
  

Typedefs

• typedef void(* dlg_timer_handler )(struct dlg_tl *)

  dialog timer handler
  

• typedef struct dlg_timer dlg_timer_t

  dialog timer
  

• typedef struct dlg_tl dlg_tl_t

  dialog timeout list
  

Functions

• void destroy_dlg_timer (void)

  Destroy global dialog timer.
  

• void dlg_timer_routine (unsigned int ticks, void *attr)

  Timer routine for expiration of dialogs Timer handler for expiration of dialogs, runs the global timer handler on them.
  

• int init_dlg_timer (dlg_timer_handler)

  Initialize the dialog timer handler Initialize the dialog timer handler, allocate the lock and a global timer in shared memory.
  

• int insert_dlg_timer (struct dlg_tl *tl, int interval)

  Insert a dialog timer to the list.
  

• int remove_dialog_timer (struct dlg_tl *tl)

  Remove a dialog timer from the list.
  

• int update_dlg_timer (struct dlg_tl *tl, int timeout)

  Update a dialog timer on the list.
  

---

Detailed Description

Definition in file dlg_timer.h.

---

Function Documentation

void dlg_timer_routine	(	unsigned int	ticks,
		void *	attr
	)

Parameters:

	ticks	time for expiration checks
	attr	unused

Definition at line 272 of file dlg_timer.c.

References get_expired_dlgs(), and timer_hdl.

Here is the call graph for this function:

int init_dlg_timer

(

dlg_timer_handler

hdl

)

The global timer handler will be set on success.

Parameters:

hdl

dialog timer handler

Returns:

0 on success, -1 on failure

Definition at line 51 of file dlg_timer.c.

References dlg_timer::first, dlg_timer::lock, and timer_hdl.

int insert_dlg_timer	(	struct dlg_tl *	tl,
		int	interval
	)

Parameters:

	tl	dialog timer list
	interval	timeout value in seconds

Returns:

0 on success, -1 when the input timer list is invalid

Definition at line 129 of file dlg_timer.c.

References insert_dialog_timer_unsafe(), dlg_timer::lock, and dlg_tl::timeout.

Referenced by dlg_onreply().

Here is the call graph for this function:

Here is the caller graph for this function:

int remove_dialog_timer

(

struct dlg_tl *

tl

)

Parameters:

tl

dialog timer that should be removed

Returns:

1 when the input timer is empty, 0 when the timer was removed, -1 when the input timer list is invalid

Definition at line 166 of file dlg_timer.c.

References dlg_timer::lock, remove_dialog_timer_unsafe(), and dlg_tl::timeout.

Referenced by destroy_dlg(), and dlg_onroute().

Here is the call graph for this function:

Here is the caller graph for this function:

int update_dlg_timer	(	struct dlg_tl *	tl,
		int	timeout
	)

Parameters:

	tl	dialog timer
	timeout	new timeout value in seconds

Returns:

0 on success, -1 when the input list is invalid

Note:

the update is implemented as a remove, insert

Definition at line 199 of file dlg_timer.c.

References insert_dialog_timer_unsafe(), dlg_timer::lock, remove_dialog_timer_unsafe(), and dlg_tl::timeout.

Referenced by dlg_onroute().

Here is the call graph for this function:

Here is the caller graph for this function: