]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/treeserver.h
Merge pull request #495 from SaberUK/master+fix-libcpp
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / treeserver.h
index 1d053112db127ba8c30efda0e625d82f089c391c..460231502a76c532a7da5ff9567ed848882a9ab2 100644 (file)
@@ -1,5 +1,27 @@
-#ifndef __TREESERVER_H__
-#define __TREESERVER_H__
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   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 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/>.
+ */
+
+
+#pragma once
+
+#include "treesocket.h"
 
 /** Each server in the tree is represented by one class of
  * type TreeServer. A locally connected TreeServer can
  */
 class TreeServer : public classbase
 {
-       InspIRCd* ServerInstance;               /* Creator */
        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 */
-       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 */
        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
+        */
+       void SetID(const std::string &id);
 
  public:
+       FakeUser* const ServerUser;             /* User representing this server */
+       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(SpanningTreeUtilities* Util, std::string Name, std::string Desc, const std::string &id);
+
        /** 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(SpanningTreeUtilities* Util, std::string Name, std::string Desc, const std::string &id, TreeServer* Above, TreeSocket* Sock, bool Hide);
 
        int QuitUsers(const std::string &reason);
 
@@ -76,11 +105,11 @@ class TreeServer : public classbase
 
        /** 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
         */
@@ -90,37 +119,29 @@ class TreeServer : public classbase
         */
        time_t NextPingTime();
 
-       /** Time of last ping used to calculate this->rtt below
+       /** Last ping time in milliseconds, used to calculate round trip time
         */
-       time_t LastPing;
+       unsigned long LastPingMsec;
 
        /** Round trip time of last ping
         */
-       time_t rtt;
+       unsigned long rtt;
 
-       /** True if the server answered their last ping
+       /** When we recieved BURST from this server, used to calculate total burst time at ENDBURST.
         */
-       bool AnsweredLastPing();
+       unsigned long StartBurst;
 
-       /** Set the server as responding to its last ping
+       /** True if this server is hidden
         */
-       void SetPingFlag();
+       bool Hidden;
 
-       /** Get the number of users on this server for MAP
-        */
-       int GetUserCount();
-
-       /** Increment the user counter
-        */
-       void AddUserCount();
-
-       /** Decrement the user counter
+       /** True if the server answered their last ping
         */
-       void DelUserCount();
+       bool AnsweredLastPing();
 
-       /** Get the oper count for this server
+       /** Set the server as responding to its last ping
         */
-       int GetOperCount();
+       void SetPingFlag();
 
        /** Get the TreeSocket pointer for local servers.
         * For remote servers, this returns NULL.
@@ -158,10 +179,18 @@ class TreeServer : public classbase
         */
        bool 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();
+
+       CullResult cull();
        /** Destructor
         */
        ~TreeServer();
-
 };
-
-#endif