]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/treeserver.h
m_spanningtree Remove duplicate code for sending channel messages from RouteCommand()
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / treeserver.h
index 7eb19d9a171600d65db9334bde7d7f56dfda583c..9f2e24172ad2d440bdc6ecf188b74e37bd2de252 100644 (file)
@@ -1,18 +1,25 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 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"
 
@@ -35,73 +42,68 @@ class TreeServer : public classbase
        TreeServer* Parent;                     /* Parent entry */
        TreeServer* Route;                      /* Route entry */
        std::vector<TreeServer*> 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 */
 
-       /** 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 */
-       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);
+       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
         */
@@ -135,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.
         */
@@ -185,11 +171,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.
         */
@@ -198,9 +184,10 @@ class TreeServer : public classbase
        void FinishBurstInternal();
 
        CullResult cull();
+
        /** Destructor
+        * Removes the reference to this object from the
+        * hash maps.
         */
        ~TreeServer();
 };
-
-#endif