This adds DNS SRV record support to DNS manager. If there is a SRV record for a...
[asterisk/asterisk.git] / include / asterisk / dnsmgr.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Kevin P. Fleming <kpfleming@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 /*! \file
20  * \brief Background DNS update manager
21  */
22
23 #ifndef _ASTERISK_DNSMGR_H
24 #define _ASTERISK_DNSMGR_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 #include "asterisk/network.h"
31 #include "asterisk/srv.h"
32
33 /*!
34  * \brief A DNS manager entry
35  *
36  * This is an opaque type.
37  */
38 struct ast_dnsmgr_entry;
39
40 /*!
41  * \brief Allocate a new DNS manager entry
42  *
43  * \arg name the hostname
44  * \arg result where the DNS manager should store the IP address as it refreshes it.
45  *      it.
46  *
47  * This function allocates a new DNS manager entry object, and fills it with the
48  * provided hostname and IP address.  This function does not force an initial lookup
49  * of the IP address.  So, generally, this should be used when the initial address
50  * is already known.
51  *
52  * \return a DNS manager entry
53  */
54 struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct sockaddr_in *result, const char *service);
55
56 /*!
57  * \brief Free a DNS manager entry
58  *
59  * \arg entry the DNS manager entry to free
60  *
61  * \return nothing
62  */
63 void ast_dnsmgr_release(struct ast_dnsmgr_entry *entry);
64
65 /*!
66  * \brief Allocate and initialize a DNS manager entry
67  *
68  * \arg name the hostname
69  * \arg result where to store the IP address as the DNS manager refreshes it
70  * \arg dnsmgr Where to store the allocate DNS manager entry
71  *
72  * This function allocates a new DNS manager entry object, and fills it with
73  * the provided hostname and IP address.  This function _does_ force an initial
74  * lookup, so it may block for some period of time.
75  *
76  * \retval 0 success
77  * \retval non-zero failure
78  */
79 int ast_dnsmgr_lookup(const char *name, struct sockaddr_in *result, struct ast_dnsmgr_entry **dnsmgr, const char *service);
80
81 /*!
82  * \brief Force a refresh of a dnsmgr entry
83  *
84  * \retval non-zero if the result is different than the previous result
85  * \retval zero if the result is the same as the previous result 
86  */
87 int ast_dnsmgr_refresh(struct ast_dnsmgr_entry *entry);
88
89 /*!
90  * \brief Check is see if a dnsmgr entry has changed
91  *
92  * \retval non-zero if the dnsmgr entry has changed since the last call to
93  *                  this function
94  * \retval zero     if the dnsmgr entry has not changed since the last call to
95  *                  this function
96  */
97 int ast_dnsmgr_changed(struct ast_dnsmgr_entry *entry);
98
99 #if defined(__cplusplus) || defined(c_plusplus)
100 }
101 #endif /* c_plusplus */
102
103 #endif /* ASTERISK_DNSMGR_H */