1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
* $Id$
*
* Copyright (C) 2001-2003 FhG Fokus
*
* This file is part of Kamailio, a free SIP server.
*
* Kamailio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version
*
* Kamailio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* History:
* ---------
* 2003-03-12 added replication mark and three zombie states (nils)
* 2005-07-11 added FL_NAT_SIPPING for nat pinging with SIP method
* instead of UDP package (bogdan)
*/
/*! \file
* \brief USRLOC - Usrloc contact structure
* \ingroup usrloc
*/
#ifndef UCONTACT_H
#define UCONTACT_H
#include <stdio.h>
#include "../../xavp.h"
#include "usrloc.h"
/*! \brief ancient time used for marking the contacts forced to expired */
#define UL_EXPIRED_TIME 10
/*!
* \brief Create a new contact structure
* \param _dom domain
* \param _aor address of record
* \param _contact contact string
* \param _ci contact informations
* \return new created contact on success, 0 on failure
*/
ucontact_t* new_ucontact(str* _dom, str* _aor, str* _contact,
ucontact_info_t* _ci);
/*!
* \brief Free all memory associated with given contact structure
* \param _c freed contact
*/
void free_ucontact(ucontact_t* _c);
/*!
* \brief Print contact, for debugging purposes only
* \param _f output file
* \param _c printed contact
*/
void print_ucontact(FILE* _f, ucontact_t* _c);
/*!
* \brief Update existing contact in memory with new values
* \param _c contact
* \param _ci contact informations
* \return 0
*/
int mem_update_ucontact(ucontact_t* _c, ucontact_info_t *_ci);
/* ===== State transition functions - for write back cache scheme ======== */
/*!
* \brief Update state of the contact if we are using write-back scheme
* \param _c updated contact
*/
void st_update_ucontact(ucontact_t* _c);
/*!
* \brief Update state of the contact
* \param _c updated contact
* \return 1 if the contact should be deleted from memory immediately, 0 otherwise
*/
int st_delete_ucontact(ucontact_t* _c);
/*!
* \brief Called when the timer is about to delete an expired contact
* \param _c expired contact
* \return 1 if the contact should be removed from the database and 0 otherwise
*/
int st_expired_ucontact(ucontact_t* _c);
/*!
* \brief Called when the timer is about flushing the contact, updates contact state
* \param _c flushed contact
* \return 1 if the contact should be inserted, 2 if update and 0 otherwise
*/
int st_flush_ucontact(ucontact_t* _c);
/* ==== Database related functions ====== */
/*!
* \brief Insert contact into the database
* \param _c inserted contact
* \return 0 on success, -1 on failure
*/
int db_insert_ucontact(ucontact_t* _c);
/*!
* \brief Update contact in the database
* \param _c updated contact
* \return 0 on success, -1 on failure
*/
int db_update_ucontact(ucontact_t* _c);
/*!
* \brief Delete contact from the database
* \param _c deleted contact
* \return 0 on success, -1 on failure
*/
int db_delete_ucontact(ucontact_t* _c);
/* ====== Module interface ====== */
/*!
* \brief Update ucontact with new values
* \param _r record the contact belongs to
* \param _c updated contact
* \param _ci new contact informations
* \return 0 on success, -1 on failure
*/
int update_ucontact(struct urecord* _r, ucontact_t* _c, ucontact_info_t* _ci);
/* ====== per contact attributes ====== */
/*!
* \brief Load all location attributes from a udomain
*
* Load all location attributes from a udomain, useful to populate the
* memory cache on startup.
* \param _dname loaded domain name
* \param _user sip username
* \param _domain sip domain
* \param _ruid usrloc record unique id
* \return 0 on success, -1 on failure
*/
int uldb_delete_attrs(str* _dname, str *_user, str *_domain, str *_ruid);
/*!
* \brief Insert contact attributes into the database
* \param _dname loaded domain name
* \param _user sip username
* \param _domain sip domain
* \param _ruid record unique id
* \param _xhead head of xavp list
* \return 0 on success, -1 on failure
*/
int uldb_insert_attrs(str *_dname, str *_user, str *_domain,
str *_ruid, sr_xavp_t *_xhead);
#endif
|
