blob: fed1bc48842cd8f216dd1e61db558756d93b1b68 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_NET_TIMEOUTHANDLER_HPP_INCLUDED
#define VMIME_NET_TIMEOUTHANDLER_HPP_INCLUDED
#include "vmime/config.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES
#include "vmime/types.hpp"
namespace vmime {
namespace net {
/** 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 {
public:
virtual ~timeoutHandler() { }
/** Called to test if the time limit has been reached.
*
* @return true if the timeout delay is elapsed
*/
virtual bool isTimeOut() = 0;
/** 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 timeout)
* or false to cancel the current operation
*/
virtual bool handleTimeOut() = 0;
};
/** A class to create 'timeoutHandler' objects.
*/
class timeoutHandlerFactory : public object {
public:
virtual ~timeoutHandlerFactory() { }
virtual shared_ptr <timeoutHandler> create() = 0;
};
} // net
} // vmime
#endif // VMIME_HAVE_MESSAGING_FEATURES
#endif // VMIME_NET_TIMEOUTHANDLER_HPP_INCLUDED
|
