/usr/include/libpurple/dnsquery.h is in libpurple-dev 2.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | /**
* @file dnsquery.h DNS query API
* @ingroup core
*/
/* purple
*
* Purple 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _PURPLE_DNSQUERY_H_
#define _PURPLE_DNSQUERY_H_
#include <glib.h>
#include "eventloop.h"
#include "account.h"
/**
* An opaque structure representing a DNS query. The hostname and port
* associated with the query can be retrieved using
* purple_dnsquery_get_host() and purple_dnsquery_get_port().
*/
typedef struct _PurpleDnsQueryData PurpleDnsQueryData;
/**
* 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 (*PurpleDnsQueryConnectFunction)(GSList *hosts, gpointer data, const char *error_message);
/**
* Callbacks used by the UI if it handles resolving DNS
*/
typedef void (*PurpleDnsQueryResolvedCallback) (PurpleDnsQueryData *query_data, GSList *hosts);
typedef void (*PurpleDnsQueryFailedCallback) (PurpleDnsQueryData *query_data, const gchar *error_message);
/**
* DNS Request UI operations; UIs should implement this if they want to do DNS
* lookups themselves, rather than relying on the core.
*
* @see @ref ui-ops
*/
typedef struct
{
/** If implemented, return TRUE if the UI takes responsibility for DNS
* queries. When returning FALSE, the standard implementation is used. */
gboolean (*resolve_host)(PurpleDnsQueryData *query_data,
PurpleDnsQueryResolvedCallback resolved_cb,
PurpleDnsQueryFailedCallback failed_cb);
/** Called just before @a query_data is freed; this should cancel any
* further use of @a query_data the UI would make. Unneeded if
* #resolve_host is not implemented.
*/
void (*destroy)(PurpleDnsQueryData *query_data);
void (*_purple_reserved1)(void);
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
void (*_purple_reserved4)(void);
} PurpleDnsQueryUiOps;
#ifdef __cplusplus
extern "C" {
#endif
/**************************************************************************/
/** @name DNS query API */
/**************************************************************************/
/*@{*/
/**
* Perform an asynchronous DNS query.
*
* @param account the account that the query is being done for (or NULL)
* @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.
*
* @since 2.8.0
*/
PurpleDnsQueryData *purple_dnsquery_a_account(PurpleAccount *account, const char *hostname, int port, PurpleDnsQueryConnectFunction callback, gpointer data);
#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_DNSQUERY_C_)
/**
* 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.
*
* @deprecated Use purple_dnsquery_a_account instead
*/
PurpleDnsQueryData *purple_dnsquery_a(const char *hostname, int port, PurpleDnsQueryConnectFunction callback, gpointer data);
#endif
/**
* 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 purple_dnsquery_destroy(PurpleDnsQueryData *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 purple_dnsquery_set_ui_ops(PurpleDnsQueryUiOps *ops);
/**
* Returns the UI operations structure to be used when doing a DNS
* resolve.
*
* @return The UI operations structure.
*/
PurpleDnsQueryUiOps *purple_dnsquery_get_ui_ops(void);
/**
* Get the host associated with a PurpleDnsQueryData
*
* @param query_data The DNS query
* @return The host.
*/
char *purple_dnsquery_get_host(PurpleDnsQueryData *query_data);
/**
* Get the port associated with a PurpleDnsQueryData
*
* @param query_data The DNS query
* @return The port.
*/
unsigned short purple_dnsquery_get_port(PurpleDnsQueryData *query_data);
/**
* Initializes the DNS query subsystem.
*/
void purple_dnsquery_init(void);
/**
* Uninitializes the DNS query subsystem.
*/
void purple_dnsquery_uninit(void);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* _PURPLE_DNSQUERY_H_ */
|