ul_mi.h File Reference

USRLOC - Usrloc MI functions. More...

#include "../../mi/mi.h"

Include dependency graph for ul_mi.h:

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

Go to the source code of this file.

Defines
#define	MI_USRLOC_ADD   "ul_add"
#define	MI_USRLOC_DUMP   "ul_dump"
#define	MI_USRLOC_FLUSH   "ul_flush"
#define	MI_USRLOC_RM   "ul_rm"
#define	MI_USRLOC_RM_CONTACT   "ul_rm_contact"
#define	MI_USRLOC_SHOW_CONTACT   "ul_show_contact"
Functions
struct mi_root *	mi_usrloc_add (struct mi_root *cmd, void *param)
	Add a new contact for an address of record.
struct mi_root *	mi_usrloc_dump (struct mi_root *cmd, void *param)
	Dump the content of the usrloc.
struct mi_root *	mi_usrloc_flush (struct mi_root *cmd, void *param)
	Flush the usrloc memory cache to DB.
struct mi_root *	mi_usrloc_rm_aor (struct mi_root *cmd, void *param)
	Delete a address of record including its contacts.
struct mi_root *	mi_usrloc_rm_contact (struct mi_root *cmd, void *param)
	Delete a contact from an AOR record.
struct mi_root *	mi_usrloc_show_contact (struct mi_root *cmd, void *param)
	Dumps the contacts of an AOR.

---

Detailed Description

USRLOC - Usrloc MI functions.

Definition in file ul_mi.h.

---

Define Documentation

#define MI_USRLOC_ADD   "ul_add"

Definition at line 38 of file ul_mi.h.

#define MI_USRLOC_DUMP   "ul_dump"

Definition at line 36 of file ul_mi.h.

#define MI_USRLOC_FLUSH   "ul_flush"

Definition at line 37 of file ul_mi.h.

#define MI_USRLOC_RM   "ul_rm"

Definition at line 34 of file ul_mi.h.

#define MI_USRLOC_RM_CONTACT   "ul_rm_contact"

Definition at line 35 of file ul_mi.h.

#define MI_USRLOC_SHOW_CONTACT   "ul_show_contact"

Definition at line 39 of file ul_mi.h.

---

Function Documentation

struct mi_root* mi_usrloc_add	(	struct mi_root *	cmd,
		void *	param
	)			[read]

Add a new contact for an address of record.

Parameters:

	cmd	mi_root containing the parameter
	param	not used

Note:

Expects 7 nodes: table name, AOR, contact, expires, Q, useless - backward compatible, flags, cflags, methods

Returns:

mi_root with the result

Definition at line 450 of file ul_mi.c.

References act_time, ucontact_info::callid, ucontact_info::cflags, ucontact_info::cseq, ucontact_info::expires, ucontact_info::flags, get_act_time(), get_ucontact(), get_urecord(), init_mi_tree(), insert_ucontact(), insert_urecord(), mi_node::kids, _str::len, lock_udomain(), ucontact_info::methods, MI_BAD_PARM_LEN, MI_BAD_PARM_S, mi_find_domain(), mi_fix_aor(), MI_INTERNAL_ERR_LEN, MI_INTERNAL_ERR_S, MI_MISSING_PARM_LEN, MI_MISSING_PARM_S, MI_OK_LEN, MI_OK_S, MI_UL_CSEQ, mi_node::next, mi_root::node, NULL, ucontact_info::q, release_urecord(), _str::s, str2int(), str2q(), unlock_udomain(), update_ucontact(), ucontact_info::user_agent, and mi_node::value.

struct mi_root* mi_usrloc_dump	(	struct mi_root *	cmd,
		void *	param
	)			[read]

Dump the content of the usrloc.

Parameters:

	cmd	mi_root containing the parameter
	param	not used

Returns:

mi_root with the result or 0 on failure

Definition at line 342 of file ul_mi.c.

References add_mi_attr(), add_mi_node_child(), dlist::d, hslot::first, free_mi_tree(), init_mi_tree(), int2str(), mi_node::kids, _str::len, len, lock_ulslot(), max, mi_add_aor_node(), MI_DUP_VALUE, MI_MISSING_PARM_LEN, MI_MISSING_PARM_S, MI_OK_LEN, MI_OK_S, hslot::n, dlist::name, urecord::next, dlist::next, mi_node::next, mi_root::node, NULL, root, _str::s, udomain::size, table, udomain::table, unlock_ulslot(), and mi_node::value.

struct mi_root* mi_usrloc_flush	(	struct mi_root *	cmd,
		void *	param
	)			[read]

Flush the usrloc memory cache to DB.

Parameters:

	cmd	mi_root containing the parameter
	param	not used

Returns:

mi_root with the result or 0 on failure

Definition at line 429 of file ul_mi.c.

References init_mi_tree(), MI_OK_LEN, MI_OK_S, NULL, and synchronize_all_udomains().

struct mi_root* mi_usrloc_rm_aor	(	struct mi_root *	cmd,
		void *	param
	)			[read]

Delete a address of record including its contacts.

Parameters:

	cmd	mi_root containing the parameter
	param	not used

Note:

expects 2 nodes: the table name and the AOR

Returns:

mi_root with the result

Definition at line 244 of file ul_mi.c.

References delete_urecord(), init_mi_tree(), mi_node::kids, lock_udomain(), mi_find_domain(), mi_fix_aor(), MI_MISSING_PARM_LEN, MI_MISSING_PARM_S, MI_OK_LEN, MI_OK_S, mi_node::next, mi_root::node, NULL, unlock_udomain(), and mi_node::value.

struct mi_root* mi_usrloc_rm_contact	(	struct mi_root *	cmd,
		void *	param
	)			[read]

Delete a contact from an AOR record.

Parameters:

	cmd	mi_root containing the parameter
	param	not used

Note:

expects 3 nodes: the table name, the AOR and contact

Returns:

mi_root with the result or 0 on failure

Definition at line 282 of file ul_mi.c.

References delete_ucontact(), get_ucontact(), get_urecord(), init_mi_tree(), mi_node::kids, lock_udomain(), mi_find_domain(), mi_fix_aor(), MI_MISSING_PARM_LEN, MI_MISSING_PARM_S, MI_OK_LEN, MI_OK_S, MI_UL_CSEQ, mi_node::next, mi_root::node, NULL, release_urecord(), unlock_udomain(), and mi_node::value.

struct mi_root* mi_usrloc_show_contact	(	struct mi_root *	cmd,
		void *	param
	)			[read]

Dumps the contacts of an AOR.

Parameters:

	cmd	mi_root containing the parameter
	param	not used

Note:

expects 2 nodes: the table name and the AOR

Returns:

mi_root with the result or 0 on failure

Definition at line 564 of file ul_mi.c.

References act_time, addf_mi_node_child(), ucontact::c, ucontact::cflags, urecord::contacts, ucontact::expires, ucontact::flags, free_mi_tree(), get_act_time(), get_urecord(), init_mi_tree(), mi_node::kids, _str::len, lock_udomain(), ucontact::methods, mi_find_domain(), mi_fix_aor(), MI_MISSING_PARM_LEN, MI_MISSING_PARM_S, MI_OK_LEN, MI_OK_S, ucontact::next, mi_node::next, mi_root::node, NULL, ucontact::path, ucontact::q, q2str(), ucontact::received, _str::s, ucontact::sock, socket_info::sock_str, unlock_udomain(), ucontact::user_agent, VALID_CONTACT, mi_node::value, and ZSW.