docs/module-doc/classXLine.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 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.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   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">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>XLine Class Reference</h1>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 Inherits <a class="el" href="classclassbase.html">classbase</a>.
  14 <p>
  15 Inherited by <a class="el" href="classELine.html">ELine</a>, <a class="el" href="classGLine.html">GLine</a>, <a class="el" href="classKLine.html">KLine</a>, <a class="el" href="classQLine.html">QLine</a>, and <a class="el" href="classZLine.html">ZLine</a>.
  16 <p>
  17 <a href="classXLine-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 Attributes</h2></td></tr>
  20 <tr><td class="memItemLeft" nowrap align=right valign=top>time_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classXLine.html#o0">set_time</a></td></tr>
  21
  22 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The time the line was added. </em> <a href="#o0"></a><em><br><br></td></tr>
  23 <tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classXLine.html#o1">duration</a></td></tr>
  24
  25 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The duration of the ban, or 0 if permenant. </em> <a href="#o1"></a><em><br><br></td></tr>
  26 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classXLine.html#o2">source</a> [MAXBUF]</td></tr>
  27
  28 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Source of the ban. </em> <a href="#o2"></a><em><br><br></td></tr>
  29 <tr><td class="memItemLeft" nowrap align=right valign=top>char&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classXLine.html#o3">reason</a> [MAXBUF]</td></tr>
  30
  31 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reason for the ban. </em> <a href="#o3"></a><em><br><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#o4">n_matches</a></td></tr>
  33
  34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of times the core matches the ban, for statistics. </em> <a href="#o4"></a><em><br><br></td></tr>
  35 </table>
  36 <hr><a name="_details"></a><h2>Detailed Description</h2>
  37 XLine is the base class for ban lines such as G lines and K lines.
  38 <p>
  39
  40 <p>
  41 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>
  42 <a name="o1" doxytag="XLine::duration"></a><p>
  43 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  44   <tr>
  45     <td class="mdRow">
  46       <table cellpadding="0" cellspacing="0" border="0">
  47         <tr>
  48           <td class="md" nowrap valign="top"> long <a class="el" href="classXLine.html#o1">XLine::duration</a>
  49       </table>
  50     </td>
  51   </tr>
  52 </table>
  53 <table cellspacing=5 cellpadding=0 border=0>
  54   <tr>
  55     <td>
  56       &nbsp;
  57     </td>
  58     <td>
  59
  60 <p>
  61 The duration of the ban, or 0 if permenant.
  62 <p>
  63
  64 <p>
  65 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>
  66   </tr>
  67 </table>
  68 <a name="o4" doxytag="XLine::n_matches"></a><p>
  69 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  70   <tr>
  71     <td class="mdRow">
  72       <table cellpadding="0" cellspacing="0" border="0">
  73         <tr>
  74           <td class="md" nowrap valign="top"> long <a class="el" href="classXLine.html#o4">XLine::n_matches</a>
  75       </table>
  76     </td>
  77   </tr>
  78 </table>
  79 <table cellspacing=5 cellpadding=0 border=0>
  80   <tr>
  81     <td>
  82       &nbsp;
  83     </td>
  84     <td>
  85
  86 <p>
  87 Number of times the core matches the ban, for statistics.
  88 <p>
  89
  90 <p>
  91 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>
  92   </tr>
  93 </table>
  94 <a name="o3" doxytag="XLine::reason"></a><p>
  95 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  96   <tr>
  97     <td class="mdRow">
  98       <table cellpadding="0" cellspacing="0" border="0">
  99         <tr>
 100           <td class="md" nowrap valign="top"> char <a class="el" href="classXLine.html#o3">XLine::reason</a>[MAXBUF]
 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 Reason for the ban.
 114 <p>
 115
 116 <p>
 117 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>
 118   </tr>
 119 </table>
 120 <a name="o0" doxytag="XLine::set_time"></a><p>
 121 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 122   <tr>
 123     <td class="mdRow">
 124       <table cellpadding="0" cellspacing="0" border="0">
 125         <tr>
 126           <td class="md" nowrap valign="top"> time_t <a class="el" href="classXLine.html#o0">XLine::set_time</a>
 127       </table>
 128     </td>
 129   </tr>
 130 </table>
 131 <table cellspacing=5 cellpadding=0 border=0>
 132   <tr>
 133     <td>
 134       &nbsp;
 135     </td>
 136     <td>
 137
 138 <p>
 139 The time the line was added.
 140 <p>
 141
 142 <p>
 143 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>
 144   </tr>
 145 </table>
 146 <a name="o2" doxytag="XLine::source"></a><p>
 147 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 148   <tr>
 149     <td class="mdRow">
 150       <table cellpadding="0" cellspacing="0" border="0">
 151         <tr>
 152           <td class="md" nowrap valign="top"> char <a class="el" href="classXLine.html#o2">XLine::source</a>[MAXBUF]
 153       </table>
 154     </td>
 155   </tr>
 156 </table>
 157 <table cellspacing=5 cellpadding=0 border=0>
 158   <tr>
 159     <td>
 160       &nbsp;
 161     </td>
 162     <td>
 163
 164 <p>
 165 Source of the ban.
 166 <p>
 167 This can be a servername or an oper nickname
 168 <p>
 169 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>
 170   </tr>
 171 </table>
 172 <hr>The documentation for this class was generated from the following file:<ul>
 173 <li><a class="el" href="xline_8h-source.html">xline.h</a></ul>
 174 <hr size="1"><address style="align: right;"><small>Generated on Thu Apr 7 20:14:27 2005 for InspIRCd by
 175 <a href="http://www.doxygen.org/index.html">
 176 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 177 </a>1.3.3 </small></address>
 178 </body>
 179 </html>