extensive ENUM support update, including ENUMLOOKUP() dialplan function (issue #5201...
[asterisk/asterisk.git] / include / asterisk / enum.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*
20  * ENUM support
21  */
22
23 /*!     \file enum.h
24         \brief DNS and ENUM functions
25 */
26
27 #ifndef _ASTERISK_ENUM_H
28 #define _ASTERISK_ENUM_H
29
30 #include "asterisk/channel.h"
31
32 /*! \brief Lookup entry in ENUM Returns 1 if found, 0 if not found, -1 on hangup
33         \param chan     Channel
34        \param number   E164 number with or without the leading +
35         \param location Number returned (or SIP uri)
36         \param maxloc   Max length
37         \param tech     Technology (from url scheme in response)
38         \param maxtech  Max length
39        \param tech     Technology (from url scheme in response)
40                        You can set it to get particular answer RR, if there are many techs in DNS response, example: "sip"
41                        If you need any record, then set it to empty string
42        \param maxtech  Max length
43        \param suffix   Zone suffix (if is NULL then use enum.conf 'search' variable)
44        \param options  Options ('c' to count number of NAPTR RR, or number - the position of required RR in the answer list
45
46 */
47 extern int ast_get_enum(struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology, int maxtech, char* suffix, char* options);
48 /*!     \brief Lookup DNS TXT record (used by app TXTCIDnum
49         \param chan     Channel
50        \param number   E164 number with or without the leading +
51         \param locatio  Number returned (or SIP uri)
52         \param maxloc   Max length of number
53         \param tech     Technology (not used in TXT records)
54         \param maxtech  Max length
55         \param txt      Text string (return value)
56         \param maxtxt   Max length of "txt"
57 */
58 extern int ast_get_txt(struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology, int maxtech, char *txt, int maxtxt);
59
60 extern int ast_enum_init(void);
61 extern int ast_enum_reload(void);
62
63 #endif /* _ASTERISK_ENUM_H */