src/modules/m_spanningtree/treeserver.h

   1 /*       +------------------------------------+\r *       | Inspire Internet Relay Chat Daemon |\r *       +------------------------------------+\r *\r *  InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r *            the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef __TREESERVER_H__\r#define __TREESERVER_H__\r\r/** Each server in the tree is represented by one class of\r * type TreeServer. A locally connected TreeServer can\r * have a class of type TreeSocket associated with it, for\r * remote servers, the TreeSocket entry will be NULL.\r * Each server also maintains a pointer to its parent\r * (NULL if this server is ours, at the top of the tree)\r * and a pointer to its "Route" (see the comments in the\r * constructors below), and also a dynamic list of pointers\r * to its children which can be iterated recursively\r * if required. Creating or deleting objects of type\r i* TreeServer automatically maintains the hash_map of\r * TreeServer items, deleting and inserting them as they\r * are created and destroyed.\r */\rclass TreeServer : public classbase\r{\r        InspIRCd* ServerInstance;               /* Creator */\r  TreeServer* Parent;                     /* Parent entry */\r     TreeServer* Route;                      /* Route entry */\r      std::vector<TreeServer*> Children;      /* List of child objects */\r    irc::string ServerName;                 /* Server's name */\r    std::string ServerDesc;                 /* Server's description */\r     std::string VersionString;              /* Version string or empty string */\r   int UserCount;                          /* Not used in this version */\r int OperCount;                          /* Not used in this version */\r TreeSocket* Socket;                     /* For directly connected servers this points at the socket object */\r  time_t NextPing;                        /* After this time, the server should be PINGed*/\r      bool LastPingWasGood;                   /* True if the server responded to the last PING with a PONG */\r        SpanningTreeUtilities* Utils;           /* Utility class */\r\r public:\r\r bool Warned;                            /* True if we've warned opers about high latency on this server */\r\r    /** We don't use this constructor. Its a dummy, and won't cause any insertion\r   * of the TreeServer into the hash_map. See below for the two we DO use.\r        */\r    TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance);\r\r  /** We use this constructor only to create the 'root' item, Utils->TreeRoot, which\r      * represents our own server. Therefore, it has no route, no parent, and\r        * no socket associated with it. Its version string is our own local version.\r   */\r    TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc);\r       \r       /** When we create a new server, we call this constructor to initialize it.\r     * This constructor initializes the server's Route and Parent, and sets up\r      * its ping counters so that it will be pinged one minute from now.\r     */\r    TreeServer(SpanningTreeUtilities* Util, InspIRCd* Instance, std::string Name, std::string Desc, TreeServer* Above, TreeSocket* Sock, bool Hide);\r\r      int QuitUsers(const std::string &reason);\r\r     /** This method is used to add the structure to the\r     * hash_map for linear searches. It is only called\r      * by the constructors.\r         */\r    void AddHashEntry();\r\r  /** This method removes the reference to this object\r    * from the hash_map which is used for linear searches.\r         * It is only called by the default destructor.\r         */\r    void DelHashEntry();\r\r  /** Get route.\r  * The 'route' is defined as the locally-\r       * connected server which can be used to reach this server.\r     */\r    TreeServer* GetRoute();\r\r       /** Get server name\r     */\r    std::string GetName();\r\r        /** Get server description (GECOS)\r      */\r    std::string GetDesc();\r\r        /** Get server version string\r   */\r    std::string GetVersion();\r\r     /** Set time we are next due to ping this server\r        */\r    void SetNextPingTime(time_t t);\r\r       /** Get the time we are next due to ping this server\r    */\r    time_t NextPingTime();\r\r        /** Time of last ping used to calculate this->rtt below\r         */\r    time_t LastPing;\r\r      /** Round trip time of last ping\r        */\r    time_t rtt;\r\r   /** True if this server is hidden\r       */\r    bool Hidden;\r\r  /** True if the server answered their last ping\r         */\r    bool AnsweredLastPing();\r\r      /** Set the server as responding to its last ping\r       */\r    void SetPingFlag();\r\r   /** Get the number of users on this server for MAP\r      */\r    int GetUserCount();\r\r   /** Increment the user counter\r  */\r    void AddUserCount();\r\r  /** Decrement the user counter\r  */\r    void DelUserCount();\r\r  /** Get the oper count for this server\r  */\r    int GetOperCount();\r\r   /** Get the TreeSocket pointer for local servers.\r       * For remote servers, this returns NULL.\r       */\r    TreeSocket* GetSocket();\r\r      /** Get the parent server.\r      * For the root node, this returns NULL.\r        */\r    TreeServer* GetParent();\r\r      /** Set the server version string\r       */\r    void SetVersion(const std::string &Version);\r\r  /** Return number of child servers\r      */\r    unsigned int ChildCount();\r\r    /** Return a child server indexed 0..n\r  */\r    TreeServer* GetChild(unsigned int n);\r\r /** Add a child server\r  */\r    void AddChild(TreeServer* Child);\r\r     /** Delete a child server, return false if it didn't exist.\r     */\r    bool DelChild(TreeServer* Child);\r\r     /** Removes child nodes of this node, and of that node, etc etc.\r        * This is used during netsplits to automatically tidy up the\r   * server tree. It is slow, we don't use it for much else.\r      */\r    bool Tidy();\r\r  /** Destructor\r  */\r    ~TreeServer();\r\r};\r\r#endif\r