2 * InspIRCd -- Internet Relay Chat Daemon
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>
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.
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
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/>.
24 #include "treesocket.h"
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.
40 class TreeServer : public classbase
42 TreeServer* Parent; /* Parent entry */
43 TreeServer* Route; /* Route entry */
44 std::vector<TreeServer*> Children; /* List of child objects */
45 std::string ServerName; /* Server's name */
46 std::string ServerDesc; /* Server's description */
47 std::string VersionString; /* Version string or empty string */
48 TreeSocket* Socket; /* Socket used to communicate with this server */
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 std::string sid; /* Server ID */
53 /** This method is used to add this TreeServer to the
54 * hash maps. It is only called by the constructors.
59 typedef std::vector<TreeServer*> ChildServers;
60 FakeUser* const ServerUser; /* User representing this server */
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 */
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? */
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.
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.
79 TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide);
81 int QuitUsers(const std::string &reason);
84 * The 'route' is defined as the locally-
85 * connected server which can be used to reach this server.
87 TreeServer* GetRoute();
89 /** Returns true if this server is the tree root (i.e.: us)
91 bool IsRoot() const { return (this->Parent == NULL); }
93 /** Returns true if this server is locally connected
95 bool IsLocal() const { return (this->Route == this); }
99 const std::string& GetName() const { return ServerName; }
101 /** Get server description (GECOS)
103 const std::string& GetDesc();
105 /** Get server version string
107 const std::string& GetVersion();
109 /** Set time we are next due to ping this server
111 void SetNextPingTime(time_t t);
113 /** Get the time we are next due to ping this server
115 time_t NextPingTime();
117 /** Last ping time in milliseconds, used to calculate round trip time
119 unsigned long LastPingMsec;
121 /** Round trip time of last ping
125 /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST.
127 unsigned long StartBurst;
129 /** True if this server is hidden
133 /** True if the server answered their last ping
135 bool AnsweredLastPing();
137 /** Set the server as responding to its last ping
141 /** Get the TreeSocket pointer for local servers.
142 * For remote servers, this returns NULL.
144 TreeSocket* GetSocket();
146 /** Get the parent server.
147 * For the root node, this returns NULL.
149 TreeServer* GetParent();
151 /** Set the server version string
153 void SetVersion(const std::string &Version);
155 /** Return all child servers
157 const ChildServers& GetChildren() const { return Children; }
159 /** Add a child server
161 void AddChild(TreeServer* Child);
163 /** Delete a child server, return false if it didn't exist.
165 bool DelChild(TreeServer* Child);
167 /** Removes child nodes of this node, and of that node, etc etc.
168 * This is used during netsplits to automatically tidy up the
169 * server tree. It is slow, we don't use it for much else.
175 const std::string& GetID();
177 /** Marks a server as having finished bursting and performs appropriate actions.
180 /** Recursive call for child servers */
181 void FinishBurstInternal();
186 * Removes the reference to this object from the