Files
asterisk/include/asterisk/dnsmgr.h
T
Richard Mudgett 2b3e28f88c Fix dnsmgr entries to ask for the same address family each time.
The dnsmgr refresh would always get the first address found regardless of
the original address family requested.  So if you asked for only IPv4
addresses originally, you might get an IPv6 address on refresh.

* Saved the original address family requested by ast_dnsmgr_lookup() to be
used when the address is refreshed.
........

Merged revisions 345976 from http://svn.asterisk.org/svn/asterisk/branches/1.8
........

Merged revisions 345977 from http://svn.asterisk.org/svn/asterisk/branches/10


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@345978 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2011-11-22 23:06:11 +00:00

130 lines
4.1 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 1999 - 2005, Digium, Inc.
*
* Kevin P. Fleming <kpfleming@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 Background DNS update manager
*/
#ifndef _ASTERISK_DNSMGR_H
#define _ASTERISK_DNSMGR_H
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
#include "asterisk/netsock2.h"
#include "asterisk/srv.h"
/*!
* \brief A DNS manager entry
*
* This is an opaque type.
*/
struct ast_dnsmgr_entry;
/*!
* \brief Allocate a new DNS manager entry
*
* \param name the hostname
* \param result where the DNS manager should store the IP address as it refreshes it.
* \param service
*
* \details
* This function allocates a new DNS manager entry object, and fills it with the
* provided hostname and IP address. This function does not force an initial lookup
* of the IP address. So, generally, this should be used when the initial address
* is already known.
*
* \return a DNS manager entry
* \version 1.6.1 result changed from struct in_addr to struct sockaddr_in to store port number
* \version 1.8.0 result changed from struct ast_sockaddr_in to ast_sockaddr for IPv6 support
*/
struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct ast_sockaddr *result, const char *service);
/*!
* \brief Allocate a new DNS manager entry
*
* \param name the hostname
* \param result where the DNS manager should store the IP address as it refreshes it.
* \param service
* \param family Address family to filter DNS addresses.
*
* \details
* This function allocates a new DNS manager entry object, and fills it with the
* provided hostname and IP address. This function does not force an initial lookup
* of the IP address. So, generally, this should be used when the initial address
* is already known.
*
* \return a DNS manager entry
*/
struct ast_dnsmgr_entry *ast_dnsmgr_get_family(const char *name, struct ast_sockaddr *result, const char *service, unsigned int family);
/*!
* \brief Free a DNS manager entry
*
* \param entry the DNS manager entry to free
*
* \return nothing
*/
void ast_dnsmgr_release(struct ast_dnsmgr_entry *entry);
/*!
* \brief Allocate and initialize a DNS manager entry
*
* \param name the hostname
* \param result where to store the IP address as the DNS manager refreshes it.
* The address family is used as an input parameter to filter the returned addresses.
* If it is 0, both IPv4 and IPv6 addresses can be returned.
* \param dnsmgr Where to store the allocate DNS manager entry
* \param service
*
* \note
* This function allocates a new DNS manager entry object, and fills it with
* the provided hostname and IP address. This function _does_ force an initial
* lookup, so it may block for some period of time.
*
* \retval 0 success
* \retval non-zero failure
* \version 1.6.1 result changed from struct in_addr to struct aockaddr_in to store port number
*/
int ast_dnsmgr_lookup(const char *name, struct ast_sockaddr *result, struct ast_dnsmgr_entry **dnsmgr, const char *service);
/*!
* \brief Force a refresh of a dnsmgr entry
*
* \retval non-zero if the result is different than the previous result
* \retval zero if the result is the same as the previous result
*/
int ast_dnsmgr_refresh(struct ast_dnsmgr_entry *entry);
/*!
* \brief Check is see if a dnsmgr entry has changed
*
* \retval non-zero if the dnsmgr entry has changed since the last call to
* this function
* \retval zero if the dnsmgr entry has not changed since the last call to
* this function
*/
int ast_dnsmgr_changed(struct ast_dnsmgr_entry *entry);
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif /* c_plusplus */
#endif /* ASTERISK_DNSMGR_H */