]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/utils.h
This needs some general QA-ing. Add support to new parser (introduced in 1.1) for...
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / utils.h
index 0ce6047cff2281563a6cf37eb84f3db8c2343b8d..0194d461cc21e2074b9a4df80b01619789ec38bf 100644 (file)
@@ -31,100 +31,111 @@ typedef std::map<irc::string, Module*> hookmodules;
 class SpanningTreeUtilities
 {
  private:
-        /** Creator server
-         */
-        InspIRCd* ServerInstance;
+       /** Creator server
+        */
+       InspIRCd* ServerInstance;
  public:
-        /** Creator module
-         */
-        ModuleSpanningTree* Creator;
-        /** Flatten links and /MAP for non-opers
-         */
-        bool FlatLinks;
-        /** Hide U-Lined servers in /MAP and /LINKS
-         */
-        bool HideULines;
-        /** Announce TS changes to channels on merge
-         */
-        bool AnnounceTSChange;
-        /** Synchronize timestamps between servers
-         */
-        bool EnableTimeSync;
-        /** Socket bindings for listening sockets
-         */
-        std::vector<TreeSocket*> Bindings;
-        /** This variable represents the root of the server tree
-         */
-        TreeServer *TreeRoot;
-        /** IPs allowed to link to us
-         */
-        std::vector<std::string> ValidIPs;
-        /** Hash of currently connected servers by name
-         */
-        server_hash serverlist;
-        /** Holds the data from the <link> tags in the conf
-         */
-        std::vector<Link> LinkBlocks;
-        /** Holds a bitmask of queued xline types waiting to be applied.
-         * Will be a mask containing values APPLY_GLINES, APPLY_KLINES,
-         * APPLY_QLINES and APPLY_ZLINES.
-         */
-        int lines_to_apply;
+       /** Creator module
+        */
+       ModuleSpanningTree* Creator;
+       /** Flatten links and /MAP for non-opers
+        */
+       bool FlatLinks;
+       /** Hide U-Lined servers in /MAP and /LINKS
+        */
+       bool HideULines;
+       /** Announce TS changes to channels on merge
+        */
+       bool AnnounceTSChange;
+       /** Synchronize timestamps between servers
+        */
+       bool EnableTimeSync;
+       /** Socket bindings for listening sockets
+        */
+       std::vector<TreeSocket*> Bindings;
+       /** This variable represents the root of the server tree
+        */
+       TreeServer *TreeRoot;
+       /** IPs allowed to link to us
+        */
+       std::vector<std::string> ValidIPs;
+       /** Hash of currently connected servers by name
+        */
+       server_hash serverlist;
+       /** Holds the data from the <link> tags in the conf
+        */
+       std::vector<Link> LinkBlocks;
+       /** Holds a bitmask of queued xline types waiting to be applied.
+        * Will be a mask containing values APPLY_GLINES, APPLY_KLINES,
+        * APPLY_QLINES and APPLY_ZLINES.
+        */
+       int lines_to_apply;
 
-        hookmodules hooks;
-        std::vector<std::string> hooknames;
+       /** If this is true, this server is the master sync server for time
+        * synching - e.g. it is the server with its clock correct. It will
+        * send out the correct time at intervals.
+        */
+       bool MasterTime;
 
-        /** Initialise utility class
-         */
-        SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);
-        /** Destroy class and free listeners etc
-         */
-        ~SpanningTreeUtilities();
-        /** Send a message from this server to one other local or remote
-         */
-        bool DoOneToOne(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string target);
-        /** Send a message from this server to all but one other, local or remote
-         */
-        bool DoOneToAllButSender(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string omit);
-        /** Send a message from this server to all but one other, local or remote
-         */
-        bool DoOneToAllButSender(const char* prefix, const char* command, std::deque<std::string> &params, std::string omit);
-        /** Send a message from this server to all others
-         */
-        bool DoOneToMany(const std::string &prefix, const std::string &command, std::deque<std::string> &params);
-        /** Send a message from this server to all others
-         */
-        bool DoOneToMany(const char* prefix, const char* command, std::deque<std::string> &params);
-        /** Send a message from this server to all others, without doing any processing on the command (e.g. send it as-is with colons and all)
-         */
-        bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, std::deque<std::string> &params);
-        /** Read the spanningtree module's tags from the config file
-         */
-        void ReadConfiguration(bool rebind);
-        /** Add a server to the server list for GetListOfServersForChannel
-         */
-        void AddThisServer(TreeServer* server, TreeServerList &list);
-        /** Compile a list of servers which contain members of channel c
-         */
-        void GetListOfServersForChannel(chanrec* c, TreeServerList &list, char status, const CUList &exempt_list);
-        /** Find a server by name
-         */
-        TreeServer* FindServer(const std::string &ServerName);
-        /** Find a route to a server by name
-         */
-        TreeServer* BestRouteTo(const std::string &ServerName);
-        /** Find a server by glob mask
-         */
-        TreeServer* FindServerMask(const std::string &ServerName);
-        /** Returns true if this is a server name we recognise
-         */
-        bool IsServer(const std::string &ServerName);
-        /** Attempt to connect to the failover link of link x
-         */
-        void DoFailOver(Link* x);
-        /** Find a link tag from a server name
-         */
-        Link* FindLink(const std::string& name);
+       /** List of module pointers which can provide I/O abstraction
+        */
+       hookmodules hooks;
+
+       /** List of module names which can provide I/O abstraction
+        */
+       std::vector<std::string> hooknames;
+
+       /** Initialise utility class
+        */
+       SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);
+       /** Destroy class and free listeners etc
+        */
+       ~SpanningTreeUtilities();
+       /** Send a message from this server to one other local or remote
+        */
+       bool DoOneToOne(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string target);
+       /** Send a message from this server to all but one other, local or remote
+        */
+       bool DoOneToAllButSender(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string omit);
+       /** Send a message from this server to all but one other, local or remote
+        */
+       bool DoOneToAllButSender(const char* prefix, const char* command, std::deque<std::string> &params, std::string omit);
+       /** Send a message from this server to all others
+        */
+       bool DoOneToMany(const std::string &prefix, const std::string &command, std::deque<std::string> &params);
+       /** Send a message from this server to all others
+        */
+       bool DoOneToMany(const char* prefix, const char* command, std::deque<std::string> &params);
+       /** Send a message from this server to all others, without doing any processing on the command (e.g. send it as-is with colons and all)
+        */
+       bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, std::deque<std::string> &params);
+       /** Read the spanningtree module's tags from the config file
+        */
+       void ReadConfiguration(bool rebind);
+       /** Add a server to the server list for GetListOfServersForChannel
+        */
+       void AddThisServer(TreeServer* server, TreeServerList &list);
+       /** Compile a list of servers which contain members of channel c
+        */
+       void GetListOfServersForChannel(chanrec* c, TreeServerList &list, char status, const CUList &exempt_list);
+       /** Find a server by name
+        */
+       TreeServer* FindServer(const std::string &ServerName);
+       /** Find a route to a server by name
+        */
+       TreeServer* BestRouteTo(const std::string &ServerName);
+       /** Find a server by glob mask
+        */
+       TreeServer* FindServerMask(const std::string &ServerName);
+       /** Returns true if this is a server name we recognise
+        */
+       bool IsServer(const std::string &ServerName);
+       /** Attempt to connect to the failover link of link x
+        */
+       void DoFailOver(Link* x);
+       /** Find a link tag from a server name
+        */
+       Link* FindLink(const std::string& name);
 };
 
 #endif