Add OnGarbageCollect method

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@6086 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 9 insertions, 2 deletions

diff --git a/include/modules.h b/include/modules.h
index 337064eb3..3c9899ded 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -75,7 +75,7 @@ enum MessageType {
  * ipv4 servers, so this value will be ten times as
  * high on ipv6 servers.
  */
-#define NATIVE_API_VERSION 11008
+#define NATIVE_API_VERSION 11009
 #ifdef IPV6
 #define API_VERSION (NATIVE_API_VERSION * 10)
 #else
@@ -394,7 +394,7 @@ enum Implementation {	I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUse
 			I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
 			I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
 			I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
-			I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect };
+			I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect };
 
 /** Base class for all InspIRCd modules
  *  This class is the base class for InspIRCd modules. All modules must inherit from this class,
@@ -1341,6 +1341,13 @@ class Module : public Extensible
 	 * receive it, or zero to allow the line to be sent.
 	 */
 	virtual int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text);
+
+	/** Called at intervals for modules to garbage-collect any hashes etc.
+	 * Certain data types such as hash_map 'leak' buckets, which must be
+	 * tidied up and freed by copying into a new item every so often. This
+	 * method is called when it is time to do that.
+	 */
+	virtual void OnGarbageCollect();
 };