X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_spanningtree%2Ftreeserver.h;h=ab47012b0870d7cbce55e865041ba014fc58d732;hb=c8f92d97c2cd92a07bbb76b96a67cd089c7e3407;hp=716369f5be822364c86131a0dc918dbe937b1f0c;hpb=743f76d23f16609779ff94e70910a22be287966b;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_spanningtree/treeserver.h b/src/modules/m_spanningtree/treeserver.h index 716369f5b..ab47012b0 100644 --- a/src/modules/m_spanningtree/treeserver.h +++ b/src/modules/m_spanningtree/treeserver.h @@ -1,5 +1,27 @@ -#ifndef __TREESERVER_H__ -#define __TREESERVER_H__ +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2008 Robin Burchell + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2007 Craig Edwards + * + * 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 . + */ + + +#pragma once + +#include "treesocket.h" /** Each server in the tree is represented by one class of * type TreeServer. A locally connected TreeServer can @@ -15,86 +37,157 @@ * 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 */ - int UserCount; /* Not used in this version */ - int OperCount; /* Not used in this version */ - 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 */ + + /** This method is used to add this TreeServer to the + * hash maps. It is only called by the constructors. + */ + void AddHashEntry(); public: + typedef std::vector ChildServers; + FakeUser* const ServerUser; /* User representing this server */ + const time_t age; - /** 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); + 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, InspIRCd* Instance, std::string Name, std::string Desc); - + 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, TreeServer* Above, TreeSocket* Sock); + 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. + /** Get route. + * The 'route' is defined as the locally- + * connected server which can be used to reach this server. */ - void AddHashEntry(); + TreeServer* GetRoute(); - /** 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. + /** Returns true if this server is the tree root (i.e.: us) */ - void DelHashEntry(); + bool IsRoot() const { return (this->Parent == NULL); } - /** These accessors etc should be pretty self- - * explanitory. + /** Returns true if this server is locally connected + */ + bool IsLocal() const { return (this->Route == this); } + + /** Get server version string + */ + const std::string& GetVersion(); + + /** Set time we are next due to ping this server */ - TreeServer* GetRoute(); - std::string GetName(); - std::string GetDesc(); - std::string GetVersion(); void SetNextPingTime(time_t t); + + /** Get the time we are next due to ping this server + */ time_t NextPingTime(); + + /** Last ping time in milliseconds, used to calculate round trip time + */ + unsigned long LastPingMsec; + + /** Round trip time of last ping + */ + unsigned long rtt; + + /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST. + */ + unsigned long StartBurst; + + /** True if this server is hidden + */ + bool Hidden; + + /** True if the server answered their last ping + */ bool AnsweredLastPing(); + + /** Set the server as responding to its last ping + */ void SetPingFlag(); - int GetUserCount(); - void AddUserCount(); - void DelUserCount(); - int GetOperCount(); + + /** Get the TreeSocket pointer for local servers. + * For remote servers, this returns NULL. + */ TreeSocket* GetSocket(); + + /** Get the parent server. + * For the root node, this returns NULL. + */ TreeServer* GetParent(); + + /** Set the server version string + */ void SetVersion(const std::string &Version); - unsigned int ChildCount(); - TreeServer* GetChild(unsigned int n); + + /** Return all child servers + */ + const ChildServers& GetChildren() const { return Children; } + + /** Add a child server + */ void AddChild(TreeServer* Child); + + /** Delete a child server, return false if it didn't exist. + */ bool DelChild(TreeServer* Child); /** 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. */ - bool Tidy(); + void Tidy(); + + /** Get server ID + */ + const std::string& GetID(); + + /** Marks a server as having finished bursting and performs appropriate actions. + */ + void FinishBurst(); + /** 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