-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * This file is part of InspIRCd. InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
*
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef __TREESERVER_H__
-#define __TREESERVER_H__
+
+#pragma once
+
+#include "treesocket.h"
+#include "pingtimer.h"
/** Each server in the tree is represented by one class of
* type TreeServer. A locally connected TreeServer can
* TreeServer items, deleting and inserting them as they
* are created and destroyed.
*/
-class TreeServer : public classbase
+class TreeServer : public Server
{
TreeServer* Parent; /* Parent entry */
TreeServer* Route; /* Route entry */
std::vector<TreeServer*> Children; /* List of child objects */
- irc::string ServerName; /* Server's name */
- std::string ServerDesc; /* Server's description */
std::string VersionString; /* Version string or empty string */
- unsigned int ServerUserCount; /* How many users are on this server? [note: doesn't care about +i] */
- unsigned int ServerOperCount; /* How many opers are on this server? */
- TreeSocket* Socket; /* For directly connected servers this points at the socket object */
- time_t NextPing; /* After this time, the server should be PINGed*/
- bool LastPingWasGood; /* True if the server responded to the last PING with a PONG */
- SpanningTreeUtilities* Utils; /* Utility class */
+
+ /** Full version string including patch version and other info
+ */
+ std::string fullversion;
+ std::string rawversion;
+
+ TreeSocket* Socket; /* Socket used to communicate with this server */
std::string sid; /* Server ID */
- /** Set server ID
- * @param id Server ID
- * @throws CoreException on duplicate ID
+ /** Counter counting how many servers are bursting in front of this server, including
+ * this server. Set to parents' value on construction then it is increased if the
+ * server itself starts bursting. Decreased when a server on the path to this server
+ * finishes burst.
*/
- void SetID(const std::string &id);
+ unsigned int behind_bursting;
+
+ /** True if this server has been lost in a split and is awaiting destruction
+ */
+ bool isdead;
+
+ /** Timer handling PINGing the server and killing it on timeout
+ */
+ PingTimer pingtimer;
+
+ /** This method is used to add this TreeServer to the
+ * hash maps. It is only called by the constructors.
+ */
+ void AddHashEntry();
+
+ /** Used by SQuit logic to recursively remove servers
+ */
+ void SQuitInternal(unsigned int& num_lost_servers);
+
+ /** Remove the reference to this server from the hash maps
+ */
+ void RemoveHash();
public:
+ typedef std::vector<TreeServer*> ChildServers;
FakeUser* const ServerUser; /* User representing this server */
- time_t age;
+ const time_t age;
- bool Warned; /* True if we've warned opers about high latency on this server */
- bool bursting; /* whether or not this server is bursting */
+ unsigned int UserCount; /* How many users are on this server? [note: doesn't care about +i] */
+ unsigned int OperCount; /* How many opers are on this server? */
/** We use this constructor only to create the 'root' item, Utils->TreeRoot, which
* represents our own server. Therefore, it has no route, no parent, and
* no socket associated with it. Its version string is our own local version.
*/
- TreeServer(SpanningTreeUtilities* Util, std::string Name, std::string Desc, const std::string &id);
+ TreeServer();
/** When we create a new server, we call this constructor to initialize it.
* This constructor initializes the server's Route and Parent, and sets up
* its ping counters so that it will be pinged one minute from now.
*/
- TreeServer(SpanningTreeUtilities* Util, std::string Name, std::string Desc, const std::string &id, TreeServer* Above, TreeSocket* Sock, bool Hide);
-
- int QuitUsers(const std::string &reason);
+ TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide);
- /** This method is used to add the structure to the
- * hash_map for linear searches. It is only called
- * by the constructors.
+ /** SQuit a server connected to this server, removing the given server and all servers behind it
+ * @param server Server to squit, must be directly below this server
+ * @param reason Reason for quitting the server, sent to opers and other servers
*/
- void AddHashEntry();
+ void SQuitChild(TreeServer* server, const std::string& reason);
- /** This method removes the reference to this object
- * from the hash_map which is used for linear searches.
- * It is only called by the default destructor.
+ /** SQuit this server, removing this server and all servers behind it
+ * @param reason Reason for quitting the server, sent to opers and other servers
*/
- void DelHashEntry();
+ void SQuit(const std::string& reason)
+ {
+ GetParent()->SQuitChild(this, reason);
+ }
+
+ static unsigned int QuitUsers(const std::string& reason);
/** Get route.
* The 'route' is defined as the locally-
* connected server which can be used to reach this server.
*/
- TreeServer* GetRoute();
+ TreeServer* GetRoute() const { return Route; }
- /** Get server name
+ /** Returns true if this server is the tree root (i.e.: us)
*/
- std::string GetName();
+ bool IsRoot() const { return (this->Parent == NULL); }
- /** Get server description (GECOS)
+ /** Returns true if this server is locally connected
*/
- std::string GetDesc();
+ bool IsLocal() const { return (this->Route == this); }
- /** Get server version string
+ /** Returns true if the server is awaiting destruction
+ * @return True if the server is waiting to be culled and deleted, false otherwise
*/
- std::string GetVersion();
+ bool IsDead() const { return isdead; }
- /** Set time we are next due to ping this server
+ /** Get server version string
*/
- void SetNextPingTime(time_t t);
+ const std::string& GetVersion() const { return VersionString; }
- /** Get the time we are next due to ping this server
+ /** Get the full version string of this server
+ * @return The full version string of this server, including patch version and other info
*/
- time_t NextPingTime();
+ const std::string& GetFullVersion() const { return fullversion; }
- /** Last ping time in microseconds, used to calculate round trip time
+ /** Get the raw version string of this server
*/
- unsigned long LastPingMsec;
+ const std::string& GetRawVersion() const { return rawversion; }
/** Round trip time of last ping
*/
unsigned long rtt;
- /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST.
+ /** When we received BURST from this server, used to calculate total burst time at ENDBURST.
*/
- unsigned long StartBurst;
+ uint64_t StartBurst;
/** True if this server is hidden
*/
bool Hidden;
- /** True if the server answered their last ping
+ /** Get the TreeSocket pointer for local servers.
+ * For remote servers, this returns NULL.
*/
- bool AnsweredLastPing();
+ TreeSocket* GetSocket() const { return Socket; }
- /** Set the server as responding to its last ping
+ /** Get the parent server.
+ * For the root node, this returns NULL.
*/
- void SetPingFlag();
+ TreeServer* GetParent() const { return Parent; }
- /** Get the number of users on this server.
+ /** Set the server version string
*/
- unsigned int GetUserCount();
+ void SetVersion(const std::string& verstr) { VersionString = verstr; }
- /** Increment or decrement the user count by diff.
+ /** Set the full version string
+ * @param verstr The version string to set
*/
- void SetUserCount(int diff);
+ void SetFullVersion(const std::string& verstr) { fullversion = verstr; }
- /** Gets the numbers of opers on this server.
+ /** Set the raw version string
*/
- unsigned int GetOperCount();
+ void SetRawVersion(const std::string& verstr) { rawversion = verstr; }
- /** Increment or decrement the oper count by diff.
+ /** Sets the description of this server. Called when the description of a remote server changes
+ * and we are notified about it.
+ * @param descstr The description to set
*/
- void SetOperCount(int diff);
+ void SetDesc(const std::string& descstr) { description = descstr; }
- /** Get the TreeSocket pointer for local servers.
- * For remote servers, this returns NULL.
+ /** Return all child servers
*/
- TreeSocket* GetSocket();
+ const ChildServers& GetChildren() const { return Children; }
- /** Get the parent server.
- * For the root node, this returns NULL.
+ /** Get server ID
*/
- TreeServer* GetParent();
+ const std::string& GetID() const { return sid; }
- /** Set the server version string
+ /** Marks a server as having finished bursting and performs appropriate actions.
*/
- void SetVersion(const std::string &Version);
+ void FinishBurst();
+ /** Recursive call for child servers */
+ void FinishBurstInternal();
- /** Return number of child servers
+ /** (Re)check the uline state of this server
*/
- unsigned int ChildCount();
+ void CheckULine();
- /** Return a child server indexed 0..n
+ /** Get the bursting state of this server
+ * @return True if this server is bursting, false if it isn't
*/
- TreeServer* GetChild(unsigned int n);
+ bool IsBursting() const { return (StartBurst != 0); }
- /** Add a child server
+ /** Check whether this server is behind a bursting server or is itself bursting.
+ * This can tell whether a user is on a part of the network that is still bursting.
+ * @return True if this server is bursting or is behind a server that is bursting, false if it isn't
*/
- void AddChild(TreeServer* Child);
+ bool IsBehindBursting() const { return (behind_bursting != 0); }
- /** Delete a child server, return false if it didn't exist.
+ /** Set the bursting state of the server
+ * @param startms Time the server started bursting, if 0 or omitted, use current time
*/
- bool DelChild(TreeServer* Child);
+ void BeginBurst(uint64_t startms = 0);
- /** Removes child nodes of this node, and of that node, etc etc.
- * This is used during netsplits to automatically tidy up the
- * server tree. It is slow, we don't use it for much else.
+ /** Register a PONG from the server
*/
- bool Tidy();
+ void OnPong() { pingtimer.OnPong(); }
- /** Get server ID
- */
- std::string& GetID();
+ CullResult cull() CXX11_OVERRIDE;
- /** Marks a server as having finished bursting and performs appropriate actions.
+ /** Destructor, deletes ServerUser unless IsRoot()
*/
- void FinishBurst();
- /** Recursive call for child servers */
- void FinishBurstInternal();
+ ~TreeServer();
- CullResult cull();
- /** Destructor
+ /** Returns the TreeServer the given user is connected to
+ * @param user The user whose server to return
+ * @return The TreeServer this user is connected to.
*/
- ~TreeServer();
+ static TreeServer* Get(User* user)
+ {
+ return static_cast<TreeServer*>(user->server);
+ }
};
-
-#endif