Mercurial > pidgin
view libpurple/dnsquery.h @ 15817:0e3a8505ebbe
renamed gaim-text to finch
author | Sean Egan <seanegan@gmail.com> |
---|---|
date | Sun, 18 Mar 2007 19:38:15 +0000 |
parents | 7ac07c5fb1c2 |
children | 32c366eeeb99 |
line wrap: on
line source
/** * @file dnsquery.h DNS query API * @ingroup core * * gaim * * Gaim is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _GAIM_DNSQUERY_H_ #define _GAIM_DNSQUERY_H_ #include <glib.h> #include "eventloop.h" #include "account.h" typedef struct _GaimDnsQueryData GaimDnsQueryData; /** * The "hosts" parameter is a linked list containing pairs of * one size_t addrlen and one struct sockaddr *addr. It should * be free'd by the callback function. */ typedef void (*GaimDnsQueryConnectFunction)(GSList *hosts, gpointer data, const char *error_message); /** * Callbacks used by the UI if it handles resolving DNS */ typedef void (*GaimDnsQueryResolvedCallback) (GaimDnsQueryData *query_data, GSList *hosts); typedef void (*GaimDnsQueryFailedCallback) (GaimDnsQueryData *query_data, const gchar *error_message); /** * DNS Request UI operations */ typedef struct { /* If implemented, the UI is responsible for DNS queries */ gboolean (*resolve_host)(GaimDnsQueryData *query_data, GaimDnsQueryResolvedCallback resolved_cb, GaimDnsQueryFailedCallback failed_cb); /* After destroy is called, query_data will be feed, so this must * cancel any further use of it the UI would do. Unneeded if * resolve_host is not implemented. */ void (*destroy)(GaimDnsQueryData *query_data); } GaimDnsQueryUiOps; #ifdef __cplusplus extern "C" { #endif /**************************************************************************/ /** @name DNS query API */ /**************************************************************************/ /*@{*/ /** * Perform an asynchronous DNS query. * * @param hostname The hostname to resolve. * @param port A port number which is stored in the struct sockaddr. * @param callback The callback function to call after resolving. * @param data Extra data to pass to the callback function. * * @return NULL if there was an error, otherwise return a reference to * a data structure that can be used to cancel the pending * DNS query, if needed. */ GaimDnsQueryData *gaim_dnsquery_a(const char *hostname, int port, GaimDnsQueryConnectFunction callback, gpointer data); /** * Cancel a DNS query and destroy the associated data structure. * * @param query_data The DNS query to cancel. This data structure * is freed by this function. */ void gaim_dnsquery_destroy(GaimDnsQueryData *query_data); /** * Sets the UI operations structure to be used when doing a DNS * resolve. The UI operations need only be set if the UI wants to * handle the resolve itself; otherwise, leave it as NULL. * * @param ops The UI operations structure. */ void gaim_dnsquery_set_ui_ops(GaimDnsQueryUiOps *ops); /** * Returns the UI operations structure to be used when doing a DNS * resolve. * * @return The UI operations structure. */ GaimDnsQueryUiOps *gaim_dnsquery_get_ui_ops(void); /** * Get the host associated with a GaimDnsQueryData * * @param query_data The DNS query * @return The host. */ char *gaim_dnsquery_get_host(GaimDnsQueryData *query_data); /** * Get the port associated with a GaimDnsQueryData * * @param query_data The DNS query * @return The port. */ unsigned short gaim_dnsquery_get_port(GaimDnsQueryData *query_data); /** * Initializes the DNS query subsystem. */ void gaim_dnsquery_init(void); /** * Uninitializes the DNS query subsystem. */ void gaim_dnsquery_uninit(void); /*@}*/ #ifdef __cplusplus } #endif #endif /* _GAIM_DNSQUERY_H_ */