VMime
defaultTimeoutHandler Class Reference
Inheritance diagram for defaultTimeoutHandler:
Collaboration diagram for defaultTimeoutHandler:

Public Member Functions

 defaultTimeoutHandler ()
 
 ~defaultTimeoutHandler ()
 
bool isTimeOut ()
 
void resetTimeOut ()
 
bool handleTimeOut ()
 
- Public Member Functions inherited from timeoutHandler
virtual ~timeoutHandler ()
 

Additional Inherited Members

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

Detailed Description

A default timeout handler for messaging services.

The default action is to throw a exceptions::operation_timed_out exception when an operation is blocked for more than 30 seconds.

Constructor & Destructor Documentation

◆ defaultTimeoutHandler()

◆ ~defaultTimeoutHandler()

Member Function Documentation

◆ handleTimeOut()

bool handleTimeOut ( )
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

Implements timeoutHandler.

◆ isTimeOut()

bool isTimeOut ( )
virtual

Called to test if the time limit has been reached.

Returns
true if the timeout delay is elapsed

Implements timeoutHandler.

◆ resetTimeOut()

void resetTimeOut ( )
virtual

Called to reset the timeout counter.

Implements timeoutHandler.


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