Merged revisions 88862 via svnmerge from
[asterisk/asterisk.git] / include / asterisk / srv.h
old mode 100755 (executable)
new mode 100644 (file)
index 1c3711d..567b408
@@ -1,22 +1,45 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * ENUM support
- * 
- * Copyright (C) 1999, Mark Spencer
+ * Copyright (C) 1999 - 2005, Digium, Inc.
  *
- * Mark Spencer <markster@linux-support.net>
+ * Mark Spencer <markster@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
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*
+ * DNS SRV record support
  */
 
 #ifndef _ASTERISK_SRV_H
 #define _ASTERISK_SRV_H
 
-struct ast_channel;
+/*!
+  \file srv.h
+  \brief Support for DNS SRV records, used in to locate SIP services.
+  \note Note: This SRV record support will respect the priority and
+        weight elements of the records that are returned, but there are
+       no provisions for retrying or failover between records.
+*/
 
-/* Lookup entry in SRV records Returns 1 if found, 0 if not found, -1 on hangup */
+/*! Lookup entry in SRV records Returns 1 if found, 0 if not found, -1 on hangup 
+       Only do SRV record lookup if you get a domain without a port. If you get a port #, it's a DNS host name.
+*/
+/*!    \param  chan Ast channel
+       \param  host host name (return value)
+       \param  hostlen Length of string "host"
+       \param  port Port number (return value)
+       \param service Service tag for SRV lookup (like "_sip._udp" or "_stun._udp"
+*/
 extern int ast_get_srv(struct ast_channel *chan, char *host, int hostlen, int *port, const char *service);
 
-#endif
+#endif /* _ASTERISK_SRV_H */