src/modules/m_spanningtree/treeserver.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   5  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   6  *   Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
   7  *
   8  * This file is part of InspIRCd.  InspIRCd is free software: you can
   9  * redistribute it and/or modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation, version 2.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21
  22 #pragma once
  23
  24 #include "treesocket.h"
  25
  26 /** Each server in the tree is represented by one class of
  27  * type TreeServer. A locally connected TreeServer can
  28  * have a class of type TreeSocket associated with it, for
  29  * remote servers, the TreeSocket entry will be NULL.
  30  * Each server also maintains a pointer to its parent
  31  * (NULL if this server is ours, at the top of the tree)
  32  * and a pointer to its "Route" (see the comments in the
  33  * constructors below), and also a dynamic list of pointers
  34  * to its children which can be iterated recursively
  35  * if required. Creating or deleting objects of type
  36  i* TreeServer automatically maintains the hash_map of
  37  * TreeServer items, deleting and inserting them as they
  38  * are created and destroyed.
  39  */
  40 class TreeServer : public classbase
  41 {
  42         TreeServer* Parent;                     /* Parent entry */
  43         TreeServer* Route;                      /* Route entry */
  44         std::vector<TreeServer*> Children;      /* List of child objects */
  45         irc::string ServerName;                 /* Server's name */
  46         std::string ServerDesc;                 /* Server's description */
  47         std::string VersionString;              /* Version string or empty string */
  48         TreeSocket* Socket;                     /* For directly connected servers this points at the socket object */
  49         time_t NextPing;                        /* After this time, the server should be PINGed*/
  50         bool LastPingWasGood;                   /* True if the server responded to the last PING with a PONG */
  51         SpanningTreeUtilities* Utils;           /* Utility class */
  52         std::string sid;                        /* Server ID */
  53
  54         /** This method is used to add this TreeServer to the
  55          * hash maps. It is only called by the constructors.
  56          */
  57         void AddHashEntry();
  58
  59  public:
  60         FakeUser* const ServerUser;             /* User representing this server */
  61         const time_t age;
  62
  63         bool Warned;                            /* True if we've warned opers about high latency on this server */
  64         bool bursting;                          /* whether or not this server is bursting */
  65
  66         unsigned int UserCount;                 /* How many users are on this server? [note: doesn't care about +i] */
  67         unsigned int OperCount;                 /* How many opers are on this server? */
  68
  69         /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
  70          * represents our own server. Therefore, it has no route, no parent, and
  71          * no socket associated with it. Its version string is our own local version.
  72          */
  73         TreeServer(SpanningTreeUtilities* Util);
  74
  75         /** When we create a new server, we call this constructor to initialize it.
  76          * This constructor initializes the server's Route and Parent, and sets up
  77          * its ping counters so that it will be pinged one minute from now.
  78          */
  79         TreeServer(SpanningTreeUtilities* Util, const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide);
  80
  81         int QuitUsers(const std::string &reason);
  82
  83         /** Get route.
  84          * The 'route' is defined as the locally-
  85          * connected server which can be used to reach this server.
  86          */
  87         TreeServer* GetRoute();
  88
  89         /** Get server name
  90          */
  91         std::string GetName();
  92
  93         /** Get server description (GECOS)
  94          */
  95         const std::string& GetDesc();
  96
  97         /** Get server version string
  98          */
  99         const std::string& GetVersion();
 100
 101         /** Set time we are next due to ping this server
 102          */
 103         void SetNextPingTime(time_t t);
 104
 105         /** Get the time we are next due to ping this server
 106          */
 107         time_t NextPingTime();
 108
 109         /** Last ping time in milliseconds, used to calculate round trip time
 110          */
 111         unsigned long LastPingMsec;
 112
 113         /** Round trip time of last ping
 114          */
 115         unsigned long rtt;
 116
 117         /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST.
 118          */
 119         unsigned long StartBurst;
 120
 121         /** True if this server is hidden
 122          */
 123         bool Hidden;
 124
 125         /** True if the server answered their last ping
 126          */
 127         bool AnsweredLastPing();
 128
 129         /** Set the server as responding to its last ping
 130          */
 131         void SetPingFlag();
 132
 133         /** Get the TreeSocket pointer for local servers.
 134          * For remote servers, this returns NULL.
 135          */
 136         TreeSocket* GetSocket();
 137
 138         /** Get the parent server.
 139          * For the root node, this returns NULL.
 140          */
 141         TreeServer* GetParent();
 142
 143         /** Set the server version string
 144          */
 145         void SetVersion(const std::string &Version);
 146
 147         /** Return number of child servers
 148          */
 149         unsigned int ChildCount();
 150
 151         /** Return a child server indexed 0..n
 152          */
 153         TreeServer* GetChild(unsigned int n);
 154
 155         /** Add a child server
 156          */
 157         void AddChild(TreeServer* Child);
 158
 159         /** Delete a child server, return false if it didn't exist.
 160          */
 161         bool DelChild(TreeServer* Child);
 162
 163         /** Removes child nodes of this node, and of that node, etc etc.
 164          * This is used during netsplits to automatically tidy up the
 165          * server tree. It is slow, we don't use it for much else.
 166          */
 167         bool Tidy();
 168
 169         /** Get server ID
 170          */
 171         const std::string& GetID();
 172
 173         /** Marks a server as having finished bursting and performs appropriate actions.
 174          */
 175         void FinishBurst();
 176         /** Recursive call for child servers */
 177         void FinishBurstInternal();
 178
 179         CullResult cull();
 180
 181         /** Destructor
 182          * Removes the reference to this object from the
 183          * hash maps.
 184          */
 185         ~TreeServer();
 186 };