modules_k/usrloc/ucontact.h File Reference

USRLOC - Usrloc contact structure. More...

#include <stdio.h>
#include "usrloc.h"

Include dependency graph for modules_k/usrloc/ucontact.h:

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

Go to the source code of this file.

Defines

• #define UL_EXPIRED_TIME   10

  ancient time used for marking the contacts forced to expired
  

Functions

• int db_delete_ucontact (ucontact_t *_c)

  Delete contact from the database.
  

• int db_insert_ucontact (ucontact_t *_c)

  Insert contact into the database.
  

• int db_update_ucontact (ucontact_t *_c)

  Update contact in the database.
  

• void free_ucontact (ucontact_t *_c)

  Free all memory associated with given contact structure.
  

• int mem_update_ucontact (ucontact_t *_c, ucontact_info_t *_ci)

  Update existing contact in memory with new values.
  

• ucontact_t * new_ucontact (str *_dom, str *_aor, str *_contact, ucontact_info_t *_ci)

  Create a new contact structure.
  

• void print_ucontact (FILE *_f, ucontact_t *_c)

  Print contact, for debugging purposes only.
  

• int st_delete_ucontact (ucontact_t *_c)

  Update state of the contact.
  

• int st_expired_ucontact (ucontact_t *_c)

  Called when the timer is about to delete an expired contact.
  

• int st_flush_ucontact (ucontact_t *_c)

  Called when the timer is about flushing the contact, updates contact state.
  

• void st_update_ucontact (ucontact_t *_c)

  Update state of the contact if we are using write-back scheme.
  

• int update_ucontact (struct urecord *_r, ucontact_t *_c, ucontact_info_t *_ci)

  Update ucontact with new values.
  

---

Detailed Description

Definition in file modules_k/usrloc/ucontact.h.

---

Function Documentation

int db_delete_ucontact

(

ucontact_t *

_c

)

Parameters:

_c

deleted contact

Returns:

0 on success, -1 on failure

Definition at line 680 of file modules_k/p_usrloc/ucontact.c.

References ucontact::aor, ucontact::c, ucontact::callid, callid_col, contact_col, ucontact::domain, domain_col, FL_MEM, ucontact::flags, _str::len, db_val_t::nul, register_udomain(), _str::s, db_val_t::str_val, db_val_t::type, use_domain, user_col, and db_val_t::val.

Here is the call graph for this function:

int db_insert_ucontact

(

ucontact_t *

_c

)

Parameters:

_c

inserted contact

Returns:

0 on success, -1 on failure

Definition at line 388 of file modules_k/p_usrloc/ucontact.c.

References ucontact::aor, db_val_t::bitmap_val, ucontact::c, ucontact::callid, callid_col, ucontact::cflags, contact_col, ucontact::cseq, cseq_col, ucontact::domain, domain_col, db_val_t::double_val, ucontact::expires, expires_col, FL_MEM, ucontact::flags, flags_col, ucontact::instance, instance_col, db_val_t::int_val, last_mod_col, ucontact::last_modified, _str::len, ucontact::methods, methods_col, db_val_t::nul, ucontact::path, path_col, ucontact::q, q_col, ucontact::received, received_col, ucontact::reg_id, reg_id_col, register_udomain(), ucontact::ruid, ruid_col, _str::s, ucontact::sock, sock_col, db_val_t::str_val, db_val_t::time_val, db_val_t::type, use_domain, ucontact::user_agent, user_agent_col, user_col, and db_val_t::val.

Referenced by insert_ucontact(), update_ucontact(), and wb_timer().

Here is the call graph for this function:

Here is the caller graph for this function:

int db_update_ucontact

(

ucontact_t *

_c

)

Parameters:

_c

updated contact

Returns:

0 on success, -1 on failure

Definition at line 546 of file modules_k/p_usrloc/ucontact.c.

References ucontact::aor, db_val_t::bitmap_val, ucontact::c, ucontact::callid, callid_col, ucontact::cflags, contact_col, ucontact::cseq, cseq_col, ucontact::domain, domain_col, db_val_t::double_val, ucontact::expires, expires_col, FL_MEM, ucontact::flags, flags_col, ucontact::instance, instance_col, db_val_t::int_val, last_mod_col, ucontact::last_modified, _str::len, ucontact::methods, methods_col, db_val_t::nul, ucontact::path, path_col, ucontact::q, q_col, ucontact::received, received_col, ucontact::reg_id, reg_id_col, register_udomain(), ucontact::ruid, ruid_col, _str::s, ucontact::sock, sock_col, db_val_t::str_val, db_val_t::time_val, db_val_t::type, use_domain, ucontact::user_agent, user_agent_col, user_col, and db_val_t::val.

Referenced by update_ucontact(), and wb_timer().

Here is the call graph for this function:

Here is the caller graph for this function:

void free_ucontact

(

ucontact_t *

_c

)

Parameters:

_c

freed contact

Definition at line 111 of file modules_k/p_usrloc/ucontact.c.

References ucontact::c, ucontact::callid, ucontact::path, ucontact::received, _str::s, and ucontact::user_agent.

int mem_update_ucontact	(	ucontact_t *	_c,
		ucontact_info_t *	_ci
	)

Parameters:

	_c	contact
	_ci	contact informations

Returns:

0

Parameters:

	_c	contact
	_ci	contact informations

Returns:

0 on success, -1 on failure

Definition at line 184 of file modules_k/p_usrloc/ucontact.c.

References ucontact_info::cflags, ucontact::cflags, ucontact_info::cseq, ucontact::cseq, ucontact_info::expires, ucontact::expires, ucontact_info::flags, ucontact::flags, ucontact_info::last_modified, ucontact::last_modified, _str::len, ucontact_info::methods, ucontact::methods, ucontact::path, ucontact_info::path, ucontact_info::q, ucontact::q, ucontact::received, ucontact_info::received, _str::s, ucontact_info::sock, ucontact::sock, ucontact_info::user_agent, and ucontact::user_agent.

Referenced by update_ucontact().

Here is the caller graph for this function:

ucontact_t* new_ucontact	(	str *	_dom,
		str *	_aor,
		str *	_contact,
		ucontact_info_t *	_ci
	)

Parameters:

	_dom	domain
	_aor	address of record
	_contact	contact string
	_ci	contact informations

Returns:

new created contact on success, 0 on failure

Definition at line 59 of file modules_k/p_usrloc/ucontact.c.

References ucontact::aor, ucontact::c, ucontact_info::callid, ucontact::callid, ucontact_info::cflags, ucontact::cflags, ucontact_info::cseq, ucontact::cseq, ucontact::domain, ucontact_info::expires, ucontact::expires, ucontact_info::flags, ucontact::flags, ucontact::instance, ucontact_info::instance, ucontact_info::last_modified, ucontact::last_modified, _str::len, ucontact_info::methods, ucontact::methods, ucontact::path, ucontact_info::path, ucontact_info::q, ucontact::q, ucontact::received, ucontact_info::received, ucontact_info::reg_id, ucontact::reg_id, ucontact::ruid, ucontact_info::ruid, _str::s, ucontact_info::sock, ucontact::sock, ucontact::state, ucontact_info::user_agent, and ucontact::user_agent.

Referenced by mem_insert_ucontact().

Here is the caller graph for this function:

void print_ucontact	(	FILE *	_f,
		ucontact_t *	_c
	)

Parameters:

	_f	output file
	_c	printed contact

Definition at line 128 of file modules_k/p_usrloc/ucontact.c.

References ucontact::aor, ucontact::c, ucontact::callid, CS_DIRTY, CS_NEW, CS_SYNC, ucontact::cseq, ucontact::domain, ucontact::expires, ucontact::flags, _str::len, ucontact::methods, ucontact::next, ucontact::path, ucontact::prev, ucontact::q, ucontact::received, _str::s, ucontact::sock, ucontact::state, UL_EXPIRED_TIME, and ucontact::user_agent.

int st_delete_ucontact

(

ucontact_t *

_c

)

Parameters:

_c

updated contact

Returns:

1 if the contact should be deleted from memory immediately, 0 otherwise

Definition at line 281 of file modules_k/p_usrloc/ucontact.c.

References CS_DIRTY, CS_NEW, CS_SYNC, db_mode, ucontact::expires, ucontact::state, and WRITE_BACK.

int st_expired_ucontact

(

ucontact_t *

_c

)

Parameters:

_c

expired contact

Returns:

1 if the contact should be removed from the database and 0 otherwise

Definition at line 322 of file modules_k/p_usrloc/ucontact.c.

References CS_DIRTY, CS_NEW, CS_SYNC, and ucontact::state.

int st_flush_ucontact

(

ucontact_t *

_c

)

Parameters:

_c

flushed contact

Returns:

1 if the contact should be inserted, 2 if update and 0 otherwise

Definition at line 351 of file modules_k/p_usrloc/ucontact.c.

References CS_DIRTY, CS_NEW, CS_SYNC, and ucontact::state.

void st_update_ucontact

(

ucontact_t *

_c

)

Parameters:

_c

updated contact

Definition at line 245 of file modules_k/p_usrloc/ucontact.c.

References CS_DIRTY, CS_NEW, CS_SYNC, db_mode, ucontact::state, WRITE_BACK, and WRITE_THROUGH.

int update_ucontact	(	struct urecord *	_r,
		ucontact_t *	_c,
		ucontact_info_t *	_ci
	)

Parameters:

	_r	record the contact belongs to
	_c	updated contact
	_ci	new contact informations

Returns:

0 on success, -1 on failure

Definition at line 811 of file modules_k/p_usrloc/ucontact.c.

References db_insert_ucontact(), db_mode, DB_ONLY, db_update_ucontact(), mem_update_ucontact(), run_ul_callbacks(), st_update_ucontact(), ucontact::state, update_contact_pos(), and WRITE_THROUGH.

Referenced by mi_usrloc_add().

Here is the call graph for this function:

Here is the caller graph for this function: