]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/inspircd.h
Pass an interface to the OnSync hooks
[user/henk/code/inspircd.git] / include / inspircd.h
index aa6be2deeb3c3cd25f60137603999828ed89fc90..f43141c383152294499f8f9c24c6b15908094bf1 100644 (file)
@@ -49,6 +49,7 @@
 CoreExport extern InspIRCd* ServerInstance;
 
 #include "config.h"
+#include "dynref.h"
 #include "consolecolors.h"
 #include "caller.h"
 #include "cull_list.h"
@@ -244,7 +245,6 @@ DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
-DEFINE_HANDLER1(RehashHandler, void, const std::string&);
 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
 
 /** The main class of the irc server.
@@ -265,11 +265,6 @@ class CoreExport InspIRCd
         */
        bool DaemonSeed();
 
-       /** Iterate the list of BufferedSocket objects, removing ones which have timed out
-        * @param TIME the current time
-        */
-       void DoSocketTimeouts(time_t TIME);
-
        /** The current time, updated in the mainloop
         */
        struct timespec TIME;
@@ -279,6 +274,11 @@ class CoreExport InspIRCd
         */
        char ReadBuffer[65535];
 
+       /** Check we aren't running as root, and exit if we are
+        * with exit code EXIT_STATUS_ROOT.
+        */
+       void CheckRoot();
+
  public:
 
        UIDGenerator UIDGen;
@@ -295,7 +295,6 @@ class CoreExport InspIRCd
        IsIdentHandler HandleIsIdent;
        OnCheckExemptionHandler HandleOnCheckExemption;
        IsChannelHandler HandleIsChannel;
-       RehashHandler HandleRehash;
        GenRandomHandler HandleGenRandom;
 
        /** Globally accessible fake user record. This is used to force mode changes etc across s2s, etc.. bit ugly, but.. better than how this was done in 1.1
@@ -401,7 +400,7 @@ class CoreExport InspIRCd
 
        /** Holds extensible for user operquit
         */
-       LocalStringExt OperQuit;
+       StringExtItem OperQuit;
 
        /** Manages the generation and transmission of ISUPPORT. */
        ISupportManager ISupport;
@@ -471,11 +470,6 @@ class CoreExport InspIRCd
         */
        Channel* FindChan(const std::string &chan);
 
-       /** Check we aren't running as root, and exit if we are
-        * @return Depending on the configuration, this function may never return
-        */
-       void CheckRoot();
-
        /** Return true if a channel name is valid
         * @param chname A channel name to verify
         * @return True if the name is valid
@@ -483,14 +477,10 @@ class CoreExport InspIRCd
        caller1<bool, const std::string&> IsChannel;
 
        /** Return true if str looks like a server ID
-        * @param string to check against
+        * @param sid string to check against
         */
        static bool IsSID(const std::string& sid);
 
-       /** Rehash the local server
-        */
-       caller1<void, const std::string&> Rehash;
-
        /** Handles incoming signals after being set
         * @param signal the signal recieved
         */
@@ -512,17 +502,16 @@ class CoreExport InspIRCd
        /** Causes the server to exit immediately with exit code 0.
         * The status code is required for signal handlers, and ignored.
         */
+       static void QuickExit(int status);
 
-       /** Printf-wrapper.
-       * @param How you want it formatted
-       * @param ...
+       /** Formats the input string with the specified arguments.
+       * @param formatString The string to format
+       * @param ... A variable number of format arguments.
        * @return The formatted string
        */
        static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
        static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
 
-       static void QuickExit(int status);
-
        /** Return a count of channels on the network
         * @return The number of channels
         */
@@ -545,23 +534,14 @@ class CoreExport InspIRCd
         */
        caller1<bool, const std::string&> IsIdent;
 
-       /** Add a command to this server's command parser
-        * @param f A Command command handler object to add
-        * @throw ModuleException Will throw ModuleExcption if the command already exists
-        */
-       inline void AddCommand(Command *f)
-       {
-               Modules->AddService(*f);
-       }
-
        /** Match two strings using pattern matching, optionally, with a map
         * to check case against (may be NULL). If map is null, match will be case insensitive.
         * @param str The literal string to match against
         * @param mask The glob pattern to match against.
         * @param map The character map to use when matching.
         */
-       static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
-       static bool Match(const char *str, const char *mask, unsigned const char *map = NULL);
+       static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
+       static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
 
        /** Match two strings using pattern matching, optionally, with a map
         * to check case against (may be NULL). If map is null, match will be case insensitive.
@@ -570,8 +550,8 @@ class CoreExport InspIRCd
         * @param mask The glob or CIDR pattern to match against.
         * @param map The character map to use when matching.
         */
-       static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
-       static bool MatchCIDR(const char *str, const char *mask, unsigned const char *map = NULL);
+       static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
+       static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
 
        /** Matches a hostname and IP against a space delimited list of hostmasks.
         * @param masks The space delimited masks to match against.
@@ -597,8 +577,9 @@ class CoreExport InspIRCd
        static void ProcessColors(file_cache& input);
 
        /** Rehash the local server
+        * @param uuid The uuid of the user who started the rehash, can be empty
         */
-       void RehashServer();
+       void Rehash(const std::string& uuid = "");
 
        /** Check if the given nickmask matches too many users, send errors to the given user
         * @param nick A nickmask to match against
@@ -695,14 +676,6 @@ class CoreExport InspIRCd
         */
        caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
 
-       /** Restart the server.
-        * This function will not return. If an error occurs,
-        * it will throw an instance of CoreException.
-        * @param reason The restart reason to show to all clients
-        * @throw CoreException An instance of CoreException indicating the error from execv().
-        */
-       void Restart(const std::string &reason);
-
        /** Prepare the ircd for restart or shutdown.
         * This function unloads all modules which can be unloaded,
         * closes all open sockets, and closes the logfile.
@@ -716,9 +689,8 @@ class CoreExport InspIRCd
        /** Begin execution of the server.
         * NOTE: this function NEVER returns. Internally,
         * it will repeatedly loop.
-        * @return The return value for this function is undefined.
         */
-       int Run();
+       void Run();
 
        char* GetReadBuffer()
        {
@@ -737,11 +709,6 @@ class CommandModule : public Module
        {
        }
 
-       void init()
-       {
-               ServerInstance->Modules->AddService(cmd);
-       }
-
        Version GetVersion()
        {
                return Version(cmd.name, VF_VENDOR|VF_CORE);