blob: 238f45a7a2c27c8f0360f348dfecd613d22b4d98 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>InspIRCd: CullItem Class Reference</title>
<link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4-20050815 -->
<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
<h1>CullItem Class Reference</h1><!-- doxytag: class="CullItem" -->The CullItem class holds a user and their quitmessage, and is used internally by the <a class="el" href="classCullList.html">CullList</a> class to compile a list of users which are to be culled when a long operation (such as a netsplit) has completed.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cull__list_8h-source.html">cull_list.h</a>></code>
<p>
Collaboration diagram for CullItem:<p><center><img src="classCullItem__coll__graph.gif" border="0" usemap="#CullItem__coll__map" alt="Collaboration graph"></center>
<map name="CullItem__coll__map">
<area href="classuserrec.html" shape="rect" coords="96,129,163,156" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classCullItem-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCullItem.html#CullItem_28userrec_20_2Au_2C_20std_3A_3Astring_20r_29">CullItem</a> (<a class="el" href="classuserrec.html">userrec</a> *u, <a class="el" href="namespaceirc.html#string">std::string</a> r)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constrcutor. <a href="#CullItem_28userrec_20_2Au_2C_20std_3A_3Astring_20r_29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCullItem.html#GetUser_28_29">GetUser</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the user. <a href="#GetUser_28_29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCullItem.html#GetReason_28_29">GetReason</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the user's quit reason. <a href="#GetReason_28_29"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCullItem.html#user">user</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a pointer to the user, must be valid and can be a local or remote user. <a href="#user"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCullItem.html#reason">reason</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds the quit reason to use for this user. <a href="#reason"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The CullItem class holds a user and their quitmessage, and is used internally by the <a class="el" href="classCullList.html">CullList</a> class to compile a list of users which are to be culled when a long operation (such as a netsplit) has completed.
<p>
<p>
Definition at line <a class="el" href="cull__list_8h-source.html#l00036">36</a> of file <a class="el" href="cull__list_8h-source.html">cull_list.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="CullItem_28userrec_20_2Au_2C_20std_3A_3Astring_20r_29"></a><!-- doxytag: member="CullItem::CullItem" ref="CullItem_28userrec_20_2Au_2C_20std_3A_3Astring_20r_29" args="(userrec *u, std::string r)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">CullItem::CullItem </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
<td class="mdname" nowrap> <em>u</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a> </td>
<td class="mdname" nowrap> <em>r</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Constrcutor.
<p>
Initializes the CullItem with a user pointer and their quit reason <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>u</em> </td><td>The user to add </td></tr>
<tr><td valign="top"></td><td valign="top"><em>r</em> </td><td>The quit reason of the added user</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="GetReason_28_29"></a><!-- doxytag: member="CullItem::GetReason" ref="GetReason_28_29" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> CullItem::GetReason </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the user's quit reason.
<p>
</td>
</tr>
</table>
<a class="anchor" name="GetUser_28_29"></a><!-- doxytag: member="CullItem::GetUser" ref="GetUser_28_29" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a>* CullItem::GetUser </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns a pointer to the user.
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="reason"></a><!-- doxytag: member="CullItem::reason" ref="reason" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> <a class="el" href="classCullItem.html#reason">CullItem::reason</a><code> [private]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Holds the quit reason to use for this user.
<p>
<p>
Definition at line <a class="el" href="cull__list_8h-source.html#l00045">45</a> of file <a class="el" href="cull__list_8h-source.html">cull_list.h</a>. </td>
</tr>
</table>
<a class="anchor" name="user"></a><!-- doxytag: member="CullItem::user" ref="user" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a>* <a class="el" href="classCullItem.html#user">CullItem::user</a><code> [private]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Holds a pointer to the user, must be valid and can be a local or remote user.
<p>
<p>
Definition at line <a class="el" href="cull__list_8h-source.html#l00042">42</a> of file <a class="el" href="cull__list_8h-source.html">cull_list.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="cull__list_8h-source.html">cull_list.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Dec 15 11:14:18 2005 for InspIRCd by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>
</html>
|
