1 /* <!-- copyright */
2 /*
3  * aria2 - The high speed download utility
4  *
5  * Copyright (C) 2006 Tatsuhiro Tsujikawa
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  *
21  * In addition, as a special exception, the copyright holders give
22  * permission to link the code of portions of this program with the
23  * OpenSSL library under certain conditions as described in each
24  * individual source file, and distribute linked combinations
25  * including the two.
26  * You must obey the GNU General Public License in all respects
27  * for all of the code used other than OpenSSL.  If you modify
28  * file(s) with this exception, you may extend this exception to your
29  * version of the file(s), but you are not obligated to do so.  If you
30  * do not wish to do so, delete this exception statement from your
31  * version.  If you delete this exception statement from all source
32  * files in the program, then also delete it here.
33  */
34 /* copyright --> */
35 #ifndef D_TIME_BASED_COMMAND_H
36 #define D_TIME_BASED_COMMAND_H
37 
38 #include "Command.h"
39 #include "TimerA2.h"
40 
41 namespace aria2 {
42 
43 class DownloadEngine;
44 
45 class TimeBasedCommand : public Command {
46 private:
47   DownloadEngine* e_;
48 
49   Timer checkPoint_;
50 
51   std::chrono::seconds interval_;
52 
53   /**
54    * setting exit_ to true if this command's job has finished and you want to
55    * delete this command.
56    * The exit_ variable is evaluated  after preProcess(), process(),
57    * postProcess(), and terminate processing immediately and execute() returns
58    * true.
59    */
60   bool exit_;
61 
62   bool routineCommand_;
63 
64 protected:
getDownloadEngine()65   DownloadEngine* getDownloadEngine() const { return e_; }
66 
enableExit()67   void enableExit() { exit_ = true; }
68 
getInterval()69   const std::chrono::seconds& getInterval() const { return interval_; }
70 
71 public:
72   /**
73    * preProcess() is called each time when execute() is called.
74    */
preProcess()75   virtual void preProcess(){};
76 
77   /**
78    * process() is called only when execute() is called and specified time has
79    * elapsed.
80    */
81   virtual void process() = 0;
82 
83   /**
84    * postProcess() is called each time when execute() is called.
85    */
postProcess()86   virtual void postProcess(){};
87 
88 public:
89   TimeBasedCommand(cuid_t cuid, DownloadEngine* e,
90                    std::chrono::seconds interval, bool routineCommand = false);
91 
92   virtual ~TimeBasedCommand();
93 
94   virtual bool execute() CXX11_OVERRIDE;
95 };
96 
97 } // namespace aria2
98 
99 #endif // D_TIME_BASED_COMMAND_H
100