Mercurial > pidgin
comparison libpurple/connection.h @ 20067:143c6f34c6eb
Create purple_connection_reason_is_fatal, which is basically a replacement for
checking PurpleConnection.wants_to_die.
author | Will Thompson <will.thompson@collabora.co.uk> |
---|---|
date | Mon, 17 Sep 2007 15:30:51 +0000 |
parents | 95b2b7a39585 |
children | d3bd5414eb0f |
comparison
equal
deleted
inserted
replaced
20066:95b2b7a39585 | 20067:143c6f34c6eb |
---|---|
370 void | 370 void |
371 purple_connection_error_reason (PurpleConnection *gc, | 371 purple_connection_error_reason (PurpleConnection *gc, |
372 PurpleDisconnectReason reason, | 372 PurpleDisconnectReason reason, |
373 const char *description); | 373 const char *description); |
374 | 374 |
375 /** | |
376 * Reports whether a disconnection reason is fatal (in which case the account | |
377 * should probably not be automatically reconnected) or transient (so | |
378 * auto-reconnection is a good idea. | |
379 * For instance, #PURPLE_REASON_NETWORK_ERROR is a temporary | |
380 * error, which might be caused by losing the network connection, so | |
381 * @a purple_connection_reason_is_fatal(PURPLE_REASON_NETWORK_ERROR) is | |
382 * @a FALSE. On the other hand, #PURPLE_REASON_AUTHENTICATION_FAILED probably | |
383 * indicates a misconfiguration of the account which needs the user to go fix | |
384 * it up, so @a | |
385 * purple_connection_reason_is_fatal(PURPLE_REASON_AUTHENTICATION_FAILED) | |
386 * is @a TRUE. | |
387 * | |
388 * (This function is meant to replace checking PurpleConnection.wants_to_die.) | |
389 * | |
390 * @return @a TRUE iff automatic reconnection is a bad idea. | |
391 */ | |
392 gboolean | |
393 purple_connection_reason_is_fatal (PurpleDisconnectReason reason); | |
394 | |
375 /*@}*/ | 395 /*@}*/ |
376 | 396 |
377 /**************************************************************************/ | 397 /**************************************************************************/ |
378 /** @name Connections API */ | 398 /** @name Connections API */ |
379 /**************************************************************************/ | 399 /**************************************************************************/ |