proxy.h

Go to the documentation of this file.

 
/* 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"
 
typedef enum
{
    PURPLE_PROXY_USE_GLOBAL = -1,  
    PURPLE_PROXY_NONE = 0,         
    PURPLE_PROXY_HTTP,             
    PURPLE_PROXY_SOCKS4,           
    PURPLE_PROXY_SOCKS5,           
    PURPLE_PROXY_USE_ENVVAR,       
    PURPLE_PROXY_TOR               
} PurpleProxyType;
 
typedef struct
{
    PurpleProxyType type;   
    char *host;           
    int   port;           
    char *username;       
    char *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
 
/**************************************************************************/
/**************************************************************************/
PurpleProxyInfo *purple_proxy_info_new(void);
 
void purple_proxy_info_destroy(PurpleProxyInfo *info);
 
void purple_proxy_info_set_type(PurpleProxyInfo *info, PurpleProxyType type);
 
void purple_proxy_info_set_host(PurpleProxyInfo *info, const char *host);
 
void purple_proxy_info_set_port(PurpleProxyInfo *info, int port);
 
void purple_proxy_info_set_username(PurpleProxyInfo *info, const char *username);
 
void purple_proxy_info_set_password(PurpleProxyInfo *info, const char *password);
 
PurpleProxyType purple_proxy_info_get_type(const PurpleProxyInfo *info);
 
const char *purple_proxy_info_get_host(const PurpleProxyInfo *info);
 
int purple_proxy_info_get_port(const PurpleProxyInfo *info);
 
const char *purple_proxy_info_get_username(const PurpleProxyInfo *info);
 
const char *purple_proxy_info_get_password(const PurpleProxyInfo *info);
 
/**************************************************************************/
/**************************************************************************/
PurpleProxyInfo *purple_global_proxy_get_info(void);
 
void purple_global_proxy_set_info(PurpleProxyInfo *info);
 
/**************************************************************************/
/**************************************************************************/
void *purple_proxy_get_handle(void);
 
void purple_proxy_init(void);
 
void purple_proxy_uninit(void);
 
PurpleProxyInfo *purple_proxy_get_setup(PurpleAccount *account);
 
PurpleProxyConnectData *purple_proxy_connect(void *handle,
            PurpleAccount *account,
            const char *host, int port,
            PurpleProxyConnectFunction connect_cb, gpointer data);
 
PurpleProxyConnectData *purple_proxy_connect_udp(void *handle,
            PurpleAccount *account,
            const char *host, int port,
            PurpleProxyConnectFunction connect_cb, gpointer data);
 
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_)
PurpleProxyConnectData *purple_proxy_connect_socks5(void *handle,
            PurpleProxyInfo *gpi,
            const char *host, int port,
            PurpleProxyConnectFunction connect_cb, gpointer data);
#endif
 
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_ */