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 irc::string ServerName; /* Server's name */
46 std::string ServerDesc; /* Server's description */
47 std::string VersionString; /* Version string or empty string */
48 unsigned int ServerUserCount; /* How many users are on this server? [note: doesn't care about +i] */
49 unsigned int ServerOperCount; /* How many opers are on this server? */
50 TreeSocket* Socket; /* For directly connected servers this points at the socket object */
51 time_t NextPing; /* After this time, the server should be PINGed*/
52 bool LastPingWasGood; /* True if the server responded to the last PING with a PONG */
53 SpanningTreeUtilities* Utils; /* Utility class */
54 std::string sid; /* Server ID */
58 * @throws CoreException on duplicate ID
60 void SetID(const std::string &id);
63 FakeUser* const ServerUser; /* User representing this server */
66 bool Warned; /* True if we've warned opers about high latency on this server */
67 bool bursting; /* whether or not this server is bursting */
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.
73 TreeServer(SpanningTreeUtilities* Util, std::string Name, std::string Desc, const std::string &id);
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(SpanningTreeUtilities* Util, std::string Name, std::string Desc, const std::string &id, TreeServer* Above, TreeSocket* Sock, bool Hide);
81 int QuitUsers(const std::string &reason);
83 /** This method is used to add the structure to the
84 * hash_map for linear searches. It is only called
85 * by the constructors.
89 /** This method removes the reference to this object
90 * from the hash_map which is used for linear searches.
91 * It is only called by the default destructor.
96 * The 'route' is defined as the locally-
97 * connected server which can be used to reach this server.
99 TreeServer* GetRoute();
103 std::string GetName();
105 /** Get server description (GECOS)
107 const std::string& GetDesc();
109 /** Get server version string
111 const std::string& GetVersion();
113 /** Set time we are next due to ping this server
115 void SetNextPingTime(time_t t);
117 /** Get the time we are next due to ping this server
119 time_t NextPingTime();
121 /** Last ping time in milliseconds, used to calculate round trip time
123 unsigned long LastPingMsec;
125 /** Round trip time of last ping
129 /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST.
131 unsigned long StartBurst;
133 /** True if this server is hidden
137 /** True if the server answered their last ping
139 bool AnsweredLastPing();
141 /** Set the server as responding to its last ping
145 /** Get the number of users on this server.
147 unsigned int GetUserCount();
149 /** Increment or decrement the user count by diff.
151 void SetUserCount(int diff);
153 /** Gets the numbers of opers on this server.
155 unsigned int GetOperCount();
157 /** Increment or decrement the oper count by diff.
159 void SetOperCount(int diff);
161 /** Get the TreeSocket pointer for local servers.
162 * For remote servers, this returns NULL.
164 TreeSocket* GetSocket();
166 /** Get the parent server.
167 * For the root node, this returns NULL.
169 TreeServer* GetParent();
171 /** Set the server version string
173 void SetVersion(const std::string &Version);
175 /** Return number of child servers
177 unsigned int ChildCount();
179 /** Return a child server indexed 0..n
181 TreeServer* GetChild(unsigned int n);
183 /** Add a child server
185 void AddChild(TreeServer* Child);
187 /** Delete a child server, return false if it didn't exist.
189 bool DelChild(TreeServer* Child);
191 /** Removes child nodes of this node, and of that node, etc etc.
192 * This is used during netsplits to automatically tidy up the
193 * server tree. It is slow, we don't use it for much else.
199 const std::string& GetID();
201 /** Marks a server as having finished bursting and performs appropriate actions.
204 /** Recursive call for child servers */
205 void FinishBurstInternal();