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_FACTORY_H
36 #define D_BT_MESSAGE_FACTORY_H
37 
38 #include "common.h"
39 
40 #include <memory>
41 
42 namespace aria2 {
43 
44 class BtMessage;
45 class BtHandshakeMessage;
46 class BtAllowedFastMessage;
47 class BtBitfieldMessage;
48 class BtCancelMessage;
49 class BtChokeMessage;
50 class BtHaveAllMessage;
51 class BtHaveMessage;
52 class BtHaveNoneMessage;
53 class BtInterestedMessage;
54 class BtKeepAliveMessage;
55 class BtNotInterestedMessage;
56 class BtPieceMessage;
57 class BtPortMessage;
58 class BtRejectMessage;
59 class BtRequestMessage;
60 class BtUnchokeMessage;
61 class BtExtendedMessage;
62 class ExtensionMessage;
63 class Piece;
64 
65 class BtMessageFactory {
66 public:
67   virtual ~BtMessageFactory() = default;
68 
69   virtual std::unique_ptr<BtMessage> createBtMessage(const unsigned char* msg,
70                                                      size_t msgLength) = 0;
71 
72   virtual std::unique_ptr<BtHandshakeMessage>
73   createHandshakeMessage(const unsigned char* msg, size_t msgLength) = 0;
74 
75   virtual std::unique_ptr<BtHandshakeMessage>
76   createHandshakeMessage(const unsigned char* infoHash,
77                          const unsigned char* peerId) = 0;
78 
79   virtual std::unique_ptr<BtRequestMessage>
80   createRequestMessage(const std::shared_ptr<Piece>& piece,
81                        size_t blockIndex) = 0;
82 
83   virtual std::unique_ptr<BtCancelMessage>
84   createCancelMessage(size_t index, int32_t begin, int32_t length) = 0;
85 
86   virtual std::unique_ptr<BtPieceMessage>
87   createPieceMessage(size_t index, int32_t begin, int32_t length) = 0;
88 
89   virtual std::unique_ptr<BtHaveMessage> createHaveMessage(size_t index) = 0;
90 
91   virtual std::unique_ptr<BtChokeMessage> createChokeMessage() = 0;
92 
93   virtual std::unique_ptr<BtUnchokeMessage> createUnchokeMessage() = 0;
94 
95   virtual std::unique_ptr<BtInterestedMessage> createInterestedMessage() = 0;
96 
97   virtual std::unique_ptr<BtNotInterestedMessage>
98   createNotInterestedMessage() = 0;
99 
100   virtual std::unique_ptr<BtBitfieldMessage> createBitfieldMessage() = 0;
101 
102   virtual std::unique_ptr<BtKeepAliveMessage> createKeepAliveMessage() = 0;
103 
104   virtual std::unique_ptr<BtHaveAllMessage> createHaveAllMessage() = 0;
105 
106   virtual std::unique_ptr<BtHaveNoneMessage> createHaveNoneMessage() = 0;
107 
108   virtual std::unique_ptr<BtRejectMessage>
109   createRejectMessage(size_t index, int32_t begin, int32_t length) = 0;
110 
111   virtual std::unique_ptr<BtAllowedFastMessage>
112   createAllowedFastMessage(size_t index) = 0;
113 
114   virtual std::unique_ptr<BtPortMessage> createPortMessage(uint16_t port) = 0;
115 
116   virtual std::unique_ptr<BtExtendedMessage>
117   createBtExtendedMessage(std::unique_ptr<ExtensionMessage> msg) = 0;
118 };
119 
120 } // namespace aria2
121 
122 #endif // D_BT_MESSAGE_FACTORY_H
123