resolver.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJLIB_UTIL_RESOLVER_H__
#define __PJLIB_UTIL_RESOLVER_H__
 
#include <pjlib-util/dns.h>
 
 
PJ_BEGIN_DECL
 
 
typedef struct pj_dns_resolver pj_dns_resolver;
 
typedef struct pj_dns_async_query pj_dns_async_query;
 
typedef void pj_dns_callback(void *user_data,
                             pj_status_t status,
                             pj_dns_parsed_packet *response);
 
 
typedef struct pj_dns_settings
{
    unsigned    options;        
    unsigned    qretr_delay;    
    unsigned    qretr_count;    
    unsigned    cache_max_ttl;  
    unsigned    good_ns_ttl;    
    unsigned    bad_ns_ttl;     
} pj_dns_settings;
 
 
typedef struct pj_dns_a_record
{
    pj_str_t            name;
 
    pj_str_t            alias;
 
    unsigned            addr_count;
 
    pj_in_addr          addr[PJ_DNS_MAX_IP_IN_A_REC];
 
    char                buf_[128];
 
} pj_dns_a_record;
 
 
typedef struct pj_dns_addr_record
{
    pj_str_t            name;
 
    pj_str_t            alias;
 
    unsigned            addr_count;
 
    struct {
 
        int             af;
        
        union {
            pj_in_addr  v4;
 
            pj_in6_addr v6;
        } ip;
 
    } addr[PJ_DNS_MAX_IP_IN_A_REC];
 
    char                buf_[128];
 
} pj_dns_addr_record;
 
 
PJ_DECL(void) pj_dns_settings_default(pj_dns_settings *s);
 
 
PJ_DECL(pj_status_t) pj_dns_resolver_create(pj_pool_factory *pf,
                                            const char *name,
                                            unsigned options,
                                            pj_timer_heap_t *timer,
                                            pj_ioqueue_t *ioqueue,
                                            pj_dns_resolver **p_resolver);
 
 
PJ_DECL(pj_status_t) pj_dns_resolver_set_ns(pj_dns_resolver *resolver,
                                            unsigned count,
                                            const pj_str_t servers[],
                                            const pj_uint16_t ports[]);
 
 
PJ_DECL(pj_status_t) pj_dns_resolver_get_settings(pj_dns_resolver *resolver,
                                                  pj_dns_settings *st);
 
 
PJ_DECL(pj_status_t) pj_dns_resolver_set_settings(pj_dns_resolver *resolver,
                                                  const pj_dns_settings *st);
 
 
PJ_DECL(void) pj_dns_resolver_handle_events(pj_dns_resolver *resolver,
                                            const pj_time_val *timeout);
 
 
PJ_DECL(pj_status_t) pj_dns_resolver_destroy(pj_dns_resolver *resolver,
                                             pj_bool_t notify);
 
 
PJ_DECL(pj_status_t) pj_dns_resolver_start_query(pj_dns_resolver *resolver,
                                                 const pj_str_t *name,
                                                 int type,
                                                 unsigned options,
                                                 pj_dns_callback *cb,
                                                 void *user_data,
                                                 pj_dns_async_query **p_query);
 
PJ_DECL(pj_status_t) pj_dns_resolver_cancel_query(pj_dns_async_query *query,
                                                  pj_bool_t notify);
 
PJ_DECL(pj_status_t) pj_dns_parse_a_response(const pj_dns_parsed_packet *pkt,
                                             pj_dns_a_record *rec);
 
 
PJ_DECL(pj_status_t) pj_dns_parse_addr_response(
                                            const pj_dns_parsed_packet *pkt,
                                            pj_dns_addr_record *rec);
 
 
PJ_DECL(pj_status_t) pj_dns_resolver_add_entry(pj_dns_resolver *resolver,
                                               const pj_dns_parsed_packet *pkt,
                                               pj_bool_t set_ttl);
 
PJ_DECL(unsigned) pj_dns_resolver_get_cached_count(pj_dns_resolver *resolver);
 
 
PJ_DECL(void) pj_dns_resolver_dump(pj_dns_resolver *resolver,
                                   pj_bool_t detail);
 
 
PJ_END_DECL
 
 
#endif  /* __PJLIB_UTIL_RESOLVER_H__ */