doc updates and copyright header cleanup (issue #5026)
[asterisk/asterisk.git] / include / asterisk / srv.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * DNS SRV record support
5  * 
6  * Copyright (C) 1999-2005, Digium, Inc.
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  * 
13  * $Revision$
14  */
15
16 #ifndef _ASTERISK_SRV_H
17 #define _ASTERISK_SRV_H
18
19 struct ast_channel;
20
21 /*!
22   \file srv.h
23   \brief Support for DNS SRV records, used in to locate SIP services.
24         Note: The Asterisk DNS SRV record support is broken, it only
25         supports the first DNS SRV record and will give no load 
26         balancing or failover support.
27 */
28
29 /*! Lookup entry in SRV records Returns 1 if found, 0 if not found, -1 on hangup 
30         Only do SRV record lookup if you get a domain without a port. If you get a port #, it's a DNS host name.
31 */
32 /*!     \param  chan Ast channel
33         \param  host host name (return value)
34         \param  hostlen Length of string "host"
35         \param  port Port number (return value)
36         \param service Service tag for SRV lookup (like "_sip._udp" or "_stun._udp"
37 */
38 extern int ast_get_srv(struct ast_channel *chan, char *host, int hostlen, int *port, const char *service);
39
40 #endif