mirror of
https://github.com/asterisk/asterisk.git
synced 2025-11-03 12:25:35 +00:00
bf0bb7b385
Copied from my review board description: This is a continuation of the API changes documentation started for describing changes between releases. Most of the API changes were pretty simple needing only to be brought to attention via the new "Asterisk API Changes" list. However, if you see anything that needs further explanation feel free to supplement what is there. The current method of documenting is to add (in the header file): \version <ver number> <description of changes> and then to add the function to the change list in doxyref.h on the AstAPIChanges page. I also made sure all the functions that were newly added were tagged with \since 1.6.1. I think this is a good habit to start both for the historical aspect as well as for the future ability to easily add a "New Asterisk API" page. Review: http://reviewboard.digium.com/r/190/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@180719 65c4cc65-6c06-0410-ace0-fbb531ad65f3
106 lines
3.1 KiB
C
106 lines
3.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/network.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.
|
|
* it.
|
|
*
|
|
* 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
|
|
*/
|
|
struct ast_dnsmgr_entry *ast_dnsmgr_get(const char *name, struct sockaddr_in *result, const char *service);
|
|
|
|
/*!
|
|
* \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
|
|
* \param dnsmgr Where to store the allocate DNS manager entry
|
|
*
|
|
* 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 sockaddr_in *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 */
|