USRLOC - Usrloc record structure

Module Usrloc :: User location module.

#include "urecord.h"
#include <string.h>
#include "../../mem/shm_mem.h"
#include "../../dprint.h"
#include "../../ut.h"
#include "../../hashes.h"
#include "ul_mod.h"
#include "usrloc.h"
#include "utime.h"
#include "ul_callback.h"

Include dependency graph for modules_k/usrloc/urecord.c:

Go to the source code of this file.

Functions

static struct ucontact * contact_callid_match (ucontact_t *ptr, str *_c, str *_callid)
Match a contact record to a contact string and callid.
static struct ucontact * contact_match (ucontact_t *ptr, str *_c)
Match a contact record to a contact string.
static struct ucontact * contact_path_match (ucontact_t *ptr, str *_c, str *_path)
+ *
int db_delete_urecord (urecord_t *_r)
Delete a record from the database.
int delete_ucontact (urecord_t *_r, struct ucontact *_c)
Delete ucontact from urecord.
void free_urecord (urecord_t *_r)
Free all memory used by the given structure.
int get_ucontact (urecord_t *_r, str *_c, str *_callid, str *_path, int _cseq, struct ucontact **_co)
Get pointer to ucontact with given contact.
int get_ucontact_by_instance (urecord_t *_r, str *_c, ucontact_info_t *_ci, ucontact_t **_co)
Get pointer to ucontact with given contact.
int insert_ucontact (urecord_t *_r, str *_contact, ucontact_info_t *_ci, ucontact_t **_c)
Create and insert new contact into urecord.
void mem_delete_ucontact (urecord_t *_r, ucontact_t *_c)
Remove contact in memory from the list and delete it.
ucontact_t * mem_insert_ucontact (urecord_t *_r, str *_c, ucontact_info_t *_ci)
Add a new contact in memory.
void mem_remove_ucontact (urecord_t *_r, ucontact_t *_c)
Remove the contact from lists in memory.
int new_urecord (str *_dom, str *_aor, urecord_t **_r)
Create and initialize new record structure.
static void nodb_timer (urecord_t *_r)
Expires timer for NO_DB db_mode.
void print_urecord (FILE *_f, urecord_t *_r)
Print a record, useful for debugging.
void release_urecord (urecord_t *_r)
Release urecord previously obtained through get_urecord.
void timer_urecord (urecord_t *_r)
Run timer functions depending on the db_mode setting.
static void wb_timer (urecord_t *_r)
Write-back timer, used for WRITE_BACK db_mode.
static void wt_timer (urecord_t *_r)
Write through timer, used for WRITE_THROUGH db_mode.

Variables

int cseq_delay = 20
retransmission detection interval in seconds
int matching_mode = CONTACT_ONLY
contact matching mode

Detailed Description

Definition in file modules_k/usrloc/urecord.c.

Function Documentation

static struct ucontact* contact_callid_match	(	ucontact_t *	ptr,
		str *	_c,
		str *	_callid
	)			`[static, read]`

Parameters:

	ptr	contact record
	_c	contact string
	_callid	callid

Returns:: ptr on successfull match, 0 when they not match

Definition at line 545 of file modules_k/usrloc/urecord.c.

References ucontact::c, ucontact::callid, _str::len, ucontact::next, and _str::s.

Referenced by get_ucontact().

Here is the caller graph for this function:

static struct ucontact* contact_match	(	ucontact_t *	ptr,
		str *	_c
	)			`[static, read]`

Parameters:

	ptr	contact record
	_c	contact string

Returns:: ptr on successfull match, 0 when they not match

Definition at line 525 of file modules_k/usrloc/urecord.c.

References ucontact::c, _str::len, ucontact::next, and _str::s.

Referenced by contact_path_match(), and get_ucontact().

Here is the caller graph for this function:

static struct ucontact* contact_path_match	(	ucontact_t *	ptr,
		str *	_c,
		str *	_path
	)			`[static, read]`

Match a contact record to a contact string and path + *

Parameters:

	ptr	contact record + *
	_c	contact string + *
	_path	path + *

Returns:: ptr on successfull match, 0 when they not match +

Definition at line 568 of file modules_k/usrloc/urecord.c.

References ucontact::c, contact_match(), _str::len, ucontact::next, ucontact::path, and _str::s.

Referenced by get_ucontact().

Here is the call graph for this function:

Here is the caller graph for this function:

int db_delete_urecord ( urecord_t * _r )

Parameters:

_r

deleted record

Returns:: 0 on success, -1 on failure

Definition at line 402 of file modules_k/usrloc/urecord.c.

References urecord::aor, urecord::domain, domain_col, _str::len, db_val_t::nul, _str::s, db_val_t::str_val, db_val_t::type, use_domain, user_col, and db_val_t::val.

int delete_ucontact	(	urecord_t *	_r,
		struct ucontact *	_c
	)

Parameters:

	_r	record where the contact belongs to
	_c	deleted contact

Returns:: 0 on success, -1 on failure

Definition at line 496 of file modules_k/usrloc/urecord.c.

References db_delete_ucontact(), db_mode, DB_ONLY, mem_delete_ucontact(), run_ul_callbacks(), st_delete_ucontact(), and WRITE_THROUGH.

Here is the call graph for this function:

void free_urecord ( urecord_t * _r )

Free all memory used by the given structure. The structure must be removed from all linked lists first

Parameters:

_r

freed record list

Definition at line 93 of file modules_k/usrloc/urecord.c.

References urecord::aor, urecord::contacts, db_mode, DB_ONLY, free_ucontact(), ucontact::next, and _str::s.

Here is the call graph for this function:

int get_ucontact	(	urecord_t *	_r,
		str *	_c,
		str *	_callid,
		str *	_path,
		int	_cseq,
		struct ucontact **	_co
	)

Parameters:

	_r	record where to search the contacts
	_c	contact string
	_callid	callid
	_path	path
	_cseq	CSEQ number
	_co	found contact

Returns:: 0 - found, 1 - not found, -1 - invalid found, -2 - found, but to be skipped (same cseq)

Definition at line 598 of file modules_k/usrloc/urecord.c.

References ucontact::callid, contact_callid_match(), contact_match(), contact_path_match(), urecord::contacts, ucontact::cseq, cseq_delay, get_act_time(), ucontact::last_modified, _str::len, matching_mode, and _str::s.

Here is the call graph for this function:

int get_ucontact_by_instance	(	urecord_t *	_r,
		str *	_c,
		ucontact_info_t *	_ci,
		ucontact_t **	_co
	)

Parameters:

	_r	record where to search the contacts
	_c	contact string
	_ci	contact info (callid, cseq, instance, ...)
	_co	found contact

Returns:: 0 - found, 1 - not found, -1 - invalid found, -2 - found, but to be skipped (same cseq)

Definition at line 645 of file modules_k/usrloc/urecord.c.

References ucontact_info::callid, urecord::contacts, ucontact_info::cseq, get_ucontact(), ucontact::instance, ucontact_info::instance, _str::len, ucontact::next, ucontact_info::path, ucontact::reg_id, ucontact_info::reg_id, and _str::s.

Here is the call graph for this function:

int insert_ucontact	(	urecord_t *	_r,
		str *	_contact,
		ucontact_info_t *	_ci,
		ucontact_t **	_c
	)

Parameters:

	_r	record into the new contact should be inserted
	_contact	contact string
	_ci	contact information
	_c	new created contact

Returns:: 0 on success, -1 on failure

Definition at line 465 of file modules_k/usrloc/urecord.c.

References db_insert_ucontact(), db_mode, DB_ONLY, mem_insert_ucontact(), run_ul_callbacks(), and WRITE_THROUGH.

Here is the call graph for this function:

void mem_delete_ucontact	(	urecord_t *	_r,
		ucontact_t *	_c
	)

Parameters:

	_r	record this contact belongs to
	_c	deleted contact

Definition at line 217 of file modules_k/usrloc/urecord.c.

References free_ucontact(), mem_remove_ucontact(), and urecord::slot.

Here is the call graph for this function:

ucontact_t* mem_insert_ucontact	(	urecord_t *	_r,
		str *	_c,
		ucontact_info_t *	_ci
	)

Add a new contact in memory, contacts are ordered by: 1) q value, 2) descending modification time

Parameters:

	_r	record this contact belongs to
	_c	contact
	_ci	contact information

Returns:: pointer to new created contact on success, 0 on failure

Definition at line 148 of file modules_k/usrloc/urecord.c.

References urecord::aor, ucontact::c, urecord::contacts, desc_time_order, urecord::domain, new_ucontact(), ucontact::next, ucontact::prev, ucontact::q, and urecord::slot.

Here is the call graph for this function:

void mem_remove_ucontact	(	urecord_t *	_r,
		ucontact_t *	_c
	)

Parameters:

	_r	record this contact belongs to
	_c	removed contact

Definition at line 196 of file modules_k/usrloc/urecord.c.

References urecord::contacts, ucontact::next, and ucontact::prev.

int new_urecord	(	str *	_dom,
		str *	_aor,
		urecord_t **	_r
	)

Hash table slot.

Parameters:

	_dom	domain name
	_aor	address of record
	_r	pointer to the new record

Returns:: 0 on success, negative on failure

Definition at line 61 of file modules_k/usrloc/urecord.c.

References _str::len, and _str::s.

static void nodb_timer ( urecord_t * _r ) [inline, static]

Expires timer for NO_DB db_mode, process all contacts from the record, delete the expired ones from memory.

Parameters:

_r

processed record

Definition at line 232 of file modules_k/usrloc/urecord.c.

References ucontact::aor, ucontact::c, urecord::contacts, _str::len, mem_delete_ucontact(), ucontact::next, run_ul_callbacks(), _str::s, urecord::slot, and VALID_CONTACT.

Referenced by timer_urecord().

Here is the call graph for this function:

Here is the caller graph for this function:

void print_urecord	(	FILE *	_f,
		urecord_t *	_r
	)

Parameters:

	_f	print output
	_r	printed record

Definition at line 116 of file modules_k/usrloc/urecord.c.

References urecord::aor, urecord::aorhash, urecord::contacts, urecord::domain, _str::len, ucontact::next, print_ucontact(), _str::s, and urecord::slot.

Here is the call graph for this function:

void release_urecord ( urecord_t * _r )

Warning:: Failing to calls this function after get_urecord will result in a memory leak when the DB_ONLY mode is used. When the records is later deleted, e.g. with delete_urecord, then its not necessary, as this function already releases the record.

Parameters:

_r

released record

Definition at line 447 of file modules_k/usrloc/urecord.c.

References urecord::contacts, db_mode, DB_ONLY, free_urecord(), mem_delete_urecord(), and urecord::slot.

Here is the call graph for this function:

void timer_urecord ( urecord_t * _r )

Helper function that run the appropriate timer function, depending on the db_mode setting.

Parameters:

_r

processed record

Definition at line 382 of file modules_k/usrloc/urecord.c.

References db_mode, NO_DB, nodb_timer(), wb_timer(), WRITE_BACK, and WRITE_THROUGH.

Here is the call graph for this function:

static void wb_timer ( urecord_t * _r ) [inline, static]

Write-back timer, used for WRITE_BACK db_mode. Process all contacts from the record, delete expired ones from the DB. Furthermore it updates changed contacts, and also insert new ones in the DB.

Parameters:

_r

processed record

Definition at line 309 of file modules_k/usrloc/urecord.c.

References ucontact::aor, ucontact::c, urecord::contacts, db_delete_ucontact(), db_insert_ucontact(), db_update_ucontact(), _str::len, mem_delete_ucontact(), ucontact::next, run_ul_callbacks(), _str::s, urecord::slot, st_expired_ucontact(), st_flush_ucontact(), ucontact::state, and VALID_CONTACT.