aria2/src/BtRequestFactory.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_BT_REQUEST_FACTORY_H_
#define _D_BT_REQUEST_FACTORY_H_

#include "common.h"

#include <vector>

#include "SharedHandle.h"

namespace aria2 {

class Piece;
class BtMessage;

class BtRequestFactory {
public:
  virtual ~BtRequestFactory() {}

  virtual void addTargetPiece(const SharedHandle<Piece>& piece) = 0;

  virtual void removeTargetPiece(const SharedHandle<Piece>& piece) = 0;

  virtual void removeAllTargetPiece() = 0;

  virtual size_t countTargetPiece() = 0;

  virtual size_t countMissingBlock() = 0;

  virtual void removeCompletedPiece() = 0;

  virtual void doChokedAction() = 0;

  /**
   * Creates RequestMessage objects associated to the pieces added by
   * addTargetPiece() and returns them.
   * The number of objects returned is capped by max.
   */
  virtual void createRequestMessages
  (std::vector<SharedHandle<BtMessage> >& requests, size_t max) = 0;

  /**
   * Use this method in end game mode.
   *
   */
  virtual void createRequestMessagesOnEndGame
  (std::vector<SharedHandle<BtMessage> >& requests, size_t max) = 0;

  /**
   * Stores the list of index of pieces added using addTargetPiece() into
   * indexes.
   */
  virtual void getTargetPieceIndexes(std::vector<size_t>& indexes) const = 0;

};

typedef SharedHandle<BtRequestFactory> BtRequestFactoryHandle;
typedef WeakHandle<BtRequestFactory> BtRequestFactoryWeakHandle;

} // namespace aria2

#endif // _D_BT_REQUEST_FACTORY_H_