sresolv  1.13.16
sres.h
Go to the documentation of this file.
1 /*
2  * This file is part of the Sofia-SIP package
3  *
4  * Copyright (C) 2005 Nokia Corporation.
5  *
6  * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation; either version 2.1 of
11  * the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21  * 02110-1301 USA
22  *
23  */
24 
25 #ifndef SOFIA_RESOLV_SRES_H
27 #define SOFIA_RESOLV_SRES_H
45 #include <stdarg.h>
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 enum {
55 #define SRES_RETRANSMIT_INTERVAL (SRES_RETRANSMIT_INTERVAL)
56 
59 #define SRES_RETRY_INTERVAL (SRES_RETRY_INTERVAL)
60 
63 #define SRES_MAX_RETRY_COUNT (SRES_MAX_RETRY_COUNT)
64 
67 #define SRES_MAX_SEARCH (SRES_MAX_SEARCH)
68 
71 #define SRES_MAX_NAMESERVERS (SRES_MAX_NAMESERVERS)
72 
74  SRES_MAXDNAME = 1025,
75 #define SRES_MAXDNAME (SRES_MAXDNAME)
76 
79 #define SRES_MAX_SORTLIST (SRES_MAX_SORTLIST)
80 };
81 
82 #ifndef SRES_RECORD_T
83 #define SRES_RECORD_T
85 typedef union sres_record sres_record_t;
86 #endif
87 
88 #ifndef SRES_CACHE_T
89 #define SRES_CACHE_T
91 typedef struct sres_cache sres_cache_t;
92 #endif
93 
95 typedef struct sres_resolver_s sres_resolver_t;
96 
97 #ifndef SRES_CONTEXT_T
98 #define SRES_CONTEXT_T struct sres_context_s
99 #endif
101 typedef SRES_CONTEXT_T sres_context_t;
102 
104 typedef struct sres_query_s sres_query_t;
105 
106 struct sockaddr;
107 
109 SRESPUBFUN sres_resolver_t *sres_resolver_new(char const *resolv_conf_path);
110 
113 
117 sres_resolver_new_with_cache(char const *conf_file_path,
118  sres_cache_t *cache,
119  char const *options, ...);
120 
124 sres_resolver_new_with_cache_va(char const *conf_file_path,
125  sres_cache_t *cache,
126  char const *options, va_list va);
127 
130 
133 
136 
138 SRESPUBFUN int sres_resolver_update(sres_resolver_t *res, int always);
139 
142 void *sres_resolver_set_userdata(sres_resolver_t *res, void *userdata);
143 
147 
154 typedef void sres_answer_f(sres_context_t *context,
155  sres_query_t *query,
156  sres_record_t **answers);
157 
161  sres_answer_f *callback,
162  sres_context_t *context,
163  uint16_t type,
164  char const *domain);
165 
169  sres_answer_f *callback,
170  sres_context_t *context,
171  uint16_t type,
172  char const *name);
173 
177  sres_answer_f *callback,
178  sres_context_t *context,
179  uint16_t type,
180  struct sockaddr const *addr);
181 
185  sres_answer_f *callback,
186  sres_context_t *context,
187  int dummy,
188  uint16_t type,
189  char const *domain);
190 
194  sres_answer_f *callback,
195  sres_context_t *context,
196  int dummy,
197  uint16_t type,
198  struct sockaddr const *addr);
199 
203  sres_answer_f *callback,
204  sres_context_t *context);
205 
209  uint16_t type,
210  char const *domain);
211 
215  uint16_t type,
216  char const *name);
217 
221  uint16_t type,
222  struct sockaddr const *addr);
223 
227  char const *domain,
228  char const *target,
229  uint16_t port,
230  uint32_t newttl,
231  uint16_t newprio);
232 
233 
237  uint16_t type,
238  char const *domain,
239  int ignore_cache,
240  sres_record_t ***return_records);
241 
245  uint16_t type,
246  char const *name,
247  int ignore_cache,
248  sres_record_t ***return_records);
249 
253  uint16_t type,
254  struct sockaddr const *addr,
255  int ignore_cache,
256  sres_record_t ***return_records);
257 
260 
263 
267  sres_record_t **answers,
268  uint16_t type);
269 
272 
275 
276 #ifdef __cplusplus
277 }
278 #endif
279 
280 #endif /* SOFIA_RESOLV_SRES_H */
struct sres_query_s sres_query_t
Opaque type of DNS query object.
Definition: sres.h:104
SRESPUBFUN sres_query_t * sres_query(sres_resolver_t *res, sres_answer_f *callback, sres_context_t *context, uint16_t type, char const *domain)
Make a DNS query.
Definition: sres.c:969
SRESPUBFUN sres_resolver_t * sres_resolver_ref(sres_resolver_t *res)
Increase reference count on a resolver object.
Definition: sres.c:819
SRESPUBFUN int sres_blocking_query(sres_resolver_t *res, uint16_t type, char const *domain, int ignore_cache, sres_record_t ***return_records)
Send a query, wait for answer, return results.
Definition: sres_blocking.c:292
SRESPUBFUN void sres_query_bind(sres_query_t *q, sres_answer_f *callback, sres_context_t *context)
Rebind a DNS query.
Definition: sres.c:1227
SRESPUBFUN sres_query_t * sres_query_sockaddr(sres_resolver_t *res, sres_answer_f *callback, sres_context_t *context, uint16_t type, struct sockaddr const *addr)
Make a reverse DNS query.
Definition: sres.c:1164
struct sres_cache sres_cache_t
Opaque type of DNS cache object.
Definition: sres.h:91
SRESPUBFUN void * sres_resolver_set_userdata(sres_resolver_t *res, void *userdata)
Set userdata pointer.
Definition: sres.c:839
SRESPUBFUN int sres_filter_answers(sres_resolver_t *res, sres_record_t **answers, uint16_t type)
Filter and sort the list of records.
Definition: sres.c:1469
SRESPUBFUN sres_resolver_t * sres_resolver_new(char const *resolv_conf_path)
New resolver object.
Definition: sres.c:624
SRESPUBFUN sres_query_t * sres_query_make(sres_resolver_t *res, sres_answer_f *callback, sres_context_t *context, int dummy, uint16_t type, char const *domain)
Make a DNS query with socket.
Definition: sres.c:1187
SRESPUBFUN sres_resolver_t * sres_resolver_copy(sres_resolver_t *)
Copy a resolver.
Definition: sres.c:634
SRESPUBFUN int sres_resolver_update(sres_resolver_t *res, int always)
Re-read resolv.conf if needed.
Definition: sres.c:1962
void sres_answer_f(sres_context_t *context, sres_query_t *query, sres_record_t **answers)
Prototype for callback function.
Definition: sres.h:154
SRESPUBFUN sres_record_t ** sres_cached_answers_sockaddr(sres_resolver_t *res, uint16_t type, struct sockaddr const *addr)
Get a list of matching (type/domain) records from cache.
Definition: sres.c:1373
SRESPUBFUN int sres_sort_answers(sres_resolver_t *, sres_record_t **answers)
Sort the list of records.
Definition: sres.c:1435
SRESPUBFUN sres_query_t * sres_query_make_sockaddr(sres_resolver_t *res, sres_answer_f *callback, sres_context_t *context, int dummy, uint16_t type, struct sockaddr const *addr)
Make a reverse DNS query with socket.
Definition: sres.c:1202
@ SRES_MAX_SORTLIST
Maximum length of sortlist.
Definition: sres.h:78
@ SRES_MAXDNAME
Maximum length of domain name.
Definition: sres.h:74
@ SRES_MAX_SEARCH
Maximum number of search domains.
Definition: sres.h:66
@ SRES_RETRANSMIT_INTERVAL
Resolver timer interval in milliseconds.
Definition: sres.h:54
@ SRES_RETRY_INTERVAL
Initial retry interval in seconds.
Definition: sres.h:58
@ SRES_MAX_NAMESERVERS
Maximum number of nameservers.
Definition: sres.h:70
@ SRES_MAX_RETRY_COUNT
Maximum number of retries sent.
Definition: sres.h:62
SRESPUBFUN void sres_resolver_unref(sres_resolver_t *res)
Decrease the reference count on a resolver object.
Definition: sres.c:826
struct sres_resolver_s sres_resolver_t
Opaque type of DNS resolver object.
Definition: sres.h:95
SRESPUBFUN int sres_is_blocking(sres_resolver_t *res)
Return true (and set resolver in blocking mode) if resolver can block.
Definition: sres_blocking.c:254
SRESPUBFUN void sres_free_answers(sres_resolver_t *, sres_record_t **answers)
Free the list records.
Definition: sres.c:1508
struct sres_context_s sres_context_t
Application-defined type for sres_query_t context.
Definition: sres.h:101
SRESPUBFUN int sres_blocking_query_sockaddr(sres_resolver_t *res, uint16_t type, struct sockaddr const *addr, int ignore_cache, sres_record_t ***return_records)
Send a a reverse DNS query, wait for answer, return results.
Definition: sres_blocking.c:414
SRESPUBFUN sres_resolver_t * sres_resolver_new_with_cache(char const *conf_file_path, sres_cache_t *cache, char const *options,...)
New resolver object.
Definition: sres.c:678
SRESPUBFUN sres_query_t * sres_search(sres_resolver_t *res, sres_answer_f *callback, sres_context_t *context, uint16_t type, char const *name)
Search DNS.
Definition: sres.c:1034
SRESPUBFUN sres_record_t ** sres_search_cached_answers(sres_resolver_t *res, uint16_t type, char const *name)
Search for a list of matching (type/name) records from cache.
Definition: sres.c:1286
SRESPUBFUN sres_resolver_t * sres_resolver_new_with_cache_va(char const *conf_file_path, sres_cache_t *cache, char const *options, va_list va)
New resolver object.
Definition: sres.c:697
SRESPUBFUN void * sres_resolver_get_userdata(sres_resolver_t const *res)
Get userdata pointer.
Definition: sres.c:860
SRESPUBFUN int sres_blocking_search(sres_resolver_t *res, uint16_t type, char const *name, int ignore_cache, sres_record_t ***return_records)
Search DNS, return results.
Definition: sres_blocking.c:356
SRESPUBFUN sres_record_t ** sres_cached_answers(sres_resolver_t *res, uint16_t type, char const *domain)
Get a list of matching (type/domain) records from cache.
Definition: sres.c:1250
SRESPUBFUN void sres_resolver_clean_cache(sres_resolver_t *res)
Clean cache of a resolver object.
Definition: sres.c:807
SRESPUBFUN void sres_free_answer(sres_resolver_t *res, sres_record_t *answer)
Free and zero one record.
Definition: sres.c:1496
SRESPUBFUN int sres_set_cached_srv_priority(sres_resolver_t *res, char const *domain, char const *target, uint16_t port, uint32_t newttl, uint16_t newprio)
Modify the priority of the specified SRV records.
Definition: sres.c:1410
Configuration for Sofia DNS Resolver.
#define SRESPUBFUN
SRESPUBFUN declares an exported function.
Definition: sres_config.h:41
SU_U32_T uint32_t
SU_U16_T uint16_t
Union of different DNS records.
Definition: sres_record.h:180

Sofia-SIP 1.13.16 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.