src/modules/m_spanningtree/treeserver.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __TREESERVER_H__
  15 #define __TREESERVER_H__
  16
  17 /** Each server in the tree is represented by one class of
  18  * type TreeServer. A locally connected TreeServer can
  19  * have a class of type TreeSocket associated with it, for
  20  * remote servers, the TreeSocket entry will be NULL.
  21  * Each server also maintains a pointer to its parent
  22  * (NULL if this server is ours, at the top of the tree)
  23  * and a pointer to its "Route" (see the comments in the
  24  * constructors below), and also a dynamic list of pointers
  25  * to its children which can be iterated recursively
  26  * if required. Creating or deleting objects of type
  27  i* TreeServer automatically maintains the hash_map of
  28  * TreeServer items, deleting and inserting them as they
  29  * are created and destroyed.
  30  */
  31 class TreeServer : public classbase
  32 {
  33         InspIRCd* ServerInstance;               /* Creator */
  34         TreeServer* Parent;                     /* Parent entry */
  35         TreeServer* Route;                      /* Route entry */
  36         std::vector<TreeServer*> Children;      /* List of child objects */
  37         irc::string ServerName;                 /* Server's name */
  38         std::string ServerDesc;                 /* Server's description */
  39         std::string VersionString;              /* Version string or empty string */
  40         unsigned int ServerUserCount;           /* How many users are on this server? [note: doesn't care about +i] */
  41         unsigned int ServerOperCount;           /* How many opers are on this server? */
  42         TreeSocket* Socket;                     /* For directly connected servers this points at the socket object */
  43         time_t NextPing;                        /* After this time, the server should be PINGed*/
  44         bool LastPingWasGood;                   /* True if the server responded to the last PING with a PONG */
  45         SpanningTreeUtilities* Utils;           /* Utility class */
  46         std::string sid;                        /* Server ID */
  47
  48         /** Set server ID
  49          * @param id Server ID
  50          * @throws CoreException on duplicate ID
  51          */
  52         void SetID(const std::string &id);
  53
  54  public:
  55         time_t age;
  56
  57         bool Warned;                            /* True if we've warned opers about high latency on this server */
  58         bool bursting;                          /* whether or not this server is bursting */
  59
  60         /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
  61          * represents our own server. Therefore, it has no route, no parent, and
  62          * no socket associated with it. Its version string is our own local version.
  63          */
  64         TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, const std::string &id);
  65
  66         /** When we create a new server, we call this constructor to initialize it.
  67          * This constructor initializes the server's Route and Parent, and sets up
  68          * its ping counters so that it will be pinged one minute from now.
  69          */
  70         TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, const std::string &id, TreeServer* Above, TreeSocket* Sock, bool Hide);
  71
  72         int QuitUsers(const std::string &reason);
  73
  74         /** This method is used to add the structure to the
  75          * hash_map for linear searches. It is only called
  76          * by the constructors.
  77          */
  78         void AddHashEntry();
  79
  80         /** This method removes the reference to this object
  81          * from the hash_map which is used for linear searches.
  82          * It is only called by the default destructor.
  83          */
  84         void DelHashEntry();
  85
  86         /** Get route.
  87          * The 'route' is defined as the locally-
  88          * connected server which can be used to reach this server.
  89          */
  90         TreeServer* GetRoute();
  91
  92         /** Get server name
  93          */
  94         std::string GetName();
  95
  96         /** Get server description (GECOS)
  97          */
  98         std::string GetDesc();
  99
 100         /** Get server version string
 101          */
 102         std::string GetVersion();
 103
 104         /** Set time we are next due to ping this server
 105          */
 106         void SetNextPingTime(time_t t);
 107
 108         /** Get the time we are next due to ping this server
 109          */
 110         time_t NextPingTime();
 111
 112         /** Last ping time in microseconds, used to calculate round trip time
 113          */
 114         unsigned long LastPingMsec;
 115
 116         /** Round trip time of last ping
 117          */
 118         unsigned long rtt;
 119
 120         /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST.
 121          */
 122         unsigned long StartBurst;
 123
 124         /** True if this server is hidden
 125          */
 126         bool Hidden;
 127
 128         /** True if the server answered their last ping
 129          */
 130         bool AnsweredLastPing();
 131
 132         /** Set the server as responding to its last ping
 133          */
 134         void SetPingFlag();
 135
 136         /** Get the number of users on this server.
 137          */
 138         unsigned int GetUserCount();
 139
 140         /** Increment or decrement the user count by diff.
 141          */
 142         void SetUserCount(int diff);
 143
 144         /** Gets the numbers of opers on this server.
 145          */
 146         unsigned int GetOperCount();
 147
 148         /** Increment or decrement the oper count by diff.
 149          */
 150         void SetOperCount(int diff);
 151
 152         /** Get the TreeSocket pointer for local servers.
 153          * For remote servers, this returns NULL.
 154          */
 155         TreeSocket* GetSocket();
 156
 157         /** Get the parent server.
 158          * For the root node, this returns NULL.
 159          */
 160         TreeServer* GetParent();
 161
 162         /** Set the server version string
 163          */
 164         void SetVersion(const std::string &Version);
 165
 166         /** Return number of child servers
 167          */
 168         unsigned int ChildCount();
 169
 170         /** Return a child server indexed 0..n
 171          */
 172         TreeServer* GetChild(unsigned int n);
 173
 174         /** Add a child server
 175          */
 176         void AddChild(TreeServer* Child);
 177
 178         /** Delete a child server, return false if it didn't exist.
 179          */
 180         bool DelChild(TreeServer* Child);
 181
 182         /** Removes child nodes of this node, and of that node, etc etc.
 183          * This is used during netsplits to automatically tidy up the
 184          * server tree. It is slow, we don't use it for much else.
 185          */
 186         bool Tidy();
 187
 188         /** Get server ID
 189          */
 190         std::string& GetID();
 191
 192         /** Marks a server as having finished bursting and performs appropriate actions.
 193          */
 194         void FinishBurst();
 195         /** Recursive call for child servers */
 196         void FinishBurstInternal();
 197
 198         /** Destructor
 199          */
 200         ~TreeServer();
 201
 202 };
 203
 204 #endif