1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
17 #ifndef __CULLLIST_H__
18 #define __CULLLIST_H__
20 // include the common header files
31 /** The CullItem class holds a user and their quitmessage,
32 * and is used internally by the CullList class to compile
33 * a list of users which are to be culled when a long
34 * operation (such as a netsplit) has completed.
39 /** Holds a pointer to the user,
40 * must be valid and can be a local or remote user.
43 /** Holds the quit reason to use for this user.
48 * Initializes the CullItem with a user pointer
49 * and their quit reason
50 * @param u The user to add
51 * @param r The quit reason of the added user
53 CullItem(userrec* u, std::string &r);
54 CullItem(userrec* u, const char* r);
55 /** Returns a pointer to the user
58 /** Returns the user's quit reason
60 std::string GetReason();
63 /** The CullList class can be used by modules, and is used
64 * by the core, to compile large lists of users in preperation
65 * to quitting them all at once. This is faster than quitting
66 * them within the loop, as the loops become tighter with
67 * little or no comparisons within them. The CullList class
68 * operates by allowing the programmer to push users onto
69 * the list, each with a seperate quit reason, and then, once
70 * the list is complete, call a method to flush the list,
71 * quitting all the users upon it. A CullList may hold local
72 * or remote users, but it may only hold each user once. If
73 * you attempt to add the same user twice, then the second
74 * attempt will be ignored.
79 /** Holds a list of users being quit.
80 * See the information for CullItem for
83 std::vector<CullItem> list;
84 /** A list of users who have already been
85 * placed on the list, as a map for fast
86 * reference. When deleting an item, the
87 * time_t value stored here must match
88 * the one of the actual userrec, otherwise
89 * we don't delete it (its a different user)
91 std::map<userrec*,time_t> exempt;
93 /** Check if a user pointer is valid
94 * (e.g. it exists in the user hash)
96 bool IsValid(userrec* user);
99 * Clears the CullList::list and CullList::exempt
103 /** Adds a user to the cull list for later
105 * @param user The user to add
106 * @param reason The quit reason of the user being added
108 void AddItem(userrec* user, std::string &reason);
109 void AddItem(userrec* user, const char* reason);
110 /** Applies the cull list, quitting all the users
111 * on the list with their quit reasons all at once.
112 * This is a very fast operation compared to
113 * iterating the user list and comparing each one,
114 * especially if there are multiple comparisons
115 * to be done, or recursion.
116 * @returns The number of users removed from IRC.