src/main/trackermanager.h

   1 /***************************************************************************
   2  *                                                                         *
   3  *   Copyright (C) 2006 David Brodsky                                      *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or         *
   6  *   modify it under the terms of the GNU General Public License as        *
   7  *   published by the Free Software Foundation and appearing               *
   8  *   in the file LICENSE.GPL included in the packaging of this file.       *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
  13  *   General Public License for more details.                              *
  14  *                                                                         *
  15  ***************************************************************************/
  16
  17 #ifndef _main_trackermanager_h
  18 #define _main_trackermanager_h
  19
  20 #include <map>
  21
  22 #include <tairon/core/string.h>
  23
  24 using Tairon::Core::String;
  25
  26 namespace Tairent
  27 {
  28
  29 namespace Main
  30 {
  31
  32 class TorrentClient;
  33 class TrackerClient;
  34 class TrackerClientFactory;
  35
  36 /** \brief TrackerManager keeps informations about trackers for various
  37  * protocols.
  38  */
  39 class TrackerManager
  40 {
  41         public:
  42                 /** Construct a TrackerManager object. This class is a singleton.
  43                  */
  44                 TrackerManager();
  45
  46                 /** Destroys the object.
  47                  */
  48                 ~TrackerManager();
  49
  50                 /** Returns new tracker client for a torrent.
  51                  */
  52                 TrackerClient *getTracker(TorrentClient *c);
  53
  54                 /** Registers new protocol for trackers and factory that creates
  55                  * clients for that protocol.
  56                  */
  57                 void registerFactory(const String &protocol, TrackerClientFactory *factory);
  58
  59                 /** Returns pointer to the only one instance of this class.
  60                  */
  61                 static TrackerManager *self() {
  62                         return trackerManager;
  63                 };
  64
  65                 /** Unregisters a factory for specific protocol.
  66                  */
  67                 void unregisterFactory(const String &protocol);
  68
  69         private:
  70                 /** Creates a default tracker client. It is used when there is no
  71                  * tracker factory registered for torrent's tracker.
  72                  */
  73                 TrackerClient *createDefaultTracker(TorrentClient *client);
  74
  75         private:
  76                 /** Mapping from protocol name to a factory that creates tracker
  77                  * clients for such protocol.
  78                  */
  79                 std::map<String, TrackerClientFactory *> protocols;
  80
  81                 /** Pointer to the only one instance of this class.
  82                  */
  83                 static TrackerManager *trackerManager;
  84 };
  85
  86 }; // namespace Main
  87
  88 }; // namespace Tairent
  89
  90 #endif
  91
  92 // vim: ai sw=4 ts=4 noet fdm=marker