Document SendMetaData.

[user/henk/code/inspircd.git] / include / cull_list.h

diff --git a/include/cull_list.h b/include/cull_list.h
index bea75c86dd29b2d08c330f2b9a4ec03c55a01be8..ff22880b4e499c9597529abb36cb679d84347b0e 100644 (file)
--- a/include/cull_list.h
+++ b/include/cull_list.h
@@ -2,7 +2,7 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
  * See: http://www.inspircd.org/wiki/index.php/Credits
  *
  * This program is free but copyrighted software; see
@@ -14,65 +14,8 @@
 #ifndef __CULLLIST_H__
 #define __CULLLIST_H__
 
-// include the common header files
-
-#include <string>
-#include <deque>
-#include <vector>
-#include "users.h"
-#include "channels.h"
-
-class InspIRCd;
-
-/** The CullItem class holds a user and their quitmessage,
- * and is used internally by the CullList class to compile
- * a list of users which are to be culled when a long
- * operation (such as a netsplit) has completed.
- */
-class CullItem : public classbase
-{
- private:
-       /** Holds a pointer to the user,
-       * must be valid and can be a local or remote user.
-       */
-       userrec* user;
-       /** Holds the quit reason to use for this user.
-       */
-       std::string reason;
-       /** Holds the quit reason opers see, if different from users
-        */
-       std::string oper_reason;
-       /** Silent items dont generate an snotice.
-        */
-       bool silent;
- public:
-       /** Constrcutor.
-       * Initializes the CullItem with a user pointer
-       * and their quit reason
-       * @param u The user to add
-       * @param r The quit reason of the added user
-       */
-       CullItem(userrec* u, std::string &r, const char* ro = "");
-       CullItem(userrec* u, const char* r, const char* ro = "");
-
-       void MakeSilent();
-       bool IsSilent();
-
-       ~CullItem();
-
-       /** Returns a pointer to the user
-       */
-       userrec* GetUser();
-       /** Returns the user's quit reason
-       */
-       std::string& GetReason();
-       /** Returns oper reason
-        */
-       std::string& GetOperReason();
-};
-
-/** The CullList class can be used by modules, and is used
- * by the core, to compile large lists of users in preperation
+/** The CullList class is used by the core to create lists of users
+ * prior to actually quitting (and deleting the objects) all at once.
  * to quitting them all at once. This is faster than quitting
  * them within the loop, as the loops become tighter with
  * little or no comparisons within them. The CullList class
@@ -83,53 +26,50 @@ class CullItem : public classbase
  * or remote users, but it may only hold each user once. If
  * you attempt to add the same user twice, then the second
  * attempt will be ignored.
+ *
+ * NOTE: Don't use this outside core, use the QuitUser method like everyone else!
  */
-class CullList : public classbase
+class CoreExport CullList : public classbase
 {
  private:
        /** Creator of this CullList
-       */
-       InspIRCd* ServerInstance;
-
-       /** Holds a list of users already added for quick lookup
         */
-       std::map<userrec*, userrec*> exempt;
+       InspIRCd* ServerInstance;
 
        /** Holds a list of users being quit.
-       * See the information for CullItem for
-       * more information.
-       */
-       std::vector<CullItem> list;
+        * See the information for CullItem for
+        * more information.
+        */
+       std::vector<User *> list;
 
  public:
        /** Constructor.
-       * Clears the CullList::list and CullList::exempt
-       * items.
-       * @param Instance Creator of this CullList object
-       */
+        * @param Instance Creator of this CullList object
+        */
        CullList(InspIRCd* Instance);
 
        /** Adds a user to the cull list for later
-       * removal via QUIT.
-       * @param user The user to add
-       * @param reason The quit reason of the user being added
-       */
-       void AddItem(userrec* user, std::string &reason, const  char* o_reason = "");
-       void AddItem(userrec* user, const char* reason, const char* o_reason = "");
+        * removal via QUIT.
+        * @param user The user to add
+        * @param reason The quit reason of the user being added
+        * @param o_reason The quit reason to show only to opers
+        */
+       void AddItem(User* user);
 
-       /* Turn an item into a silent item
+       /* Turn an item into a silent item (don't send out QUIT for this user)
         */
-       void MakeSilent(userrec* user);
+       void MakeSilent(User* user);
 
        /** Applies the cull list, quitting all the users
-       * on the list with their quit reasons all at once.
-       * This is a very fast operation compared to
-       * iterating the user list and comparing each one,
-       * especially if there are multiple comparisons
-       * to be done, or recursion.
-       * @returns The number of users removed from IRC.
-       */
+        * on the list with their quit reasons all at once.
+        * This is a very fast operation compared to
+        * iterating the user list and comparing each one,
+        * especially if there are multiple comparisons
+        * to be done, or recursion.
+        * @returns The number of users removed from IRC.
+        */
        int Apply();
 };
 
 #endif
+