155 lines
5.4 KiB
C
155 lines
5.4 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;
|
|
|
|
typedef void (*dns_update_func)(struct ast_sockaddr *old_addr, struct ast_sockaddr *new_addr, void *data);
|
|
|
|
/*!
|
|
* \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
|
|
*/
|
|
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 Allocate and initialize a DNS manager entry, with update callback
|
|
*
|
|
* \param name the hostname
|
|
* \param result The addr which is intended to be updated in the update callback when DNS manager calls it on refresh.
|
|
* 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
|
|
* \param func The update callback function
|
|
* The update callback will be called when DNS manager detects that an IP address has been changed.
|
|
* Instead of updating the addr itself, DNS manager will call this callback function with the old
|
|
* and new addresses. It is the responsibility of the callback to perform any updates
|
|
* \param data A pointer to data that will be passed through to the callback function
|
|
*
|
|
* \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
|
|
*/
|
|
int ast_dnsmgr_lookup_cb(const char *name, struct ast_sockaddr *result, struct ast_dnsmgr_entry **dnsmgr, const char *service, dns_update_func func, void *data);
|
|
|
|
/*!
|
|
* \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 */
|