VMime
timeoutHandler Class Referenceabstract
Inheritance diagram for timeoutHandler:
Collaboration diagram for timeoutHandler:

Public Member Functions

virtual ~timeoutHandler ()
 
virtual bool isTimeOut ()=0
 
virtual void resetTimeOut ()=0
 
virtual bool handleTimeOut ()=0
 

Additional Inherited Members

- Protected Member Functions inherited from object
 object ()
 
 object (const object &)
 
objectoperator= (const object &)
 
virtual ~object ()
 

Detailed Description

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).

Constructor & Destructor Documentation

virtual ~timeoutHandler ( )
virtual

Member Function Documentation

virtual bool handleTimeOut ( )
pure virtual

Called when the time limit has been reached (when isTimeOut() returned true).

Returns
true to continue (and reset the timeout) or false to cancel the current operation

Implemented in defaultTimeoutHandler.

virtual bool isTimeOut ( )
pure virtual

Called to test if the time limit has been reached.

Returns
true if the timeout delay is elapsed

Implemented in defaultTimeoutHandler.

virtual void resetTimeOut ( )
pure virtual

Called to reset the timeout counter.

Implemented in defaultTimeoutHandler.


The documentation for this class was generated from the following file: