core: Make sure that responses to requests received on a WebSocket are sent on existi...
[sip-router] / id.h
1 /*
2  * $Id$
3  *
4  * Copyright (C) 2005 iptelorg GmbH
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License 
24  * along with this program; if not, write to the Free Software 
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  *
27  */
28
29 #ifndef _ID_H
30 #define _ID_H
31
32 #include "str.h"
33 #include "usr_avp.h"
34 #include "parser/msg_parser.h"
35
36
37 /*
38  * Set From UID
39  */
40 int set_from_uid(str* uid);
41
42
43 /*
44  * Get From UID
45  */
46 int get_from_uid(str* uid, struct sip_msg* msg);
47
48 /*
49  * Set To UID
50  */
51 int set_to_uid(str* uid);
52
53
54 /*
55  * Ge To UID
56  */
57 int get_to_uid(str* uid, struct sip_msg* msg);
58
59
60 /** Retrieves the UID of the callee. This function retrieves the UID (unique
61  * identifier) of the party being called. The function first searches the list
62  * of available attributes and if it finds an attribute with name "uid" then
63  * the value of the attribute is returned.  If no such attribute can be found
64  * then the function retrieves the username from To header field of REGISTER
65  * requests (because that is the party being registered), or the username from
66  * the Reqeuest-URI of other requests. The username is then used as the UID
67  * string identifying the callee. If no attribute with the UID was found and
68  * the function successfully retrieved the UID from the SIP message then, in
69  * addition to storing the result in the first parameter, the function will
70  * also create the attribute named "uid" which will contain the UID. The
71  * function is not reentrant because it uses an internal static buffer to
72  * store the result.
73  * @param uid A pointer to ::str variable where the result will be stored, the
74  *            pointer in the variable will be updated to point to a static
75  *            buffer in the function.  
76  * @param msg The SIP message being processed.  
77  * @return 1 is returned when the attribute with UID exists and it is used, 0
78  *         is returned when the function retrieved the UID from the SIP
79  *         message and created the attribute, -1 is returned on error.
80  */
81 int get_to_did(str* did, struct sip_msg* msg);
82
83
84 /*
85  * Return current From domain id
86  */
87 int get_from_did(str* did, struct sip_msg* msg);
88
89
90 #endif /* _ID_H */