Frameworks/libpurple.framework/Versions/0.5.6/Headers/connection.h
branchadium-1.3
changeset 350 708bedafdc3a
parent 349 17ef128722b7
child 351 b01ab9b157f9
     1.1 --- a/Frameworks/libpurple.framework/Versions/0.5.6/Headers/connection.h	Sun Jun 21 22:04:11 2009 -0400
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,582 +0,0 @@
     1.4 -/**
     1.5 - * @file connection.h Connection API
     1.6 - * @ingroup core
     1.7 - * @see @ref connection-signals
     1.8 - */
     1.9 -
    1.10 -/* purple
    1.11 - *
    1.12 - * Purple is the legal property of its developers, whose names are too numerous
    1.13 - * to list here.  Please refer to the COPYRIGHT file distributed with this
    1.14 - * source distribution.
    1.15 - *
    1.16 - * This program is free software; you can redistribute it and/or modify
    1.17 - * it under the terms of the GNU General Public License as published by
    1.18 - * the Free Software Foundation; either version 2 of the License, or
    1.19 - * (at your option) any later version.
    1.20 - *
    1.21 - * This program is distributed in the hope that it will be useful,
    1.22 - * but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.23 - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.24 - * GNU General Public License for more details.
    1.25 - *
    1.26 - * You should have received a copy of the GNU General Public License
    1.27 - * along with this program; if not, write to the Free Software
    1.28 - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
    1.29 - */
    1.30 -#ifndef _PURPLE_CONNECTION_H_
    1.31 -#define _PURPLE_CONNECTION_H_
    1.32 -
    1.33 -/** @copydoc _PurpleConnection */
    1.34 -typedef struct _PurpleConnection PurpleConnection;
    1.35 -
    1.36 -/**
    1.37 - * Flags to change behavior of the client for a given connection.
    1.38 - */
    1.39 -typedef enum
    1.40 -{
    1.41 -	PURPLE_CONNECTION_HTML       = 0x0001, /**< Connection sends/receives in 'HTML'. */
    1.42 -	PURPLE_CONNECTION_NO_BGCOLOR = 0x0002, /**< Connection does not send/receive
    1.43 -					           background colors.                  */
    1.44 -	PURPLE_CONNECTION_AUTO_RESP  = 0x0004,  /**< Send auto responses when away.       */
    1.45 -	PURPLE_CONNECTION_FORMATTING_WBFO = 0x0008, /**< The text buffer must be formatted as a whole */
    1.46 -	PURPLE_CONNECTION_NO_NEWLINES = 0x0010, /**< No new lines are allowed in outgoing messages */
    1.47 -	PURPLE_CONNECTION_NO_FONTSIZE = 0x0020, /**< Connection does not send/receive font sizes */
    1.48 -	PURPLE_CONNECTION_NO_URLDESC = 0x0040,  /**< Connection does not support descriptions with links */ 
    1.49 -	PURPLE_CONNECTION_NO_IMAGES = 0x0080,  /**< Connection does not support sending of images */
    1.50 -	PURPLE_CONNECTION_ALLOW_CUSTOM_SMILEY = 0x0100 /**< Connection supports sending and receiving custom smileys */
    1.51 -
    1.52 -} PurpleConnectionFlags;
    1.53 -
    1.54 -typedef enum
    1.55 -{
    1.56 -	PURPLE_DISCONNECTED = 0, /**< Disconnected. */
    1.57 -	PURPLE_CONNECTED,        /**< Connected.    */
    1.58 -	PURPLE_CONNECTING        /**< Connecting.   */
    1.59 -
    1.60 -} PurpleConnectionState;
    1.61 -
    1.62 -/** Possible errors that can cause a connection to be closed.
    1.63 - *  @since 2.3.0
    1.64 - */
    1.65 -typedef enum
    1.66 -{
    1.67 -	/** There was an error sending or receiving on the network socket, or
    1.68 -	 *  there was some protocol error (such as the server sending malformed
    1.69 -	 *  data).
    1.70 -	 */
    1.71 -	PURPLE_CONNECTION_ERROR_NETWORK_ERROR = 0,
    1.72 -	/** The username supplied was not valid. */
    1.73 -	PURPLE_CONNECTION_ERROR_INVALID_USERNAME = 1,
    1.74 -	/** The username, password or some other credential was incorrect.  Use
    1.75 -	 *  #PURPLE_CONNECTION_ERROR_INVALID_USERNAME instead if the username
    1.76 -         *  is known to be invalid.
    1.77 -	 */
    1.78 -	PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED = 2,
    1.79 -	/** libpurple doesn't speak any of the authentication methods the
    1.80 -	 *  server offered.
    1.81 -	 */
    1.82 -	PURPLE_CONNECTION_ERROR_AUTHENTICATION_IMPOSSIBLE = 3,
    1.83 -	/** libpurple was built without SSL support, and the connection needs
    1.84 -	 *  SSL.
    1.85 -	 */
    1.86 -	PURPLE_CONNECTION_ERROR_NO_SSL_SUPPORT = 4,
    1.87 -	/** There was an error negotiating SSL on this connection, or the
    1.88 -	 *  server does not support encryption but an account option was set to
    1.89 -	 *  require it.
    1.90 -	 */
    1.91 -	PURPLE_CONNECTION_ERROR_ENCRYPTION_ERROR = 5,
    1.92 -	/** Someone is already connected to the server using the name you are
    1.93 -	 *  trying to connect with.
    1.94 -	 */
    1.95 -	PURPLE_CONNECTION_ERROR_NAME_IN_USE = 6,
    1.96 -
    1.97 -	/** The username/server/other preference for the account isn't valid.
    1.98 -	 *  For instance, on IRC the screen name cannot contain white space.
    1.99 -	 *  This reason should not be used for incorrect passwords etc: use
   1.100 -	 *  #PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED for that.
   1.101 -	 *
   1.102 -	 *  @todo This reason really shouldn't be necessary.  Usernames and
   1.103 -	 *        other account preferences should be validated when the
   1.104 -	 *        account is created.
   1.105 -	 */
   1.106 -	PURPLE_CONNECTION_ERROR_INVALID_SETTINGS = 7,
   1.107 -
   1.108 -	/** The server did not provide a SSL certificate. */
   1.109 -	PURPLE_CONNECTION_ERROR_CERT_NOT_PROVIDED = 8,
   1.110 -	/** The server's SSL certificate could not be trusted. */
   1.111 -	PURPLE_CONNECTION_ERROR_CERT_UNTRUSTED = 9,
   1.112 -	/** The server's SSL certificate has expired. */
   1.113 -	PURPLE_CONNECTION_ERROR_CERT_EXPIRED = 10,
   1.114 -	/** The server's SSL certificate is not yet valid. */
   1.115 -	PURPLE_CONNECTION_ERROR_CERT_NOT_ACTIVATED = 11,
   1.116 -	/** The server's SSL certificate did not match its hostname. */
   1.117 -	PURPLE_CONNECTION_ERROR_CERT_HOSTNAME_MISMATCH = 12,
   1.118 -	/** The server's SSL certificate does not have the expected
   1.119 -	 *  fingerprint.
   1.120 -	 */
   1.121 -	PURPLE_CONNECTION_ERROR_CERT_FINGERPRINT_MISMATCH = 13,
   1.122 -	/** The server's SSL certificate is self-signed.  */
   1.123 -	PURPLE_CONNECTION_ERROR_CERT_SELF_SIGNED = 14,
   1.124 -	/** There was some other error validating the server's SSL certificate.
   1.125 -	 */
   1.126 -	PURPLE_CONNECTION_ERROR_CERT_OTHER_ERROR = 15,
   1.127 -
   1.128 -	/** Some other error occurred which fits into none of the other
   1.129 -	 *  categories.
   1.130 -	 */
   1.131 -	/* purple_connection_error_reason() in connection.c uses the fact that
   1.132 -	 * this is the last member of the enum when sanity-checking; if other
   1.133 -	 * reasons are added after it, the check must be updated.
   1.134 -	 */
   1.135 -	PURPLE_CONNECTION_ERROR_OTHER_ERROR = 16
   1.136 -} PurpleConnectionError;
   1.137 -
   1.138 -/** Holds the type of an error along with its description. */
   1.139 -typedef struct
   1.140 -{
   1.141 -	/** The type of error. */
   1.142 -	PurpleConnectionError type;
   1.143 -	/** A localised, human-readable description of the error. */
   1.144 -	char *description;
   1.145 -} PurpleConnectionErrorInfo;
   1.146 -
   1.147 -#include <time.h>
   1.148 -
   1.149 -#include "account.h"
   1.150 -#include "plugin.h"
   1.151 -#include "status.h"
   1.152 -#include "sslconn.h"
   1.153 -
   1.154 -/** Connection UI operations.  Used to notify the user of changes to
   1.155 - *  connections, such as being disconnected, and to respond to the
   1.156 - *  underlying network connection appearing and disappearing.  UIs should
   1.157 - *  call #purple_connections_set_ui_ops() with an instance of this struct.
   1.158 - *
   1.159 - *  @see @ref ui-ops
   1.160 - */
   1.161 -typedef struct
   1.162 -{
   1.163 -	/** When an account is connecting, this operation is called to notify
   1.164 -	 *  the UI of what is happening, as well as which @a step out of @a
   1.165 -	 *  step_count has been reached (which might be displayed as a progress
   1.166 -	 *  bar).
   1.167 -	 *  @see #purple_connection_update_progress
   1.168 -	 */
   1.169 -	void (*connect_progress)(PurpleConnection *gc,
   1.170 -	                         const char *text,
   1.171 -	                         size_t step,
   1.172 -	                         size_t step_count);
   1.173 -
   1.174 -	/** Called when a connection is established (just before the
   1.175 -	 *  @ref signed-on signal).
   1.176 -	 */
   1.177 -	void (*connected)(PurpleConnection *gc);
   1.178 -	/** Called when a connection is ended (between the @ref signing-off
   1.179 -	 *  and @ref signed-off signals).
   1.180 -	 */
   1.181 -	void (*disconnected)(PurpleConnection *gc);
   1.182 -
   1.183 -	/** Used to display connection-specific notices.  (Pidgin's Gtk user
   1.184 -	 *  interface implements this as a no-op; #purple_connection_notice(),
   1.185 -	 *  which uses this operation, is not used by any of the protocols
   1.186 -	 *  shipped with libpurple.)
   1.187 -	 */
   1.188 -	void (*notice)(PurpleConnection *gc, const char *text);
   1.189 -
   1.190 -	/** Called when an error causes a connection to be disconnected.
   1.191 -	 *  Called before #disconnected.
   1.192 -	 *  @param text  a localized error message.
   1.193 -	 *  @see #purple_connection_error
   1.194 -	 *  @deprecated in favour of
   1.195 -	 *              #PurpleConnectionUiOps.report_disconnect_reason.
   1.196 -	 */
   1.197 -	void (*report_disconnect)(PurpleConnection *gc, const char *text);
   1.198 -
   1.199 -	/** Called when libpurple discovers that the computer's network
   1.200 -	 *  connection is active.  On Linux, this uses Network Manager if
   1.201 -	 *  available; on Windows, it uses Win32's network change notification
   1.202 -	 *  infrastructure.
   1.203 -	 */
   1.204 -	void (*network_connected)(void);
   1.205 -	/** Called when libpurple discovers that the computer's network
   1.206 -	 *  connection has gone away.
   1.207 -	 */
   1.208 -	void (*network_disconnected)(void);
   1.209 -
   1.210 -	/** Called when an error causes a connection to be disconnected.
   1.211 -	 *  Called before #disconnected.  This op is intended to replace
   1.212 -	 *  #report_disconnect.  If both are implemented, this will be called
   1.213 -	 *  first; however, there's no real reason to implement both.
   1.214 -	 *  @param reason  why the connection ended, if known, or
   1.215 -	 *                 #PURPLE_CONNECTION_ERROR_OTHER_ERROR, if not.
   1.216 -	 *  @param text  a localized message describing the disconnection
   1.217 -	 *               in more detail to the user.
   1.218 -	 *  @see #purple_connection_error_reason
   1.219 -	 *  @since 2.3.0
   1.220 -	 */
   1.221 -	void (*report_disconnect_reason)(PurpleConnection *gc,
   1.222 -	                                 PurpleConnectionError reason,
   1.223 -	                                 const char *text);
   1.224 -
   1.225 -	void (*_purple_reserved1)(void);
   1.226 -	void (*_purple_reserved2)(void);
   1.227 -	void (*_purple_reserved3)(void);
   1.228 -} PurpleConnectionUiOps;
   1.229 -
   1.230 -
   1.231 -/* Represents an active connection on an account. */
   1.232 -struct _PurpleConnection
   1.233 -{
   1.234 -	PurplePlugin *prpl;            /**< The protocol plugin.               */
   1.235 -	PurpleConnectionFlags flags;   /**< Connection flags.                  */
   1.236 -
   1.237 -	PurpleConnectionState state;   /**< The connection state.              */
   1.238 -
   1.239 -	PurpleAccount *account;        /**< The account being connected to.    */
   1.240 -	char *password;              /**< The password used.                 */
   1.241 -	int inpa;                    /**< The input watcher.                 */
   1.242 -
   1.243 -	GSList *buddy_chats;         /**< A list of active chats
   1.244 -	                                  (#PurpleConversation structs of type
   1.245 -	                                  #PURPLE_CONV_TYPE_CHAT).           */
   1.246 -	void *proto_data;            /**< Protocol-specific data.            */
   1.247 -
   1.248 -	char *display_name;          /**< How you appear to other people.    */
   1.249 -	guint keepalive;             /**< Keep-alive.                        */
   1.250 -
   1.251 -	/** Wants to Die state.  This is set when the user chooses to log out, or
   1.252 -	 * when the protocol is disconnected and should not be automatically
   1.253 -	 * reconnected (incorrect password, etc.).  prpls should rely on
   1.254 -	 * purple_connection_error_reason() to set this for them rather than
   1.255 -	 * setting it themselves.
   1.256 -	 * @see purple_connection_error_is_fatal
   1.257 -	 */
   1.258 -	gboolean wants_to_die;
   1.259 -
   1.260 -	guint disconnect_timeout;    /**< Timer used for nasty stack tricks  */
   1.261 -	time_t last_received;        /**< When we last received a packet. Set by the
   1.262 -					  prpl to avoid sending unneeded keepalives */
   1.263 -};
   1.264 -
   1.265 -#ifdef __cplusplus
   1.266 -extern "C" {
   1.267 -#endif
   1.268 -
   1.269 -/**************************************************************************/
   1.270 -/** @name Connection API                                                  */
   1.271 -/**************************************************************************/
   1.272 -/*@{*/
   1.273 -
   1.274 -#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_CONNECTION_C_)
   1.275 -/**
   1.276 - * This function should only be called by purple_account_connect()
   1.277 - * in account.c.  If you're trying to sign on an account, use that
   1.278 - * function instead.
   1.279 - *
   1.280 - * Creates a connection to the specified account and either connects
   1.281 - * or attempts to register a new account.  If you are logging in,
   1.282 - * the connection uses the current active status for this account.
   1.283 - * So if you want to sign on as "away," for example, you need to
   1.284 - * have called purple_account_set_status(account, "away").
   1.285 - * (And this will call purple_account_connect() automatically).
   1.286 - *
   1.287 - * @param account  The account the connection should be connecting to.
   1.288 - * @param regist   Whether we are registering a new account or just
   1.289 - *                 trying to do a normal signon.
   1.290 - * @param password The password to use.
   1.291 - *
   1.292 - * @deprecated As this is internal, we should make it private in 3.0.0.
   1.293 - */
   1.294 -void purple_connection_new(PurpleAccount *account, gboolean regist,
   1.295 -									const char *password);
   1.296 -#endif
   1.297 -
   1.298 -#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_CONNECTION_C_)
   1.299 -/**
   1.300 - * This function should only be called by purple_account_unregister()
   1.301 - * in account.c.
   1.302 - *
   1.303 - * Tries to unregister the account on the server. If the account is not
   1.304 - * connected, also creates a new connection.
   1.305 - *
   1.306 - * @param account  The account to unregister
   1.307 - * @param password The password to use.
   1.308 - * @param cb Optional callback to be called when unregistration is complete
   1.309 - * @param user_data user data to pass to the callback
   1.310 - *
   1.311 - * @deprecated As this is internal, we should make it private in 3.0.0.
   1.312 - */
   1.313 -void purple_connection_new_unregister(PurpleAccount *account, const char *password, PurpleAccountUnregistrationCb cb, void *user_data);
   1.314 -#endif
   1.315 -
   1.316 -#if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_CONNECTION_C_)
   1.317 -/**
   1.318 - * Disconnects and destroys a PurpleConnection.
   1.319 - *
   1.320 - * This function should only be called by purple_account_disconnect()
   1.321 - * in account.c.  If you're trying to sign off an account, use that
   1.322 - * function instead.
   1.323 - *
   1.324 - * @param gc The purple connection to destroy.
   1.325 - *
   1.326 - * @deprecated As this is internal, we should make it private in 3.0.0.
   1.327 - */
   1.328 -void purple_connection_destroy(PurpleConnection *gc);
   1.329 -#endif
   1.330 -
   1.331 -/**
   1.332 - * Sets the connection state.  PRPLs should call this and pass in
   1.333 - * the state #PURPLE_CONNECTED when the account is completely
   1.334 - * signed on.  What does it mean to be completely signed on?  If
   1.335 - * the core can call prpl->set_status, and it successfully changes
   1.336 - * your status, then the account is online.
   1.337 - *
   1.338 - * @param gc    The connection.
   1.339 - * @param state The connection state.
   1.340 - */
   1.341 -void purple_connection_set_state(PurpleConnection *gc, PurpleConnectionState state);
   1.342 -
   1.343 -/**
   1.344 - * Sets the connection's account.
   1.345 - *
   1.346 - * @param gc      The connection.
   1.347 - * @param account The account.
   1.348 - */
   1.349 -void purple_connection_set_account(PurpleConnection *gc, PurpleAccount *account);
   1.350 -
   1.351 -/**
   1.352 - * Sets the connection's displayed name.
   1.353 - *
   1.354 - * @param gc   The connection.
   1.355 - * @param name The displayed name.
   1.356 - */
   1.357 -void purple_connection_set_display_name(PurpleConnection *gc, const char *name);
   1.358 -
   1.359 -/**
   1.360 - * Returns the connection state.
   1.361 - *
   1.362 - * @param gc The connection.
   1.363 - *
   1.364 - * @return The connection state.
   1.365 - */
   1.366 -PurpleConnectionState purple_connection_get_state(const PurpleConnection *gc);
   1.367 -
   1.368 -/**
   1.369 - * Returns TRUE if the account is connected, otherwise returns FALSE.
   1.370 - *
   1.371 - * @return TRUE if the account is connected, otherwise returns FALSE.
   1.372 - */
   1.373 -#define PURPLE_CONNECTION_IS_CONNECTED(gc) \
   1.374 -	(purple_connection_get_state(gc) == PURPLE_CONNECTED)
   1.375 -
   1.376 -/**
   1.377 - * Returns the connection's account.
   1.378 - *
   1.379 - * @param gc The connection.
   1.380 - *
   1.381 - * @return The connection's account.
   1.382 - */
   1.383 -PurpleAccount *purple_connection_get_account(const PurpleConnection *gc);
   1.384 -
   1.385 -/**
   1.386 - * Returns the protocol plugin managing a connection.
   1.387 - *
   1.388 - * @param gc The connection.
   1.389 - *
   1.390 - * @return The protocol plugin.
   1.391 - * @since 2.4.0
   1.392 - */
   1.393 -PurplePlugin * purple_connection_get_prpl(const PurpleConnection *gc);
   1.394 -
   1.395 -/**
   1.396 - * Returns the connection's password.
   1.397 - *
   1.398 - * @param gc The connection.
   1.399 - *
   1.400 - * @return The connection's password.
   1.401 - */
   1.402 -const char *purple_connection_get_password(const PurpleConnection *gc);
   1.403 -
   1.404 -/**
   1.405 - * Returns the connection's displayed name.
   1.406 - *
   1.407 - * @param gc The connection.
   1.408 - *
   1.409 - * @return The connection's displayed name.
   1.410 - */
   1.411 -const char *purple_connection_get_display_name(const PurpleConnection *gc);
   1.412 -
   1.413 -/**
   1.414 - * Updates the connection progress.
   1.415 - *
   1.416 - * @param gc    The connection.
   1.417 - * @param text  Information on the current step.
   1.418 - * @param step  The current step.
   1.419 - * @param count The total number of steps.
   1.420 - */
   1.421 -void purple_connection_update_progress(PurpleConnection *gc, const char *text,
   1.422 -									 size_t step, size_t count);
   1.423 -
   1.424 -/**
   1.425 - * Displays a connection-specific notice.
   1.426 - *
   1.427 - * @param gc   The connection.
   1.428 - * @param text The notice text.
   1.429 - */
   1.430 -void purple_connection_notice(PurpleConnection *gc, const char *text);
   1.431 -
   1.432 -/**
   1.433 - * Closes a connection with an error.
   1.434 - *
   1.435 - * @param gc     The connection.
   1.436 - * @param reason The error text, which may not be @c NULL.
   1.437 - * @deprecated in favour of #purple_connection_error_reason.  Calling
   1.438 - *  @c purple_connection_error(gc, text) is equivalent to calling
   1.439 - *  @c purple_connection_error_reason(gc, reason, text) where @c reason is
   1.440 - *  #PURPLE_CONNECTION_ERROR_OTHER_ERROR if @c gc->wants_to_die is @c TRUE, and
   1.441 - *  #PURPLE_CONNECTION_ERROR_NETWORK_ERROR if not.  (This is to keep
   1.442 - *  auto-reconnection behaviour the same when using old prpls which don't use
   1.443 - *  reasons yet.)
   1.444 - */
   1.445 -void purple_connection_error(PurpleConnection *gc, const char *reason);
   1.446 -
   1.447 -/**
   1.448 - * Closes a connection with an error and a human-readable description of the
   1.449 - * error.  It also sets @c gc->wants_to_die to the value of
   1.450 - * #purple_connection_error_is_fatal(@a reason), mainly for
   1.451 - * backwards-compatibility.
   1.452 - *
   1.453 - * @param gc          the connection which is closing.
   1.454 - * @param reason      why the connection is closing.
   1.455 - * @param description a non-@c NULL localized description of the error.
   1.456 - * @since 2.3.0
   1.457 - */
   1.458 -void
   1.459 -purple_connection_error_reason (PurpleConnection *gc,
   1.460 -                                PurpleConnectionError reason,
   1.461 -                                const char *description);
   1.462 -
   1.463 -/**
   1.464 - * Closes a connection due to an SSL error; this is basically a shortcut to
   1.465 - * turning the #PurpleSslErrorType into a #PurpleConnectionError and a
   1.466 - * human-readable string and then calling purple_connection_error_reason().
   1.467 - * @since 2.3.0
   1.468 - */
   1.469 -void
   1.470 -purple_connection_ssl_error (PurpleConnection *gc,
   1.471 -                             PurpleSslErrorType ssl_error);
   1.472 -
   1.473 -/**
   1.474 - * Reports whether a disconnection reason is fatal (in which case the account
   1.475 - * should probably not be automatically reconnected) or transient (so
   1.476 - * auto-reconnection is a good idea).
   1.477 - * For instance, #PURPLE_CONNECTION_ERROR_NETWORK_ERROR is a temporary error,
   1.478 - * which might be caused by losing the network connection, so <tt>
   1.479 - * purple_connection_error_is_fatal (PURPLE_CONNECTION_ERROR_NETWORK_ERROR)</tt>
   1.480 - * is @c FALSE.  On the other hand,
   1.481 - * #PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED probably indicates a
   1.482 - * misconfiguration of the account which needs the user to go fix it up, so
   1.483 - * <tt> purple_connection_error_is_fatal
   1.484 - * (PURPLE_CONNECTION_ERROR_AUTHENTICATION_FAILED)</tt> is @c TRUE.
   1.485 - *
   1.486 - * (This function is meant to replace checking PurpleConnection.wants_to_die.)
   1.487 - *
   1.488 - * @return @c TRUE if the account should not be automatically reconnected, and
   1.489 - *         @c FALSE otherwise.
   1.490 - * @since 2.3.0
   1.491 - */
   1.492 -gboolean
   1.493 -purple_connection_error_is_fatal (PurpleConnectionError reason);
   1.494 -
   1.495 -/*@}*/
   1.496 -
   1.497 -/**************************************************************************/
   1.498 -/** @name Connections API                                                 */
   1.499 -/**************************************************************************/
   1.500 -/*@{*/
   1.501 -
   1.502 -/**
   1.503 - * Disconnects from all connections.
   1.504 - */
   1.505 -void purple_connections_disconnect_all(void);
   1.506 -
   1.507 -/**
   1.508 - * Returns a list of all active connections.  This does not
   1.509 - * include connections that are in the process of connecting.
   1.510 - *
   1.511 - * @constreturn A list of all active connections.
   1.512 - */
   1.513 -GList *purple_connections_get_all(void);
   1.514 -
   1.515 -/**
   1.516 - * Returns a list of all connections in the process of connecting.
   1.517 - *
   1.518 - * @constreturn A list of connecting connections.
   1.519 - */
   1.520 -GList *purple_connections_get_connecting(void);
   1.521 -
   1.522 -/**
   1.523 - * Checks if gc is still a valid pointer to a gc.
   1.524 - *
   1.525 - * @return @c TRUE if gc is valid.
   1.526 - */
   1.527 -/*
   1.528 - * TODO: Eventually this bad boy will be removed, because it is
   1.529 - *       a gross fix for a crashy problem.
   1.530 - */
   1.531 -#define PURPLE_CONNECTION_IS_VALID(gc) (g_list_find(purple_connections_get_all(), (gc)) != NULL)
   1.532 -
   1.533 -/*@}*/
   1.534 -
   1.535 -/**************************************************************************/
   1.536 -/** @name UI Registration Functions                                       */
   1.537 -/**************************************************************************/
   1.538 -/*@{*/
   1.539 -
   1.540 -/**
   1.541 - * Sets the UI operations structure to be used for connections.
   1.542 - *
   1.543 - * @param ops The UI operations structure.
   1.544 - */
   1.545 -void purple_connections_set_ui_ops(PurpleConnectionUiOps *ops);
   1.546 -
   1.547 -/**
   1.548 - * Returns the UI operations structure used for connections.
   1.549 - *
   1.550 - * @return The UI operations structure in use.
   1.551 - */
   1.552 -PurpleConnectionUiOps *purple_connections_get_ui_ops(void);
   1.553 -
   1.554 -/*@}*/
   1.555 -
   1.556 -/**************************************************************************/
   1.557 -/** @name Connections Subsystem                                           */
   1.558 -/**************************************************************************/
   1.559 -/*@{*/
   1.560 -
   1.561 -/**
   1.562 - * Initializes the connections subsystem.
   1.563 - */
   1.564 -void purple_connections_init(void);
   1.565 -
   1.566 -/**
   1.567 - * Uninitializes the connections subsystem.
   1.568 - */
   1.569 -void purple_connections_uninit(void);
   1.570 -
   1.571 -/**
   1.572 - * Returns the handle to the connections subsystem.
   1.573 - *
   1.574 - * @return The connections subsystem handle.
   1.575 - */
   1.576 -void *purple_connections_get_handle(void);
   1.577 -
   1.578 -/*@}*/
   1.579 -
   1.580 -
   1.581 -#ifdef __cplusplus
   1.582 -}
   1.583 -#endif
   1.584 -
   1.585 -#endif /* _PURPLE_CONNECTION_H_ */