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_BT_MESSAGE_DISPATCHER_H
36 #define D_BT_MESSAGE_DISPATCHER_H
37 
38 #include "common.h"
39 
40 #include <vector>
41 #include <memory>
42 
43 #include "RequestSlot.h"
44 
45 namespace aria2 {
46 
47 class Piece;
48 class BtMessage;
49 
50 class BtMessageDispatcher {
51 public:
52   virtual ~BtMessageDispatcher() = default;
53 
54   virtual void addMessageToQueue(std::unique_ptr<BtMessage> btMessage) = 0;
55 
56   virtual void sendMessages() = 0;
57 
58   virtual void doCancelSendingPieceAction(size_t index, int32_t begin,
59                                           int32_t length) = 0;
60 
61   virtual void
62   doCancelSendingPieceAction(const std::shared_ptr<Piece>& piece) = 0;
63 
64   virtual void
65   doAbortOutstandingRequestAction(const std::shared_ptr<Piece>& piece) = 0;
66 
67   virtual void doChokedAction() = 0;
68 
69   virtual void doChokingAction() = 0;
70 
71   virtual void checkRequestSlotAndDoNecessaryThing() = 0;
72 
73   virtual bool isSendingInProgress() = 0;
74 
75   virtual size_t countMessageInQueue() = 0;
76 
77   virtual size_t countOutstandingRequest() = 0;
78 
79   virtual bool isOutstandingRequest(size_t index, size_t blockIndex) = 0;
80 
81   virtual const RequestSlot* getOutstandingRequest(size_t index, int32_t begin,
82                                                    int32_t length) = 0;
83 
84   virtual void removeOutstandingRequest(const RequestSlot* slot) = 0;
85 
86   virtual void addOutstandingRequest(std::unique_ptr<RequestSlot> slot) = 0;
87 
88   virtual size_t countOutstandingUpload() = 0;
89 };
90 
91 } // namespace aria2
92 
93 #endif // D_BT_MESSAGE_DISPATCHER_H
94