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 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,157,63,184" alt="">
  16 <area href="classGLine.html" shape="rect" coords="87,157,146,184" alt="">
  17 <area href="classKLine.html" shape="rect" coords="170,157,226,184" alt="">
  18 <area href="classQLine.html" shape="rect" coords="250,157,309,184" alt="">
  19 <area href="classZLine.html" shape="rect" coords="333,157,389,184" alt="">
  20 <area href="classclassbase.html" shape="rect" coords="158,8,238,34" 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="108,98,188,125" 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#o0">set_time</a></td></tr>
  30
  31 <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>
  32 <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>
  33
  34 <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>
  35 <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> [256]</td></tr>
  36
  37 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Source of the ban. </em> <a href="#o2"></a><em><br><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#o3">reason</a> [MAXBUF]</td></tr>
  39
  40 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reason for the ban. </em> <a href="#o3"></a><em><br><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#o4">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. </em> <a href="#o4"></a><em><br><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 name="o1" doxytag="XLine::duration"></a><p>
  52 <table class="mdTable" width="100%" 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#o1">XLine::duration</a>
  58       </table>
  59     </td>
  60   </tr>
  61 </table>
  62 <table cellspacing=5 cellpadding=0 border=0>
  63   <tr>
  64     <td>
  65       &nbsp;
  66     </td>
  67     <td>
  68
  69 <p>
  70 The duration of the ban, or 0 if permenant.
  71 <p>
  72
  73 <p>
  74 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>
  75   </tr>
  76 </table>
  77 <a name="o4" doxytag="XLine::n_matches"></a><p>
  78 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  79   <tr>
  80     <td class="mdRow">
  81       <table cellpadding="0" cellspacing="0" border="0">
  82         <tr>
  83           <td class="md" nowrap valign="top"> long <a class="el" href="classXLine.html#o4">XLine::n_matches</a>
  84       </table>
  85     </td>
  86   </tr>
  87 </table>
  88 <table cellspacing=5 cellpadding=0 border=0>
  89   <tr>
  90     <td>
  91       &nbsp;
  92     </td>
  93     <td>
  94
  95 <p>
  96 Number of times the core matches the ban, for statistics.
  97 <p>
  98
  99 <p>
 100 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>
 101   </tr>
 102 </table>
 103 <a name="o3" doxytag="XLine::reason"></a><p>
 104 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 105   <tr>
 106     <td class="mdRow">
 107       <table cellpadding="0" cellspacing="0" border="0">
 108         <tr>
 109           <td class="md" nowrap valign="top"> char <a class="el" href="classXLine.html#o3">XLine::reason</a>[MAXBUF]
 110       </table>
 111     </td>
 112   </tr>
 113 </table>
 114 <table cellspacing=5 cellpadding=0 border=0>
 115   <tr>
 116     <td>
 117       &nbsp;
 118     </td>
 119     <td>
 120
 121 <p>
 122 Reason for the ban.
 123 <p>
 124
 125 <p>
 126 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>
 127   </tr>
 128 </table>
 129 <a name="o0" doxytag="XLine::set_time"></a><p>
 130 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 131   <tr>
 132     <td class="mdRow">
 133       <table cellpadding="0" cellspacing="0" border="0">
 134         <tr>
 135           <td class="md" nowrap valign="top"> time_t <a class="el" href="classXLine.html#o0">XLine::set_time</a>
 136       </table>
 137     </td>
 138   </tr>
 139 </table>
 140 <table cellspacing=5 cellpadding=0 border=0>
 141   <tr>
 142     <td>
 143       &nbsp;
 144     </td>
 145     <td>
 146
 147 <p>
 148 The time the line was added.
 149 <p>
 150
 151 <p>
 152 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>
 153   </tr>
 154 </table>
 155 <a name="o2" doxytag="XLine::source"></a><p>
 156 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 157   <tr>
 158     <td class="mdRow">
 159       <table cellpadding="0" cellspacing="0" border="0">
 160         <tr>
 161           <td class="md" nowrap valign="top"> char <a class="el" href="classXLine.html#o2">XLine::source</a>[256]
 162       </table>
 163     </td>
 164   </tr>
 165 </table>
 166 <table cellspacing=5 cellpadding=0 border=0>
 167   <tr>
 168     <td>
 169       &nbsp;
 170     </td>
 171     <td>
 172
 173 <p>
 174 Source of the ban.
 175 <p>
 176 This can be a servername or an oper nickname
 177 <p>
 178 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>
 179   </tr>
 180 </table>
 181 <hr>The documentation for this class was generated from the following file:<ul>
 182 <li><a class="el" href="xline_8h-source.html">xline.h</a></ul>
 183 <hr size="1"><address style="align: right;"><small>Generated on Fri May 13 02:00:19 2005 for InspIRCd by
 184 <a href="http://www.doxygen.org/index.html">
 185 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 186 </a>1.3.3 </small></address>
 187 </body>
 188 </html>