docs/module-doc/classXLine.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: XLine 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>XLine Class Reference</h1><!-- doxytag: class="XLine" --><!-- doxytag: inherits="classbase" -->XLine is the base class for ban lines such as G lines and K lines.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="xline_8h-source.html">xline.h</a>&gt;</code>
  12 <p>
  13 Inheritance diagram for XLine:<p><center><img src="classXLine__inherit__graph.gif" border="0" usemap="#XLine__inherit__map" alt="Inheritance graph"></center>
  14 <map name="XLine__inherit__map">
  15 <area href="classELine.html" shape="rect" coords="7,156,63,183" alt="">
  16 <area href="classGLine.html" shape="rect" coords="87,156,146,183" alt="">
  17 <area href="classKLine.html" shape="rect" coords="170,156,226,183" alt="">
  18 <area href="classQLine.html" shape="rect" coords="250,156,308,183" alt="">
  19 <area href="classZLine.html" shape="rect" coords="332,156,388,183" alt="">
  20 <area href="classclassbase.html" shape="rect" coords="158,7,238,33" alt="">
  21 </map>
  22 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XLine:<p><center><img src="classXLine__coll__graph.gif" border="0" usemap="#XLine__coll__map" alt="Collaboration graph"></center>
  23 <map name="XLine__coll__map">
  24 <area href="classclassbase.html" shape="rect" coords="107,97,187,124" alt="">
  25 </map>
  26 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classXLine-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  27 <tr><td></td></tr>
  28 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">time_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXLine.html#set_5Ftime">set_time</a></td></tr>
  30
  31 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The time the line was added.  <a href="#set_5Ftime"></a><br></td></tr>
  32 <tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXLine.html#duration">duration</a></td></tr>
  33
  34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The duration of the ban, or 0 if permenant.  <a href="#duration"></a><br></td></tr>
  35 <tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXLine.html#source_5B_32_35_36_5D">source</a> [256]</td></tr>
  36
  37 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Source of the ban.  <a href="#source_5B_32_35_36_5D"></a><br></td></tr>
  38 <tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXLine.html#reason_5BMAXBUF_5D">reason</a> [MAXBUF]</td></tr>
  39
  40 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reason for the ban.  <a href="#reason_5BMAXBUF_5D"></a><br></td></tr>
  41 <tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXLine.html#n_5Fmatches">n_matches</a></td></tr>
  42
  43 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of times the core matches the ban, for statistics.  <a href="#n_5Fmatches"></a><br></td></tr>
  44 </table>
  45 <hr><a name="_details"></a><h2>Detailed Description</h2>
  46 XLine is the base class for ban lines such as G lines and K lines.
  47 <p>
  48
  49 <p>
  50 Definition at line <a class="el" href="xline_8h-source.html#l00034">34</a> of file <a class="el" href="xline_8h-source.html">xline.h</a>.<hr><h2>Member Data Documentation</h2>
  51 <a class="anchor" name="duration"></a><!-- doxytag: member="XLine::duration" ref="duration" args="" --><p>
  52 <table class="mdTable" cellpadding="2" cellspacing="0">
  53   <tr>
  54     <td class="mdRow">
  55       <table cellpadding="0" cellspacing="0" border="0">
  56         <tr>
  57           <td class="md" nowrap valign="top">long <a class="el" href="classXLine.html#duration">XLine::duration</a>          </td>
  58         </tr>
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <table cellspacing="5" cellpadding="0" border="0">
  64   <tr>
  65     <td>
  66       &nbsp;
  67     </td>
  68     <td>
  69
  70 <p>
  71 The duration of the ban, or 0 if permenant.
  72 <p>
  73
  74 <p>
  75 Definition at line <a class="el" href="xline_8h-source.html#l00044">44</a> of file <a class="el" href="xline_8h-source.html">xline.h</a>.    </td>
  76   </tr>
  77 </table>
  78 <a class="anchor" name="n_5Fmatches"></a><!-- doxytag: member="XLine::n_matches" ref="n_5Fmatches" args="" --><p>
  79 <table class="mdTable" cellpadding="2" cellspacing="0">
  80   <tr>
  81     <td class="mdRow">
  82       <table cellpadding="0" cellspacing="0" border="0">
  83         <tr>
  84           <td class="md" nowrap valign="top">long <a class="el" href="classXLine.html#n_5Fmatches">XLine::n_matches</a>          </td>
  85         </tr>
  86       </table>
  87     </td>
  88   </tr>
  89 </table>
  90 <table cellspacing="5" cellpadding="0" border="0">
  91   <tr>
  92     <td>
  93       &nbsp;
  94     </td>
  95     <td>
  96
  97 <p>
  98 Number of times the core matches the ban, for statistics.
  99 <p>
 100
 101 <p>
 102 Definition at line <a class="el" href="xline_8h-source.html#l00056">56</a> of file <a class="el" href="xline_8h-source.html">xline.h</a>.    </td>
 103   </tr>
 104 </table>
 105 <a class="anchor" name="reason_5BMAXBUF_5D"></a><!-- doxytag: member="XLine::reason" ref="reason_5BMAXBUF_5D" args="[MAXBUF]" --><p>
 106 <table class="mdTable" cellpadding="2" cellspacing="0">
 107   <tr>
 108     <td class="mdRow">
 109       <table cellpadding="0" cellspacing="0" border="0">
 110         <tr>
 111           <td class="md" nowrap valign="top">char <a class="el" href="classXLine.html#reason_5BMAXBUF_5D">XLine::reason</a>[MAXBUF]          </td>
 112         </tr>
 113       </table>
 114     </td>
 115   </tr>
 116 </table>
 117 <table cellspacing="5" cellpadding="0" border="0">
 118   <tr>
 119     <td>
 120       &nbsp;
 121     </td>
 122     <td>
 123
 124 <p>
 125 Reason for the ban.
 126 <p>
 127
 128 <p>
 129 Definition at line <a class="el" href="xline_8h-source.html#l00052">52</a> of file <a class="el" href="xline_8h-source.html">xline.h</a>.    </td>
 130   </tr>
 131 </table>
 132 <a class="anchor" name="set_5Ftime"></a><!-- doxytag: member="XLine::set_time" ref="set_5Ftime" args="" --><p>
 133 <table class="mdTable" cellpadding="2" cellspacing="0">
 134   <tr>
 135     <td class="mdRow">
 136       <table cellpadding="0" cellspacing="0" border="0">
 137         <tr>
 138           <td class="md" nowrap valign="top">time_t <a class="el" href="classXLine.html#set_5Ftime">XLine::set_time</a>          </td>
 139         </tr>
 140       </table>
 141     </td>
 142   </tr>
 143 </table>
 144 <table cellspacing="5" cellpadding="0" border="0">
 145   <tr>
 146     <td>
 147       &nbsp;
 148     </td>
 149     <td>
 150
 151 <p>
 152 The time the line was added.
 153 <p>
 154
 155 <p>
 156 Definition at line <a class="el" href="xline_8h-source.html#l00040">40</a> of file <a class="el" href="xline_8h-source.html">xline.h</a>.    </td>
 157   </tr>
 158 </table>
 159 <a class="anchor" name="source_5B_32_35_36_5D"></a><!-- doxytag: member="XLine::source" ref="source_5B_32_35_36_5D" args="[256]" --><p>
 160 <table class="mdTable" cellpadding="2" cellspacing="0">
 161   <tr>
 162     <td class="mdRow">
 163       <table cellpadding="0" cellspacing="0" border="0">
 164         <tr>
 165           <td class="md" nowrap valign="top">char <a class="el" href="classXLine.html#source_5B_32_35_36_5D">XLine::source</a>[256]          </td>
 166         </tr>
 167       </table>
 168     </td>
 169   </tr>
 170 </table>
 171 <table cellspacing="5" cellpadding="0" border="0">
 172   <tr>
 173     <td>
 174       &nbsp;
 175     </td>
 176     <td>
 177
 178 <p>
 179 Source of the ban.
 180 <p>
 181 This can be a servername or an oper nickname
 182 <p>
 183 Definition at line <a class="el" href="xline_8h-source.html#l00048">48</a> of file <a class="el" href="xline_8h-source.html">xline.h</a>.    </td>
 184   </tr>
 185 </table>
 186 <hr>The documentation for this class was generated from the following file:<ul>
 187 <li><a class="el" href="xline_8h-source.html">xline.h</a></ul>
 188 <hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:26 2005 for InspIRCd by&nbsp;
 189 <a href="http://www.doxygen.org/index.html">
 190 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 191 </body>
 192 </html>