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
|
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2015, Digium, Inc.
*
* Joshua Colp <jcolp@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
* \brief DNS Resolver API
* \author Joshua Colp <jcolp@digium.com>
*/
#ifndef _ASTERISK_DNS_RESOLVER_H
#define _ASTERISK_DNS_RESOLVER_H
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
/*! \brief DNS resolver implementation */
struct ast_dns_resolver {
/*! \brief The name of the resolver implementation */
const char *name;
/*! \brief Priority for this resolver if multiple exist, lower being higher priority */
unsigned int priority;
/*!
* \brief Perform resolution of a DNS query
*
* \note The reference count of the query should be increased and released
* upon the query completing or being successfully cancelled
*/
int (*resolve)(struct ast_dns_query *query);
/*! \brief Cancel resolution of a DNS query */
int (*cancel)(struct ast_dns_query *query);
/*! \brief Linked list information */
AST_RWLIST_ENTRY(ast_dns_resolver) next;
};
/*!
* \brief Set resolver specific data on a query
*
* \param query The DNS query
* \param data The resolver specific data
*
* \note The resolver data MUST be an ao2 object
*
* \note This function increments the reference count of the resolver data, it does NOT steal
*
* \note Once resolver specific data has been set it can not be changed
*
* \retval 0 success
* \retval -1 failure, resolver data is already set
*/
int ast_dns_resolver_set_data(struct ast_dns_query *query, void *data);
/*!
* \brief Retrieve resolver specific data
*
* \param query The DNS query
*
* \return the resolver specific data
*
* \note The reference count of the resolver data is NOT incremented on return
*/
void *ast_dns_resolver_get_data(const struct ast_dns_query *query);
/*!
* \brief Set result information for a DNS query
*
* \param query The DNS query
* \param result Whether the result is secured or not
* \param bogus Whether the result is bogus or not
* \param rcode Optional response code
* \param canonical The canonical name
* \param answer The raw DNS answer
* \param answer_size The size of the raw DNS answer
*
* Zero-sized and NULL answers are permitted by this function. This may be
* necessary if the query fails at an early stage and no actual DNS response
* has been received from a DNS server.
*
* \retval 0 success
* \retval -1 failure
*/
int ast_dns_resolver_set_result(struct ast_dns_query *query, unsigned int secure, unsigned int bogus,
unsigned int rcode, const char *canonical, const char *answer, size_t answer_size);
/*!
* \brief Add a DNS record to the result of a DNS query
*
* \param query The DNS query
* \param rr_type Resource record type
* \param rr_class Resource record class
* \param ttl TTL of the record
* \param data The raw DNS record
* \param size The size of the raw DNS record
*
* \retval 0 success
* \retval -1 failure
*/
int ast_dns_resolver_add_record(struct ast_dns_query *query, int rr_type, int rr_class, int ttl, const char *data, const size_t size);
/*!
* \brief Mark a DNS query as having been completed
*
* \param query The DNS query
*/
void ast_dns_resolver_completed(struct ast_dns_query *query);
/*!
* \brief Register a DNS resolver
*
* \param resolver A DNS resolver implementation
*
* \retval 0 success
* \retval -1 failure
*/
int ast_dns_resolver_register(struct ast_dns_resolver *resolver);
/*!
* \brief Unregister a DNS resolver
*
* \param resolver A DNS resolver implementation
*/
void ast_dns_resolver_unregister(struct ast_dns_resolver *resolver);
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif
#endif /* _ASTERISK_DNS_RESOLVER_H */
|
