docs/module-doc/classCullItem.html

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