m_spanningtree Remove duplicate code for sending channel messages from RouteCommand()

[user/henk/code/inspircd.git] / src / modules / m_spanningtree / treeserver.h

diff --git a/src/modules/m_spanningtree/treeserver.h b/src/modules/m_spanningtree/treeserver.h
index 460231502a76c532a7da5ff9567ed848882a9ab2..9f2e24172ad2d440bdc6ecf188b74e37bd2de252 100644 (file)
--- a/src/modules/m_spanningtree/treeserver.h
+++ b/src/modules/m_spanningtree/treeserver.h
@@ -42,24 +42,22 @@ 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 */
-       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 */
@@ -71,37 +69,33 @@ class TreeServer : public classbase
         * 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)
         */
@@ -177,7 +171,7 @@ 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
         */
@@ -190,7 +184,10 @@ class TreeServer : public classbase
        void FinishBurstInternal();
 
        CullResult cull();
+
        /** Destructor
+        * Removes the reference to this object from the
+        * hash maps.
         */
        ~TreeServer();
 };