/usr/include/libpurple/proxy.h is in libpurple-dev 1:2.10.12-0ubuntu5.
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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 | /**
* @file proxy.h Proxy 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_PROXY_H_
#define _PURPLE_PROXY_H_
#include <glib.h>
#include "eventloop.h"
/**
* A type of proxy connection.
*/
typedef enum
{
PURPLE_PROXY_USE_GLOBAL = -1, /**< Use the global proxy information. */
PURPLE_PROXY_NONE = 0, /**< No proxy. */
PURPLE_PROXY_HTTP, /**< HTTP proxy. */
PURPLE_PROXY_SOCKS4, /**< SOCKS 4 proxy. */
PURPLE_PROXY_SOCKS5, /**< SOCKS 5 proxy. */
PURPLE_PROXY_USE_ENVVAR, /**< Use environmental settings. */
PURPLE_PROXY_TOR /**< Use a Tor proxy (SOCKS 5 really) */
} PurpleProxyType;
/**
* Information on proxy settings.
*/
typedef struct
{
PurpleProxyType type; /**< The proxy type. */
char *host; /**< The host. */
int port; /**< The port number. */
char *username; /**< The username. */
char *password; /**< The password. */
} PurpleProxyInfo;
typedef struct _PurpleProxyConnectData PurpleProxyConnectData;
typedef void (*PurpleProxyConnectFunction)(gpointer data, gint source, const gchar *error_message);
#include "account.h"
#ifdef __cplusplus
extern "C" {
#endif
/**************************************************************************/
/** @name Proxy structure API */
/**************************************************************************/
/*@{*/
/**
* Creates a proxy information structure.
*
* @return The proxy information structure.
*/
PurpleProxyInfo *purple_proxy_info_new(void);
/**
* Destroys a proxy information structure.
*
* @param info The proxy information structure to destroy.
*/
void purple_proxy_info_destroy(PurpleProxyInfo *info);
/**
* Sets the type of proxy.
*
* @param info The proxy information.
* @param type The proxy type.
*/
void purple_proxy_info_set_type(PurpleProxyInfo *info, PurpleProxyType type);
/**
* Sets the proxy host.
*
* @param info The proxy information.
* @param host The host.
*/
void purple_proxy_info_set_host(PurpleProxyInfo *info, const char *host);
/**
* Sets the proxy port.
*
* @param info The proxy information.
* @param port The port.
*/
void purple_proxy_info_set_port(PurpleProxyInfo *info, int port);
/**
* Sets the proxy username.
*
* @param info The proxy information.
* @param username The username.
*/
void purple_proxy_info_set_username(PurpleProxyInfo *info, const char *username);
/**
* Sets the proxy password.
*
* @param info The proxy information.
* @param password The password.
*/
void purple_proxy_info_set_password(PurpleProxyInfo *info, const char *password);
/**
* Returns the proxy's type.
*
* @param info The proxy information.
*
* @return The type.
*/
PurpleProxyType purple_proxy_info_get_type(const PurpleProxyInfo *info);
/**
* Returns the proxy's host.
*
* @param info The proxy information.
*
* @return The host.
*/
const char *purple_proxy_info_get_host(const PurpleProxyInfo *info);
/**
* Returns the proxy's port.
*
* @param info The proxy information.
*
* @return The port.
*/
int purple_proxy_info_get_port(const PurpleProxyInfo *info);
/**
* Returns the proxy's username.
*
* @param info The proxy information.
*
* @return The username.
*/
const char *purple_proxy_info_get_username(const PurpleProxyInfo *info);
/**
* Returns the proxy's password.
*
* @param info The proxy information.
*
* @return The password.
*/
const char *purple_proxy_info_get_password(const PurpleProxyInfo *info);
/*@}*/
/**************************************************************************/
/** @name Global Proxy API */
/**************************************************************************/
/*@{*/
/**
* Returns purple's global proxy information.
*
* @return The global proxy information.
*/
PurpleProxyInfo *purple_global_proxy_get_info(void);
/**
* Set purple's global proxy information.
*
* @param info The proxy information.
* @since 2.6.0
*/
void purple_global_proxy_set_info(PurpleProxyInfo *info);
/*@}*/
/**************************************************************************/
/** @name Proxy API */
/**************************************************************************/
/*@{*/
/**
* Returns the proxy subsystem handle.
*
* @return The proxy subsystem handle.
*/
void *purple_proxy_get_handle(void);
/**
* Initializes the proxy subsystem.
*/
void purple_proxy_init(void);
/**
* Uninitializes the proxy subsystem.
*/
void purple_proxy_uninit(void);
/**
* Returns configuration of a proxy.
*
* @param account The account for which the configuration is needed.
*
* @return The configuration of a proxy.
*/
PurpleProxyInfo *purple_proxy_get_setup(PurpleAccount *account);
/**
* Makes a connection to the specified host and port. Note that this
* function name can be misleading--although it is called "proxy
* connect," it is used for establishing any outgoing TCP connection,
* whether through a proxy or not.
*
* @param handle A handle that should be associated with this
* connection attempt. The handle can be used
* to cancel the connection attempt using the
* purple_proxy_connect_cancel_with_handle()
* function.
* @param account The account making the connection.
* @param host The destination host.
* @param port The destination port.
* @param connect_cb The function to call when the connection is
* established. If the connection failed then
* fd will be -1 and error message will be set
* to something descriptive (hopefully).
* @param data User-defined data.
*
* @return NULL if there was an error, or a reference to an
* opaque data structure that can be used to cancel
* the pending connection, if needed.
*/
PurpleProxyConnectData *purple_proxy_connect(void *handle,
PurpleAccount *account,
const char *host, int port,
PurpleProxyConnectFunction connect_cb, gpointer data);
/**
* Makes a connection to the specified host and port. Note that this
* function name can be misleading--although it is called "proxy
* connect," it is used for establishing any outgoing UDP connection,
* whether through a proxy or not.
*
* @param handle A handle that should be associated with this
* connection attempt. The handle can be used
* to cancel the connection attempt using the
* purple_proxy_connect_cancel_with_handle()
* function.
* @param account The account making the connection.
* @param host The destination host.
* @param port The destination port.
* @param connect_cb The function to call when the connection is
* established. If the connection failed then
* fd will be -1 and error message will be set
* to something descriptive (hopefully).
* @param data User-defined data.
*
* @return NULL if there was an error, or a reference to an
* opaque data structure that can be used to cancel
* the pending connection, if needed.
*/
PurpleProxyConnectData *purple_proxy_connect_udp(void *handle,
PurpleAccount *account,
const char *host, int port,
PurpleProxyConnectFunction connect_cb, gpointer data);
/**
* Makes a connection through a SOCKS5 proxy.
*
* Note that if the account that is making the connection uses a proxy, this
* connection to a SOCKS5 proxy will be made through the account proxy.
*
* @param handle A handle that should be associated with this
* connection attempt. The handle can be used
* to cancel the connection attempt using the
* purple_proxy_connect_cancel_with_handle()
* function.
* @param account The account making the connection.
* @param gpi The PurpleProxyInfo specifying the proxy settings
* @param host The destination host.
* @param port The destination port.
* @param connect_cb The function to call when the connection is
* established. If the connection failed then
* fd will be -1 and error message will be set
* to something descriptive (hopefully).
* @param data User-defined data.
*
* @return NULL if there was an error, or a reference to an
* opaque data structure that can be used to cancel
* the pending connection, if needed.
*/
PurpleProxyConnectData *purple_proxy_connect_socks5_account(void *handle,
PurpleAccount *account, PurpleProxyInfo *gpi,
const char *host, int port,
PurpleProxyConnectFunction connect_cb, gpointer data);
#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_PROXY_C_)
/**
* Makes a connection through a SOCKS5 proxy.
*
* @param handle A handle that should be associated with this
* connection attempt. The handle can be used
* to cancel the connection attempt using the
* purple_proxy_connect_cancel_with_handle()
* function.
* @param gpi The PurpleProxyInfo specifying the proxy settings
* @param host The destination host.
* @param port The destination port.
* @param connect_cb The function to call when the connection is
* established. If the connection failed then
* fd will be -1 and error message will be set
* to something descriptive (hopefully).
* @param data User-defined data.
*
* @return NULL if there was an error, or a reference to an
* opaque data structure that can be used to cancel
* the pending connection, if needed.
* @deprecated Use purple_proxy_connect_socks5_account instead
*/
PurpleProxyConnectData *purple_proxy_connect_socks5(void *handle,
PurpleProxyInfo *gpi,
const char *host, int port,
PurpleProxyConnectFunction connect_cb, gpointer data);
#endif
/**
* Cancel an in-progress connection attempt. This should be called
* by the PRPL if the user disables an account while it is still
* performing the initial sign on. Or when establishing a file
* transfer, if we attempt to connect to a remote user but they
* are behind a firewall then the PRPL can cancel the connection
* attempt early rather than just letting the OS's TCP/IP stack
* time-out the connection.
*/
void purple_proxy_connect_cancel(PurpleProxyConnectData *connect_data);
/*
* Closes all proxy connections registered with the specified handle.
*
* @param handle The handle.
*/
void purple_proxy_connect_cancel_with_handle(void *handle);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* _PURPLE_PROXY_H_ */
|