connection.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_CONNECTION_H_
#define _PURPLE_CONNECTION_H_
 
typedef struct _PurpleConnection PurpleConnection;
 
typedef enum
{
    PURPLE_CONNECTION_HTML       = 0x0001, 
    PURPLE_CONNECTION_NO_BGCOLOR = 0x0002, 
    PURPLE_CONNECTION_AUTO_RESP  = 0x0004,  
    PURPLE_CONNECTION_FORMATTING_WBFO = 0x0008, 
    PURPLE_CONNECTION_NO_NEWLINES = 0x0010, 
    PURPLE_CONNECTION_NO_FONTSIZE = 0x0020, 
    PURPLE_CONNECTION_NO_URLDESC = 0x0040,  
    PURPLE_CONNECTION_NO_IMAGES = 0x0080,  
    PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY = 0x0100, 
    PURPLE_CONNECTION_SUPPORT_MOODS = 0x0200, 
    PURPLE_CONNECTION_SUPPORT_MOOD_MESSAGES = 0x0400 
} PurpleConnectionFlags;
 
typedef enum
{
    PURPLE_DISCONNECTED = 0, 
    PURPLE_CONNECTED,        
    PURPLE_CONNECTING        
} PurpleConnectionState;
 
typedef enum
{
    PURPLE_CONNECTION_ERROR_NETWORK_ERROR = 0,
    PURPLE_CONNECTION_ERROR_INVALID_USERNAME = 1,
    PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED = 2,
    PURPLE_CONNECTION_ERROR_AUTHENTICATION_IMPOSSIBLE = 3,
    PURPLE_CONNECTION_ERROR_NO_SSL_SUPPORT = 4,
    PURPLE_CONNECTION_ERROR_ENCRYPTION_ERROR = 5,
    PURPLE_CONNECTION_ERROR_NAME_IN_USE = 6,
 
    PURPLE_CONNECTION_ERROR_INVALID_SETTINGS = 7,
 
    PURPLE_CONNECTION_ERROR_CERT_NOT_PROVIDED = 8,
    PURPLE_CONNECTION_ERROR_CERT_UNTRUSTED = 9,
    PURPLE_CONNECTION_ERROR_CERT_EXPIRED = 10,
    PURPLE_CONNECTION_ERROR_CERT_NOT_ACTIVATED = 11,
    PURPLE_CONNECTION_ERROR_CERT_HOSTNAME_MISMATCH = 12,
    PURPLE_CONNECTION_ERROR_CERT_FINGERPRINT_MISMATCH = 13,
    PURPLE_CONNECTION_ERROR_CERT_SELF_SIGNED = 14,
    PURPLE_CONNECTION_ERROR_CERT_OTHER_ERROR = 15,
 
    /* purple_connection_error_reason() in connection.c uses the fact that
     * this is the last member of the enum when sanity-checking; if other
     * reasons are added after it, the check must be updated.
     */
    PURPLE_CONNECTION_ERROR_OTHER_ERROR = 16
} PurpleConnectionError;
 
typedef struct
{
    PurpleConnectionError type;
    char *description;
} PurpleConnectionErrorInfo;
 
#include <time.h>
 
#include "account.h"
#include "plugin.h"
#include "status.h"
#include "sslconn.h"
 
typedef struct
{
    void (*connect_progress)(PurpleConnection *gc,
                             const char *text,
                             size_t step,
                             size_t step_count);
 
    void (*connected)(PurpleConnection *gc);
 
    void (*disconnected)(PurpleConnection *gc);
 
    void (*notice)(PurpleConnection *gc, const char *text);
 
    void (*report_disconnect)(PurpleConnection *gc, const char *text);
 
    void (*network_connected)(void);
 
    void (*network_disconnected)(void);
 
    void (*report_disconnect_reason)(PurpleConnection *gc,
                                     PurpleConnectionError reason,
                                     const char *text);
 
    void (*_purple_reserved1)(void);
    void (*_purple_reserved2)(void);
    void (*_purple_reserved3)(void);
} PurpleConnectionUiOps;
 
 
/* Represents an active connection on an account. */
struct _PurpleConnection
{
    PurplePlugin *prpl;            
    PurpleConnectionFlags flags;   
    PurpleConnectionState state;   
    PurpleAccount *account;        
    char *password;              
    int inpa;                    
    GSList *buddy_chats;         
    void *proto_data;            
    char *display_name;          
    guint keepalive;             
    gboolean wants_to_die;
 
    guint disconnect_timeout;    
    time_t last_received;        
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************************/
/**************************************************************************/
#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_CONNECTION_C_)
void purple_connection_new(PurpleAccount *account, gboolean regist,
                                    const char *password);
#endif
 
#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_CONNECTION_C_)
void purple_connection_new_unregister(PurpleAccount *account, const char *password, PurpleAccountUnregistrationCb cb, void *user_data);
#endif
 
#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_CONNECTION_C_)
void purple_connection_destroy(PurpleConnection *gc);
#endif
 
void purple_connection_set_state(PurpleConnection *gc, PurpleConnectionState state);
 
void purple_connection_set_account(PurpleConnection *gc, PurpleAccount *account);
 
void purple_connection_set_display_name(PurpleConnection *gc, const char *name);
 
void purple_connection_set_protocol_data(PurpleConnection *connection, void *proto_data);
 
PurpleConnectionState purple_connection_get_state(const PurpleConnection *gc);
 
#define PURPLE_CONNECTION_IS_CONNECTED(gc) \
    (purple_connection_get_state(gc) == PURPLE_CONNECTED)
 
PurpleAccount *purple_connection_get_account(const PurpleConnection *gc);
 
PurplePlugin * purple_connection_get_prpl(const PurpleConnection *gc);
 
const char *purple_connection_get_password(const PurpleConnection *gc);
 
const char *purple_connection_get_display_name(const PurpleConnection *gc);
 
void *purple_connection_get_protocol_data(const PurpleConnection *connection);
 
void purple_connection_update_progress(PurpleConnection *gc, const char *text,
                                     size_t step, size_t count);
 
void purple_connection_notice(PurpleConnection *gc, const char *text);
 
void purple_connection_error(PurpleConnection *gc, const char *reason);
 
void
purple_connection_error_reason (PurpleConnection *gc,
                                PurpleConnectionError reason,
                                const char *description);
 
void
purple_connection_ssl_error (PurpleConnection *gc,
                             PurpleSslErrorType ssl_error);
 
gboolean
purple_connection_error_is_fatal (PurpleConnectionError reason);
 
/**************************************************************************/
/**************************************************************************/
void purple_connections_disconnect_all(void);
 
GList *purple_connections_get_all(void);
 
GList *purple_connections_get_connecting(void);
 
/*
 * TODO: Eventually this bad boy will be removed, because it is
 *       a gross fix for a crashy problem.
 */
#define PURPLE_CONNECTION_IS_VALID(gc) (g_list_find(purple_connections_get_all(), (gc)) != NULL)
 
/**************************************************************************/
/**************************************************************************/
void purple_connections_set_ui_ops(PurpleConnectionUiOps *ops);
 
PurpleConnectionUiOps *purple_connections_get_ui_ops(void);
 
/**************************************************************************/
/**************************************************************************/
void purple_connections_init(void);
 
void purple_connections_uninit(void);
 
void *purple_connections_get_handle(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_CONNECTION_H_ */