aboutsummaryrefslogtreecommitdiffstats
path: root/src/vmime/net/timeoutHandler.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/vmime/net/timeoutHandler.hpp')
-rw-r--r--src/vmime/net/timeoutHandler.hpp10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/vmime/net/timeoutHandler.hpp b/src/vmime/net/timeoutHandler.hpp
index 24129701..397cc796 100644
--- a/src/vmime/net/timeoutHandler.hpp
+++ b/src/vmime/net/timeoutHandler.hpp
@@ -38,7 +38,9 @@ namespace vmime {
namespace net {
-/** A class to manage time-out in messaging services.
+/** A class to manage timeouts in messaging services. This can be used
+ * to stop operations that takes too much time to complete (ie. no data
+ * received from the server for a long time if the network link is down).
*/
class VMIME_EXPORT timeoutHandler : public object
@@ -49,18 +51,18 @@ public:
/** Called to test if the time limit has been reached.
*
- * @return true if the time-out delay is elapsed
+ * @return true if the timeout delay is elapsed
*/
virtual bool isTimeOut() = 0;
- /** Called to reset the time-out counter.
+ /** Called to reset the timeout counter.
*/
virtual void resetTimeOut() = 0;
/** Called when the time limit has been reached (when
* isTimeOut() returned true).
*
- * @return true to continue (and reset the time-out)
+ * @return true to continue (and reset the timeout)
* or false to cancel the current operation
*/
virtual bool handleTimeOut() = 0;