X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_spanningtree%2Ftreeserver.h;h=9f2e24172ad2d440bdc6ecf188b74e37bd2de252;hb=67de413cad88194972d55a8ff88464370890c5a9;hp=fea17b7d2e97c6097b246d765359776689f286fd;hpb=f209cce90b394acd26e22eacef0bff61e8f5b4e1;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_spanningtree/treeserver.h b/src/modules/m_spanningtree/treeserver.h index fea17b7d2..9f2e24172 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 @@ -30,81 +39,71 @@ */ class TreeServer : public classbase { - 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 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 */ - bool DupError; /* True if the server ID is duplicated (!) */ - /** 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: + 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(); + /** Returns true if this server is the tree root (i.e.: us) + */ + bool IsRoot() const { return (this->Parent == NULL); } + + /** Returns true if this server is locally connected + */ + bool IsLocal() const { return (this->Route == this); } + /** Get server name */ - std::string GetName(); + const std::string& GetName() const { return ServerName; } /** Get server description (GECOS) */ - std::string GetDesc(); + const std::string& GetDesc(); /** Get server version string */ - std::string GetVersion(); + const std::string& GetVersion(); /** Set time we are next due to ping this server */ @@ -114,7 +113,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; @@ -138,22 +137,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. */ @@ -188,24 +171,23 @@ 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(); - - /** True on duplicate server ID (server not usable) - */ - bool DuplicateID(); + const std::string& GetID(); /** Marks a server as having finished bursting and performs appropriate actions. */ void FinishBurst(); + /** Recursive call for child servers */ + void FinishBurstInternal(); + + CullResult cull(); /** Destructor + * Removes the reference to this object from the + * hash maps. */ ~TreeServer(); - }; - -#endif