include/libtorrent/kademlia/msg.hpp

   1 /*
   2
   3 Copyright (c) 2007, Arvid Norberg
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions
   8 are met:
   9
  10     * Redistributions of source code must retain the above copyright
  11       notice, this list of conditions and the following disclaimer.
  12     * Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in
  14       the documentation and/or other materials provided with the distribution.
  15     * Neither the name of the author nor the names of its
  16       contributors may be used to endorse or promote products derived
  17       from this software without specific prior written permission.
  18
  19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  23 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  29 POSSIBILITY OF SUCH DAMAGE.
  30
  31 */
  32
  33 #ifndef MSG_HPP
  34 #define MSG_HPP
  35
  36 #include <string>
  37 #include <libtorrent/kademlia/node_id.hpp>
  38 #include "libtorrent/entry.hpp"
  39 #if BOOST_VERSION < 103500
  40 #include <asio/ip/udp.hpp>
  41 #else
  42 #include <boost/asio/ip/udp.hpp>
  43 #endif
  44
  45 namespace libtorrent {
  46 namespace dht {
  47
  48 typedef std::vector<char> packet_t;
  49
  50 namespace messages
  51 {
  52         enum { ping = 0, find_node = 1, get_peers = 2, announce_peer = 3, error = 4 };
  53         char const* const ids[] = { "ping", "find_node", "get_peers", "announce_peer", "error" };
  54 } // namespace messages
  55
  56 struct msg
  57 {
  58         msg() : reply(false), piggy_backed_ping(false)
  59                 , message_id(-1), port(0) {}
  60
  61         // true if this message is a reply
  62         bool reply;
  63         // true if this is a reply with a piggy backed ping
  64         bool piggy_backed_ping;
  65         // the kind if message
  66         int message_id;
  67         // if this is a reply, a copy of the transaction id
  68         // from the request. If it's a request, a transaction
  69         // id that should be sent back in the reply
  70         std::string transaction_id;
  71         // if this packet has a piggy backed ping, this
  72         // is the transaction id of that ping
  73         std::string ping_transaction_id;
  74         // the node id of the process sending the message
  75         node_id id;
  76         // the address of the process sending or receiving
  77         // the message.
  78         udp::endpoint addr;
  79         // if this is a nodes response, these are the nodes
  80         typedef std::vector<node_entry> nodes_t;
  81         nodes_t nodes;
  82
  83         typedef std::vector<tcp::endpoint> peers_t;
  84         peers_t peers;
  85
  86         // similar to transaction_id but for write operations.
  87         entry write_token;
  88
  89         // the info has for peer_requests, announce_peer
  90         // and responses
  91         node_id info_hash;
  92
  93         // port for announce_peer messages
  94         int port;
  95
  96         // ERROR MESSAGES
  97         int error_code;
  98         std::string error_msg;
  99 };
 100
 101
 102 } }
 103
 104 #endif