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         /** Set server ID
  55          * @param id Server ID
  56          * @throws CoreException on duplicate ID
  57          */
  58         void SetID(const std::string &id);
  59
  60  public:
  61         FakeUser* const ServerUser;             /* User representing this server */
  62         time_t age;
  63
  64         bool Warned;                            /* True if we've warned opers about high latency on this server */
  65         bool bursting;                          /* whether or not this server is bursting */
  66
  67         unsigned int UserCount;                 /* How many users are on this server? [note: doesn't care about +i] */
  68         unsigned int OperCount;                 /* How many opers are on this server? */
  69
  70         /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
  71          * represents our own server. Therefore, it has no route, no parent, and
  72          * no socket associated with it. Its version string is our own local version.
  73          */
  74         TreeServer(SpanningTreeUtilities* Util, std::string Name, std::string Desc, const std::string &id);
  75
  76         /** When we create a new server, we call this constructor to initialize it.
  77          * This constructor initializes the server's Route and Parent, and sets up
  78          * its ping counters so that it will be pinged one minute from now.
  79          */
  80         TreeServer(SpanningTreeUtilities* Util, std::string Name, std::string Desc, const std::string &id, TreeServer* Above, TreeSocket* Sock, bool Hide);
  81
  82         int QuitUsers(const std::string &reason);
  83
  84         /** This method is used to add the structure to the
  85          * hash_map for linear searches. It is only called
  86          * by the constructors.
  87          */
  88         void AddHashEntry();
  89
  90         /** This method removes the reference to this object
  91          * from the hash_map which is used for linear searches.
  92          * It is only called by the default destructor.
  93          */
  94         void DelHashEntry();
  95
  96         /** Get route.
  97          * The 'route' is defined as the locally-
  98          * connected server which can be used to reach this server.
  99          */
 100         TreeServer* GetRoute();
 101
 102         /** Get server name
 103          */
 104         std::string GetName();
 105
 106         /** Get server description (GECOS)
 107          */
 108         const std::string& GetDesc();
 109
 110         /** Get server version string
 111          */
 112         const std::string& GetVersion();
 113
 114         /** Set time we are next due to ping this server
 115          */
 116         void SetNextPingTime(time_t t);
 117
 118         /** Get the time we are next due to ping this server
 119          */
 120         time_t NextPingTime();
 121
 122         /** Last ping time in milliseconds, used to calculate round trip time
 123          */
 124         unsigned long LastPingMsec;
 125
 126         /** Round trip time of last ping
 127          */
 128         unsigned long rtt;
 129
 130         /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST.
 131          */
 132         unsigned long StartBurst;
 133
 134         /** True if this server is hidden
 135          */
 136         bool Hidden;
 137
 138         /** True if the server answered their last ping
 139          */
 140         bool AnsweredLastPing();
 141
 142         /** Set the server as responding to its last ping
 143          */
 144         void SetPingFlag();
 145
 146         /** Get the TreeSocket pointer for local servers.
 147          * For remote servers, this returns NULL.
 148          */
 149         TreeSocket* GetSocket();
 150
 151         /** Get the parent server.
 152          * For the root node, this returns NULL.
 153          */
 154         TreeServer* GetParent();
 155
 156         /** Set the server version string
 157          */
 158         void SetVersion(const std::string &Version);
 159
 160         /** Return number of child servers
 161          */
 162         unsigned int ChildCount();
 163
 164         /** Return a child server indexed 0..n
 165          */
 166         TreeServer* GetChild(unsigned int n);
 167
 168         /** Add a child server
 169          */
 170         void AddChild(TreeServer* Child);
 171
 172         /** Delete a child server, return false if it didn't exist.
 173          */
 174         bool DelChild(TreeServer* Child);
 175
 176         /** Removes child nodes of this node, and of that node, etc etc.
 177          * This is used during netsplits to automatically tidy up the
 178          * server tree. It is slow, we don't use it for much else.
 179          */
 180         bool Tidy();
 181
 182         /** Get server ID
 183          */
 184         const std::string& GetID();
 185
 186         /** Marks a server as having finished bursting and performs appropriate actions.
 187          */
 188         void FinishBurst();
 189         /** Recursive call for child servers */
 190         void FinishBurstInternal();
 191
 192         CullResult cull();
 193         /** Destructor
 194          */
 195         ~TreeServer();
 196 };