X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_spanningtree%2Ftreeserver.h;h=ab47012b0870d7cbce55e865041ba014fc58d732;hb=c8f92d97c2cd92a07bbb76b96a67cd089c7e3407;hp=95b7469f963840c06cef6cadd66f0148f3d71c8c;hpb=d1bfdcb61347264fbef6656de88ab6e30d9fc617;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_spanningtree/treeserver.h b/src/modules/m_spanningtree/treeserver.h index 95b7469f9..ab47012b0 100644 --- a/src/modules/m_spanningtree/treeserver.h +++ b/src/modules/m_spanningtree/treeserver.h @@ -1,18 +1,27 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://www.inspircd.org/wiki/index.php/Credits + * Copyright (C) 2008 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2007 Craig Edwards * - * 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 . */ -#ifndef __TREESERVER_H__ -#define __TREESERVER_H__ + +#pragma once + +#include "treesocket.h" /** Each server in the tree is represented by one class of * type TreeServer. A locally connected TreeServer can @@ -28,82 +37,64 @@ * TreeServer items, deleting and inserting them as they * are created and destroyed. */ -class TreeServer : public classbase +class TreeServer : public Server { - InspIRCd* ServerInstance; /* Creator */ TreeServer* Parent; /* Parent entry */ TreeServer* Route; /* Route entry */ std::vector 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 */ + TreeSocket* Socket; /* Socket used to communicate with this server */ 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 */ std::string sid; /* Server ID */ - /** Set server ID - * @param id Server ID - * @throws CoreException on duplicate ID + /** This method is used to add this TreeServer to the + * hash maps. It is only called by the constructors. */ - void SetID(const std::string &id); + void AddHashEntry(); public: + typedef std::vector ChildServers; + FakeUser* const ServerUser; /* User representing this server */ + 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 */ - /** We don't use this constructor. Its a dummy, and won't cause any insertion - * of the TreeServer into the hash_map. See below for the two we DO use. - */ - TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, const std::string &id); + 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, InspIRCd* Instance, 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, InspIRCd* Instance, std::string Name, std::string Desc, const std::string &id, TreeServer* Above, TreeSocket* Sock, bool Hide); + TreeServer(const std::string& Name, const std::string& Desc, const std::string& id, TreeServer* Above, TreeSocket* Sock, bool Hide); int QuitUsers(const std::string &reason); - /** This method is used to add the structure to the - * hash_map for linear searches. It is only called - * by the constructors. - */ - void AddHashEntry(); - - /** 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. - */ - void DelHashEntry(); - /** Get route. * The 'route' is defined as the locally- * connected server which can be used to reach this server. */ TreeServer* GetRoute(); - /** 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 */ - std::string GetVersion(); + const std::string& GetVersion(); /** Set time we are next due to ping this server */ @@ -113,7 +104,7 @@ class TreeServer : public classbase */ time_t NextPingTime(); - /** Last ping time in microseconds, used to calculate round trip time + /** Last ping time in milliseconds, used to calculate round trip time */ unsigned long LastPingMsec; @@ -137,22 +128,6 @@ class TreeServer : public classbase */ void SetPingFlag(); - /** Get the number of users on this server. - */ - unsigned int GetUserCount(); - - /** Increment or decrement the user count by diff. - */ - void SetUserCount(int diff); - - /** Gets the numbers of opers on this server. - */ - unsigned int GetOperCount(); - - /** Increment or decrement the oper count by diff. - */ - void SetOperCount(int diff); - /** Get the TreeSocket pointer for local servers. * For remote servers, this returns NULL. */ @@ -167,13 +142,9 @@ class TreeServer : public classbase */ void SetVersion(const std::string &Version); - /** Return number of child servers - */ - unsigned int ChildCount(); - - /** Return a child server indexed 0..n + /** Return all child servers */ - TreeServer* GetChild(unsigned int n); + const ChildServers& GetChildren() const { return Children; } /** Add a child server */ @@ -187,11 +158,11 @@ class TreeServer : public classbase * This is used during netsplits to automatically tidy up the * server tree. It is slow, we don't use it for much else. */ - bool Tidy(); + void Tidy(); /** Get server ID */ - std::string& GetID(); + const std::string& GetID(); /** Marks a server as having finished bursting and performs appropriate actions. */ @@ -199,10 +170,24 @@ class TreeServer : public classbase /** Recursive call for child servers */ void FinishBurstInternal(); + /** (Re)check the uline state of this server + */ + void CheckULine(); + + CullResult cull(); + /** Destructor + * Removes the reference to this object from the + * hash maps. */ ~TreeServer(); + /** 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. + */ + static TreeServer* Get(User* user) + { + return static_cast(user->server); + } }; - -#endif