aria2/src/PeerAbstractCommand.h

/* <!-- 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_PEER_ABSTRACT_COMMAND_H
#define D_PEER_ABSTRACT_COMMAND_H

#include "Command.h"

#include <memory>

#include "TimerA2.h"

namespace aria2 {

class DownloadEngine;
class Exception;
class Peer;
class SocketCore;

class PeerAbstractCommand : public Command {
private:
  Timer checkPoint_;
  std::chrono::seconds timeout_;
  DownloadEngine* e_;
  std::shared_ptr<SocketCore> socket_;
  std::shared_ptr<Peer> peer_;

  bool checkSocketIsReadable_;
  bool checkSocketIsWritable_;
  std::shared_ptr<SocketCore> readCheckTarget_;
  std::shared_ptr<SocketCore> writeCheckTarget_;
  bool noCheck_;
protected:
  DownloadEngine* getDownloadEngine() const
  {
    return e_;
  }

  const std::shared_ptr<SocketCore>& getSocket() const
  {
    return socket_;
  }

  void createSocket();

  const std::shared_ptr<Peer>& getPeer() const
  {
    return peer_;
  }

  void setTimeout(std::chrono::seconds timeout)
  {
    timeout_ = std::move(timeout);
  }

  virtual bool prepareForNextPeer(time_t wait);
  virtual void onAbort() {};
  // This function is called when DownloadFailureException is caught right after
  // the invocation of onAbort().
  virtual void onFailure(const Exception& err) {};
  virtual bool exitBeforeExecute() = 0;
  virtual bool executeInternal() = 0;
  void setReadCheckSocket(const std::shared_ptr<SocketCore>& socket);
  void setWriteCheckSocket(const std::shared_ptr<SocketCore>& socket);
  void disableReadCheckSocket();
  void disableWriteCheckSocket();
  void setNoCheck(bool check);
  void updateKeepAlive();
  void addCommandSelf();
public:
  PeerAbstractCommand(cuid_t cuid,
                      const std::shared_ptr<Peer>& peer,
                      DownloadEngine* e,
                      const std::shared_ptr<SocketCore>& s =
                      std::shared_ptr<SocketCore>());

  virtual ~PeerAbstractCommand();

  virtual bool execute() CXX11_OVERRIDE;
};

} // namespace aria2

#endif // D_PEER_ABSTRACT_COMMAND_H