modules_k/p_usrloc/ucontact.h File Reference

USRLOC - Usrloc contact structure. More...

#include <stdio.h>
#include <time.h>
#include "../../qvalue.h"
#include "../../str.h"
#include "../usrloc/usrloc.h"

Include dependency graph for modules_k/p_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/p_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.

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.

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.

void free_ucontact

(

ucontact_t *

_c

)

Parameters:

_c

freed contact

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

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.

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.

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.

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.

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.

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.

void st_update_ucontact

(

ucontact_t *

_c

)

Parameters:

_c

updated contact

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

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.