Move user quit logic out of cull list

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

diff --git a/include/cull_list.h b/include/cull_list.h
index 2a0b895f2c8e0964d30a1a9d56ae6c0620f43c44..8c38276429c15490be501f93093754528848acf1 100644 (file)
--- a/include/cull_list.h
+++ b/include/cull_list.h
@@ -14,58 +14,24 @@
 #ifndef __CULLLIST_H__
 #define __CULLLIST_H__
 
-/** 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
- * operates by allowing the programmer to push users onto
- * the list, each with a seperate quit reason, and then, once
- * the list is complete, call a method to flush the list,
- * quitting all the users upon it. A CullList may hold local
- * 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!
+/**
+ * The CullList class is used to delete objects at the end of the main loop to
+ * avoid problems with references to deleted pointers if an object were deleted
+ * during execution.
  */
 class CoreExport CullList : public classbase
 {
  private:
-       /** Creator of this CullList
-        */
-       InspIRCd* ServerInstance;
-
-       /** Holds a list of users being quit.
-        * See the information for CullItem for
-        * more information.
-        */
-       std::vector<User *> list;
+       std::vector<classbase*> list;
 
  public:
-       /** Constructor.
-        * @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
-        * @param o_reason The quit reason to show only to opers
-        */
-       void AddItem(User* user);
+       CullList() {}
 
-       /* Turn an item into a silent item (don't send out QUIT for this user)
+       /** Adds an item to the cull list
         */
-       void MakeSilent(User* user);
+       void AddItem(classbase* item) { list.push_back(item); }
 
-       /** 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.
+       /** Applies the cull list (deletes the contents)
         */
        void Apply();
 };