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_DHT_MESSAGE_FACTORY_H
36 #define D_DHT_MESSAGE_FACTORY_H
37 
38 #include "common.h"
39 
40 #include <string>
41 #include <vector>
42 #include <memory>
43 
44 #include "A2STR.h"
45 #include "ValueBase.h"
46 
47 namespace aria2 {
48 
49 class DHTMessage;
50 class DHTQueryMessage;
51 class DHTResponseMessage;
52 class DHTPingMessage;
53 class DHTPingReplyMessage;
54 class DHTFindNodeMessage;
55 class DHTFindNodeReplyMessage;
56 class DHTGetPeersMessage;
57 class DHTGetPeersReplyMessage;
58 class DHTAnnouncePeerMessage;
59 class DHTAnnouncePeerReplyMessage;
60 class DHTUnknownMessage;
61 class DHTNode;
62 class Peer;
63 
64 class DHTMessageFactory {
65 public:
66   virtual ~DHTMessageFactory() = default;
67 
68   virtual std::unique_ptr<DHTQueryMessage>
69   createQueryMessage(const Dict* dict, const std::string& ipaddr,
70                      uint16_t port) = 0;
71 
72   virtual std::unique_ptr<DHTResponseMessage>
73   createResponseMessage(const std::string& messageType, const Dict* dict,
74                         const std::string& ipaddr, uint16_t port) = 0;
75 
76   virtual std::unique_ptr<DHTPingMessage>
77   createPingMessage(const std::shared_ptr<DHTNode>& remoteNode,
78                     const std::string& transactionID = A2STR::NIL) = 0;
79 
80   virtual std::unique_ptr<DHTPingReplyMessage>
81   createPingReplyMessage(const std::shared_ptr<DHTNode>& remoteNode,
82                          const unsigned char* id,
83                          const std::string& transactionID) = 0;
84 
85   virtual std::unique_ptr<DHTFindNodeMessage>
86   createFindNodeMessage(const std::shared_ptr<DHTNode>& remoteNode,
87                         const unsigned char* targetNodeID,
88                         const std::string& transactionID = A2STR::NIL) = 0;
89 
90   virtual std::unique_ptr<DHTFindNodeReplyMessage> createFindNodeReplyMessage(
91       const std::shared_ptr<DHTNode>& remoteNode,
92       std::vector<std::shared_ptr<DHTNode>> closestKNodes,
93       const std::string& transactionID) = 0;
94 
95   virtual std::unique_ptr<DHTGetPeersMessage>
96   createGetPeersMessage(const std::shared_ptr<DHTNode>& remoteNode,
97                         const unsigned char* infoHash,
98                         const std::string& transactionID = A2STR::NIL) = 0;
99 
100   virtual std::unique_ptr<DHTGetPeersReplyMessage> createGetPeersReplyMessage(
101       const std::shared_ptr<DHTNode>& remoteNode,
102       std::vector<std::shared_ptr<DHTNode>> closestKNodes,
103       std::vector<std::shared_ptr<Peer>> peers, const std::string& token,
104       const std::string& transactionID) = 0;
105 
106   virtual std::unique_ptr<DHTAnnouncePeerMessage>
107   createAnnouncePeerMessage(const std::shared_ptr<DHTNode>& remoteNode,
108                             const unsigned char* infoHash, uint16_t tcpPort,
109                             const std::string& token,
110                             const std::string& transactionID = A2STR::NIL) = 0;
111 
112   virtual std::unique_ptr<DHTAnnouncePeerReplyMessage>
113   createAnnouncePeerReplyMessage(const std::shared_ptr<DHTNode>& remoteNode,
114                                  const std::string& transactionID) = 0;
115 
116   virtual std::unique_ptr<DHTUnknownMessage>
117   createUnknownMessage(const unsigned char* data, size_t length,
118                        const std::string& ipaddr, uint16_t port) = 0;
119 };
120 
121 } // namespace aria2
122 
123 #endif // D_DHT_MESSAGE_FACTORY_H
124