#include <time.h>
#include "account.h"
#include "plugin.h"
#include "status.h"
#include "sslconn.h"
Include dependency graph for connection.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Data Structures | |
struct | PurpleConnectionErrorInfo |
Holds the type of an error along with its description. More... | |
struct | PurpleConnectionUiOps |
Connection UI operations. More... | |
struct | _PurpleConnection |
Connection API | |
#define | PURPLE_CONNECTION_IS_CONNECTED(gc) (purple_connection_get_state(gc) == PURPLE_CONNECTED) |
Returns TRUE if the account is connected, otherwise returns FALSE. | |
void | purple_connection_new (PurpleAccount *account, gboolean regist, const char *password) |
This function should only be called by purple_account_connect() in account.c. | |
void | purple_connection_new_unregister (PurpleAccount *account, const char *password, PurpleAccountUnregistrationCb cb, void *user_data) |
This function should only be called by purple_account_unregister() in account.c. | |
void | purple_connection_destroy (PurpleConnection *gc) |
Disconnects and destroys a PurpleConnection. | |
void | purple_connection_set_state (PurpleConnection *gc, PurpleConnectionState state) |
Sets the connection state. | |
void | purple_connection_set_account (PurpleConnection *gc, PurpleAccount *account) |
Sets the connection's account. | |
void | purple_connection_set_display_name (PurpleConnection *gc, const char *name) |
Sets the connection's displayed name. | |
PurpleConnectionState | purple_connection_get_state (const PurpleConnection *gc) |
Returns the connection state. | |
PurpleAccount * | purple_connection_get_account (const PurpleConnection *gc) |
Returns the connection's account. | |
PurplePlugin * | purple_connection_get_prpl (const PurpleConnection *gc) |
Returns the protocol plugin managing a connection. | |
const char * | purple_connection_get_password (const PurpleConnection *gc) |
Returns the connection's password. | |
const char * | purple_connection_get_display_name (const PurpleConnection *gc) |
Returns the connection's displayed name. | |
void | purple_connection_update_progress (PurpleConnection *gc, const char *text, size_t step, size_t count) |
Updates the connection progress. | |
void | purple_connection_notice (PurpleConnection *gc, const char *text) |
Displays a connection-specific notice. | |
void | purple_connection_error (PurpleConnection *gc, const char *reason) |
Closes a connection with an error. | |
void | purple_connection_error_reason (PurpleConnection *gc, PurpleConnectionError reason, const char *description) |
Closes a connection with an error and a human-readable description of the error. | |
void | purple_connection_ssl_error (PurpleConnection *gc, PurpleSslErrorType ssl_error) |
Closes a connection due to an SSL error; this is basically a shortcut to turning the PurpleSslErrorType into a PurpleConnectionError and a human-readable string and then calling purple_connection_error_reason(). | |
gboolean | purple_connection_error_is_fatal (PurpleConnectionError reason) |
Reports whether a disconnection reason is fatal (in which case the account should probably not be automatically reconnected) or transient (so auto-reconnection is a good idea). | |
Connections API | |
#define | PURPLE_CONNECTION_IS_VALID(gc) (g_list_find(purple_connections_get_all(), (gc)) != NULL) |
Checks if gc is still a valid pointer to a gc. | |
void | purple_connections_disconnect_all (void) |
Disconnects from all connections. | |
GList * | purple_connections_get_all (void) |
Returns a list of all active connections. | |
GList * | purple_connections_get_connecting (void) |
Returns a list of all connections in the process of connecting. | |
UI Registration Functions | |
void | purple_connections_set_ui_ops (PurpleConnectionUiOps *ops) |
Sets the UI operations structure to be used for connections. | |
PurpleConnectionUiOps * | purple_connections_get_ui_ops (void) |
Returns the UI operations structure used for connections. | |
Connections Subsystem | |
void | purple_connections_init (void) |
Initializes the connections subsystem. | |
void | purple_connections_uninit (void) |
Uninitializes the connections subsystem. | |
void * | purple_connections_get_handle (void) |
Returns the handle to the connections subsystem. | |
Typedefs | |
typedef _PurpleConnection | PurpleConnection |
| |
Enumerations | |
enum | PurpleConnectionFlags { 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 } |
Flags to change behavior of the client for a given connection. More... | |
enum | PurpleConnectionState { PURPLE_DISCONNECTED = 0, PURPLE_CONNECTED, PURPLE_CONNECTING } |
enum | PurpleConnectionError { 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_OTHER_ERROR = 16 } |
Possible errors that can cause a connection to be closed. More... |
Definition in file connection.h.
|
Returns TRUE if the account is connected, otherwise returns FALSE.
Definition at line 370 of file connection.h. |
|
Checks if gc is still a valid pointer to a gc.
Definition at line 528 of file connection.h. |
|
Possible errors that can cause a connection to be closed.
Definition at line 62 of file connection.h. |
|
Flags to change behavior of the client for a given connection.
Definition at line 36 of file connection.h. |
|
Definition at line 51 of file connection.h. |
|
Disconnects and destroys a PurpleConnection. This function should only be called by purple_account_disconnect() in account.c. If you're trying to sign off an account, use that function instead.
|
|
Closes a connection with an error.
purple_connection_error(gc, text) is equivalent to calling purple_connection_error_reason(gc, reason, text) where reason is PURPLE_CONNECTION_ERROR_OTHER_ERROR if gc->wants_to_die is TRUE , and PURPLE_CONNECTION_ERROR_NETWORK_ERROR if not. (This is to keep auto-reconnection behaviour the same when using old prpls which don't use reasons yet.) |
|
Reports whether a disconnection reason is fatal (in which case the account should probably not be automatically reconnected) or transient (so auto-reconnection is a good idea).
For instance, PURPLE_CONNECTION_ERROR_NETWORK_ERROR is a temporary error, which might be caused by losing the network connection, so (This function is meant to replace checking PurpleConnection.wants_to_die.)
|
|
Closes a connection with an error and a human-readable description of the error.
It also sets
|
|
Returns the connection's account.
|
|
Returns the connection's displayed name.
|
|
Returns the connection's password.
|
|
Returns the protocol plugin managing a connection.
|
|
Returns the connection state.
|
|
This function should only be called by purple_account_connect() in account.c. If you're trying to sign on an account, use that function instead. Creates a connection to the specified account and either connects or attempts to register a new account. If you are logging in, the connection uses the current active status for this account. So if you want to sign on as "away," for example, you need to have called purple_account_set_status(account, "away"). (And this will call purple_account_connect() automatically).
|
|
This function should only be called by purple_account_unregister() in account.c. Tries to unregister the account on the server. If the account is not connected, also creates a new connection.
|
|
Displays a connection-specific notice.
|
|
Sets the connection's account.
|
|
Sets the connection's displayed name.
|
|
Sets the connection state. PRPLs should call this and pass in the state PURPLE_CONNECTED when the account is completely signed on. What does it mean to be completely signed on? If the core can call prpl->set_status, and it successfully changes your status, then the account is online.
|
|
Closes a connection due to an SSL error; this is basically a shortcut to turning the PurpleSslErrorType into a PurpleConnectionError and a human-readable string and then calling purple_connection_error_reason().
|
|
Updates the connection progress.
|
|
Returns a list of all active connections. This does not include connections that are in the process of connecting.
|
|
Returns a list of all connections in the process of connecting.
|
|
Returns the handle to the connections subsystem.
|
|
Returns the UI operations structure used for connections.
|
|
Sets the UI operations structure to be used for connections.
|