src/kademlia/routing/RoutingBin.h

   1 //                                                              -*- C++ -*-
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2004-2008 Angel Vidal ( kry@amule.org )
   5 // Copyright (c) 2004-2008 aMule Team ( admin@amule.org / http://www.amule.org )
   6 // Copyright (c) 2003 Barry Dunne (http://www.emule-project.net)
   7 //
   8 // Any parts of this program derived from the xMule, lMule or eMule project,
   9 // or contributed by third-party developers are copyrighted by their
  10 // respective authors.
  11 //
  12 // This program is free software; you can redistribute it and/or modify
  13 // it under the terms of the GNU General Public License as published by
  14 // the Free Software Foundation; either version 2 of the License, or
  15 // (at your option) any later version.
  16 //
  17 // This program is distributed in the hope that it will be useful,
  18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 // GNU General Public License for more details.
  21 //
  22 // You should have received a copy of the GNU General Public License
  23 // along with this program; if not, write to the Free Software
  24 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  25 //
  26
  27 // Note To Mods //
  28 /*
  29 Please do not change anything here and release it..
  30 There is going to be a new forum created just for the Kademlia side of the client..
  31 If you feel there is an error or a way to improve something, please
  32 post it in the forum first and let us look at it.. If it is a real improvement,
  33 it will be added to the offical client.. Changing something without knowing
  34 what all it does can cause great harm to the network if released in mass form..
  35 Any mod that changes anything within the Kademlia side will not be allowed to advertise
  36 there client on the eMule forum..
  37 */
  38
  39 #ifndef __ROUTING_BIN__
  40 #define __ROUTING_BIN__
  41
  42 #include "Maps.h"
  43 #include "../../Types.h"
  44 #include "../kademlia/Defines.h"
  45 #include "Contact.h"
  46
  47 ////////////////////////////////////////
  48 namespace Kademlia {
  49 ////////////////////////////////////////
  50
  51 class CUInt128;
  52
  53 class CRoutingBin
  54 {
  55 public:
  56         CRoutingBin()
  57                 : m_dontDeleteContacts(false)
  58         {}
  59         ~CRoutingBin();
  60
  61         bool      AddContact(CContact *contact);
  62         void      SetAlive(CContact *contact);
  63         void      SetTCPPort(uint32_t ip, uint16_t port, uint16_t tcpPort);
  64         void      RemoveContact(CContact *contact, bool noTrackingAdjust = false)       { if (!noTrackingAdjust) AdjustGlobalTracking(contact->GetIPAddress(), false); m_entries.remove(contact); }
  65         CContact *GetContact(const CUInt128 &id) const throw();
  66         CContact *GetContact(uint32_t ip, uint16_t port, bool tcpPort) const throw();
  67         CContact *GetOldest() const throw()             { return m_entries.size() ? m_entries.front() : NULL; }
  68
  69         uint32_t  GetSize() const throw()               { return m_entries.size(); }
  70         uint32_t  GetRemaining() const throw()          { return K - m_entries.size(); }
  71         void      GetEntries(ContactList *result, bool emptyFirst = true) const;
  72         void      GetClosestTo(uint32_t maxType, const CUInt128 &target, uint32_t maxRequired, ContactMap *result, bool emptyFirst = true, bool setInUse = false) const;
  73         bool      ChangeContactIPAddress(CContact *contact, uint32_t newIP);
  74         void      PushToBottom(CContact *contact); // puts an existing contact from X to the end of the list
  75         CContact *GetRandomContact(uint32_t maxType, uint32_t minKadVersion) const throw();
  76
  77         bool m_dontDeleteContacts;
  78
  79 protected:
  80         static void AdjustGlobalTracking(uint32_t ip, bool increase);
  81
  82 private:
  83         ContactList m_entries;
  84
  85         typedef std::map<uint32_t, uint32_t>    GlobalTrackingMap;
  86
  87         static GlobalTrackingMap        s_globalContactIPs;
  88         static GlobalTrackingMap        s_globalContactSubnets;
  89 };
  90
  91 } // End namespace
  92
  93 #endif // __ROUTING_BIN__
  94 // File_checked_for_headers