annotate src/dnsquery.h @ 14183:c3c792958635

[gaim-migrate @ 16835] Change the DNS query function to return a struct that will eventually allow the query to be canceled. Also rename two of the DNS query things committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Fri, 18 Aug 2006 07:40:17 +0000
parents fc92a5a7dd95
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14181
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
1 /**
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
2 * @file dnsquery.h DNS query API
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
3 * @ingroup core
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
4 *
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
5 * gaim
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
6 *
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
7 * Gaim is the legal property of its developers, whose names are too numerous
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
8 * to list here. Please refer to the COPYRIGHT file distributed with this
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
9 * source distribution.
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
10 *
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
11 * This program is free software; you can redistribute it and/or modify
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
12 * it under the terms of the GNU General Public License as published by
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
13 * the Free Software Foundation; either version 2 of the License, or
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
14 * (at your option) any later version.
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
15 *
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
16 * This program is distributed in the hope that it will be useful,
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
19 * GNU General Public License for more details.
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
20 *
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
21 * You should have received a copy of the GNU General Public License
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
22 * along with this program; if not, write to the Free Software
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
24 */
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
25 #ifndef _GAIM_DNSQUERY_H_
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
26 #define _GAIM_DNSQUERY_H_
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
27
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
28 #include <glib.h>
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
29 #include "eventloop.h"
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
30
14183
c3c792958635 [gaim-migrate @ 16835]
Mark Doliner <mark@kingant.net>
parents: 14181
diff changeset
31 typedef struct _GaimDnsQueryData GaimDnsQueryData;
c3c792958635 [gaim-migrate @ 16835]
Mark Doliner <mark@kingant.net>
parents: 14181
diff changeset
32
14181
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
33 /**
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
34 * The "hosts" parameter is a linked list containing pairs of
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
35 * one size_t addrlen and one struct sockaddr *addr.
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
36 */
14183
c3c792958635 [gaim-migrate @ 16835]
Mark Doliner <mark@kingant.net>
parents: 14181
diff changeset
37 typedef void (*GaimDnsQueryConnectFunction)(GSList *hosts, gpointer data, const char *error_message);
14181
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
38
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
39
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
40 #include "account.h"
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
41
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
42 #ifdef __cplusplus
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
43 extern "C" {
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
44 #endif
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
45
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
46 /**************************************************************************/
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
47 /** @name DNS query API */
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
48 /**************************************************************************/
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
49 /*@{*/
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
50
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
51 /**
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
52 * Do an async dns query
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
53 *
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
54 * @param hostname The hostname to resolve
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
55 * @param port A portnumber which is stored in the struct sockaddr
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
56 * @param callback Callback to call after resolving
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
57 * @param data Extra data for the callback function
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
58 *
14183
c3c792958635 [gaim-migrate @ 16835]
Mark Doliner <mark@kingant.net>
parents: 14181
diff changeset
59 * @return NULL if there was an error, otherwise return a reference to
c3c792958635 [gaim-migrate @ 16835]
Mark Doliner <mark@kingant.net>
parents: 14181
diff changeset
60 * a data structure that can be used to cancel the pending
c3c792958635 [gaim-migrate @ 16835]
Mark Doliner <mark@kingant.net>
parents: 14181
diff changeset
61 * DNS query, if needed.
14181
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
62 */
14183
c3c792958635 [gaim-migrate @ 16835]
Mark Doliner <mark@kingant.net>
parents: 14181
diff changeset
63 GaimDnsQueryData *gaim_dnsquery_a(const char *hostname, int port, GaimDnsQueryConnectFunction callback, gpointer data);
14181
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
64
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
65 /*@}*/
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
66
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
67 #ifdef __cplusplus
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
68 }
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
69 #endif
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
70
fc92a5a7dd95 [gaim-migrate @ 16833]
Mark Doliner <mark@kingant.net>
parents:
diff changeset
71 #endif /* _GAIM_DNSQUERY_H_ */