diff libpurple/proxy.h @ 15373:5fe8042783c1

Rename gtk/ and libgaim/ to pidgin/ and libpurple/

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libpurple/proxy.h	Sat Jan 20 02:32:10 2007 +0000
@@ -0,0 +1,295 @@
+/**
+ * @file proxy.h Proxy 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_PROXY_H_
+#define _GAIM_PROXY_H_
+
+#include <glib.h>
+#include "eventloop.h"
+
+/**
+ * A type of proxy connection.
+ */
+typedef enum
+{
+	GAIM_PROXY_USE_GLOBAL = -1,  /**< Use the global proxy information. */
+	GAIM_PROXY_NONE = 0,         /**< No proxy.                         */
+	GAIM_PROXY_HTTP,             /**< HTTP proxy.                       */
+	GAIM_PROXY_SOCKS4,           /**< SOCKS 4 proxy.                    */
+	GAIM_PROXY_SOCKS5,           /**< SOCKS 5 proxy.                    */
+	GAIM_PROXY_USE_ENVVAR        /**< Use environmental settings.       */
+
+} GaimProxyType;
+
+/**
+ * Information on proxy settings.
+ */
+typedef struct
+{
+	GaimProxyType type;   /**< The proxy type.  */
+
+	char *host;           /**< The host.        */
+	int   port;           /**< The port number. */
+	char *username;       /**< The username.    */
+	char *password;       /**< The password.    */
+
+} GaimProxyInfo;
+
+typedef struct _GaimProxyConnectData GaimProxyConnectData;
+
+typedef void (*GaimProxyConnectFunction)(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.
+ */
+GaimProxyInfo *gaim_proxy_info_new(void);
+
+/**
+ * Destroys a proxy information structure.
+ *
+ * @param info The proxy information structure to destroy.
+ */
+void gaim_proxy_info_destroy(GaimProxyInfo *info);
+
+/**
+ * Sets the type of proxy.
+ *
+ * @param info The proxy information.
+ * @param type The proxy type.
+ */
+void gaim_proxy_info_set_type(GaimProxyInfo *info, GaimProxyType type);
+
+/**
+ * Sets the proxy host.
+ *
+ * @param info The proxy information.
+ * @param host The host.
+ */
+void gaim_proxy_info_set_host(GaimProxyInfo *info, const char *host);
+
+/**
+ * Sets the proxy port.
+ *
+ * @param info The proxy information.
+ * @param port The port.
+ */
+void gaim_proxy_info_set_port(GaimProxyInfo *info, int port);
+
+/**
+ * Sets the proxy username.
+ *
+ * @param info     The proxy information.
+ * @param username The username.
+ */
+void gaim_proxy_info_set_username(GaimProxyInfo *info, const char *username);
+
+/**
+ * Sets the proxy password.
+ *
+ * @param info     The proxy information.
+ * @param password The password.
+ */
+void gaim_proxy_info_set_password(GaimProxyInfo *info, const char *password);
+
+/**
+ * Returns the proxy's type.
+ *
+ * @param info The proxy information.
+ *
+ * @return The type.
+ */
+GaimProxyType gaim_proxy_info_get_type(const GaimProxyInfo *info);
+
+/**
+ * Returns the proxy's host.
+ *
+ * @param info The proxy information.
+ *
+ * @return The host.
+ */
+const char *gaim_proxy_info_get_host(const GaimProxyInfo *info);
+
+/**
+ * Returns the proxy's port.
+ *
+ * @param info The proxy information.
+ *
+ * @return The port.
+ */
+int gaim_proxy_info_get_port(const GaimProxyInfo *info);
+
+/**
+ * Returns the proxy's username.
+ *
+ * @param info The proxy information.
+ *
+ * @return The username.
+ */
+const char *gaim_proxy_info_get_username(const GaimProxyInfo *info);
+
+/**
+ * Returns the proxy's password.
+ *
+ * @param info The proxy information.
+ *
+ * @return The password.
+ */
+const char *gaim_proxy_info_get_password(const GaimProxyInfo *info);
+
+/*@}*/
+
+/**************************************************************************/
+/** @name Global Proxy API                                                */
+/**************************************************************************/
+/*@{*/
+
+/**
+ * Returns gaim's global proxy information.
+ *
+ * @return The global proxy information.
+ */
+GaimProxyInfo *gaim_global_proxy_get_info(void);
+
+/*@}*/
+
+/**************************************************************************/
+/** @name Proxy API                                                       */
+/**************************************************************************/
+/*@{*/
+
+/**
+ * Returns the proxy subsystem handle.
+ *
+ * @return The proxy subsystem handle.
+ */
+void *gaim_proxy_get_handle(void);
+
+/**
+ * Initializes the proxy subsystem.
+ */
+void gaim_proxy_init(void);
+
+/**
+ * Uninitializes the proxy subsystem.
+ */
+void gaim_proxy_uninit(void);
+
+/**
+ * Returns configuration of a proxy.
+ *
+ * @param account The account for which the configuration is needed.
+ *
+ * @return The configuration of a proxy.
+ */
+GaimProxyInfo *gaim_proxy_get_setup(GaimAccount *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
+ *                   gaim_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 a data
+ *         structure that can be used to cancel the pending
+ *         connection, if needed.
+ */
+GaimProxyConnectData *gaim_proxy_connect(void *handle,
+			GaimAccount *account,
+			const char *host, int port,
+			GaimProxyConnectFunction connect_cb, gpointer data);
+
+/**
+ * Makes a connection through a SOCKS5 proxy.
+ *
+ * @param gpi        The GaimProxyInfo 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 a data
+ *         structure that can be used to cancel the pending
+ *         connection, if needed.
+ */
+GaimProxyConnectData *gaim_proxy_connect_socks5(void *handle,
+			GaimProxyInfo *gpi,
+			const char *host, int port,
+			GaimProxyConnectFunction connect_cb, gpointer data);
+
+/**
+ * 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 gaim_proxy_connect_cancel(GaimProxyConnectData *connect_data);
+
+/*
+ * Closes all proxy connections registered with the specified handle.
+ *
+ * @param handle The handle.
+ */
+void gaim_proxy_connect_cancel_with_handle(void *handle);
+
+/*@}*/
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _GAIM_PROXY_H_ */