TimeBasedCommand.h 2.94 KB
Newer Older
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
/* <!-- copyright */
/*
 * aria2 - The high speed download utility
 *
 * Copyright (C) 2006 Tatsuhiro Tsujikawa
 *
 * 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 2 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
 *
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
 */
/* copyright --> */
#ifndef D_TIME_BASED_COMMAND_H
#define D_TIME_BASED_COMMAND_H

#include "Command.h"
#include "TimerA2.h"

namespace aria2 {

class DownloadEngine;

45
class TimeBasedCommand : public Command {
46 47 48
private:
  DownloadEngine* e_;

49 50
  Timer checkPoint_;

51
  std::chrono::seconds interval_;
52

53 54 55 56
  /**
   * setting exit_ to true if this command's job has finished and you want to
   * delete this command.
   * The exit_ variable is evaluated  after preProcess(), process(),
57
   * postProcess(), and terminate processing immediately and execute() returns
58 59 60 61 62 63 64
   * true.
   */
  bool exit_;

  bool routineCommand_;

protected:
65 66 67 68 69 70
  DownloadEngine* getDownloadEngine() const { return e_; }

  void enableExit() { exit_ = true; }

  const std::chrono::seconds& getInterval() const { return interval_; }

71 72
public:
  /**
73
   * preProcess() is called each time when execute() is called.
74
   */
75
  virtual void preProcess(){};
76 77

  /**
78
   * process() is called only when execute() is called and specified time has
79 80 81 82 83
   * elapsed.
   */
  virtual void process() = 0;

  /**
84
   * postProcess() is called each time when execute() is called.
85
   */
86
  virtual void postProcess(){};
87 88

public:
89 90
  TimeBasedCommand(cuid_t cuid, DownloadEngine* e,
                   std::chrono::seconds interval, bool routineCommand = false);
91 92 93

  virtual ~TimeBasedCommand();

94
  virtual bool execute() CXX11_OVERRIDE;
95 96 97 98 99
};

} // namespace aria2

#endif // D_TIME_BASED_COMMAND_H