docs/module-doc/socketengine_8h.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: socketengine.h File 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 <div class="nav">
   9 <a class="el" href="dir_000000.html">home</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000001.html">brain</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000002.html">inspircd-cvs</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000003.html">inspircd</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_000004.html">include</a></div>
  10 <h1>socketengine.h File Reference</h1><code>#include &lt;vector&gt;</code><br>
  11 <code>#include &lt;string&gt;</code><br>
  12 <code>#include &quot;inspircd_config.h&quot;</code><br>
  13 <code>#include &quot;<a class="el" href="globals_8h-source.html">globals.h</a>&quot;</code><br>
  14 <code>#include &quot;<a class="el" href="inspircd_8h-source.html">inspircd.h</a>&quot;</code><br>
  15 <code>#include &lt;sys/types.h&gt;</code><br>
  16 <code>#include &lt;sys/event.h&gt;</code><br>
  17 <code>#include &lt;sys/time.h&gt;</code><br>
  18
  19 <p>
  20 Include dependency graph for socketengine.h:<p><center><img src="socketengine_8h__incl.gif" border="0" usemap="#socketengine.h_map" alt=""></center>
  21 <map name="socketengine.h_map">
  22 <area href="globals_8h-source.html" shape="rect" coords="175,108,250,135" alt="">
  23 <area href="inspircd_8h-source.html" shape="rect" coords="172,159,252,186" alt="">
  24 </map>
  25
  26 <p>
  27 This graph shows which files directly or indirectly include this file:<p><center><img src="socketengine_8h__dep__incl.gif" border="0" usemap="#socketengine.hdep_map" alt=""></center>
  28 <map name="socketengine.hdep_map">
  29 <area href="modules_8cpp-source.html" shape="rect" coords="469,311,568,338" alt="">
  30 <area href="socket_8cpp-source.html" shape="rect" coords="476,412,561,439" alt="">
  31 <area href="socketengine_8cpp-source.html" shape="rect" coords="295,58,420,84" alt="">
  32 <area href="users_8cpp-source.html" shape="rect" coords="479,108,559,135" alt="">
  33 <area href="inspircd_8h-source.html" shape="rect" coords="167,260,247,287" alt="">
  34 <area href="channels_8cpp-source.html" shape="rect" coords="469,210,568,236" alt="">
  35 <area href="inspircd__io_8h-source.html" shape="rect" coords="309,260,405,287" alt="">
  36 <area href="typedefs_8h-source.html" shape="rect" coords="315,210,400,236" alt="">
  37 <area href="userprocess_8h-source.html" shape="rect" coords="305,311,409,338" alt="">
  38 </map>
  39
  40 <p>
  41 <a href="socketengine_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
  42 <tr><td></td></tr>
  43 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  44 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSocketEngine.html">SocketEngine</a></td></tr>
  45
  46 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The actual socketengine class presents the same interface on all operating systems, but its private members and internal behaviour should be treated as blackboxed, and vary from system to system and upon the config settings chosen by the server admin.  <a href="classSocketEngine.html#_details">More...</a><br></td></tr>
  47 <tr><td colspan="2"><br><h2>Variables</h2></td></tr>
  48 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FEMPTY_5FSLOT">X_EMPTY_SLOT</a> = 0</td></tr>
  49
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Each of these values represents a socket type in our reference table (the reference table itself is only accessible to <a class="el" href="socketengine_8cpp.html">socketengine.cpp</a>).  <a href="#X_5FEMPTY_5FSLOT"></a><br></td></tr>
  51 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FLISTEN">X_LISTEN</a> = 1</td></tr>
  52
  53 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FESTAB_5FCLIENT">X_ESTAB_CLIENT</a> = 2</td></tr>
  54
  55 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FESTAB_5FMODULE">X_ESTAB_MODULE</a> = 3</td></tr>
  56
  57 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FESTAB_5FDNS">X_ESTAB_DNS</a> = 4</td></tr>
  58
  59 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FREADBIT">X_READBIT</a> = 0x80</td></tr>
  60
  61 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">To indicate that a socket is readable, we mask its top bit with this X_READBIT value.  <a href="#X_5FREADBIT"></a><br></td></tr>
  62 </table>
  63 <hr><h2>Variable Documentation</h2>
  64 <a class="anchor" name="X_5FEMPTY_5FSLOT"></a><!-- doxytag: member="socketengine.h::X_EMPTY_SLOT" ref="X_5FEMPTY_5FSLOT" args="" --><p>
  65 <table class="mdTable" cellpadding="2" cellspacing="0">
  66   <tr>
  67     <td class="mdRow">
  68       <table cellpadding="0" cellspacing="0" border="0">
  69         <tr>
  70           <td class="md" nowrap valign="top">const char <a class="el" href="socketengine_8h.html#X_5FEMPTY_5FSLOT">X_EMPTY_SLOT</a> = 0          </td>
  71         </tr>
  72       </table>
  73     </td>
  74   </tr>
  75 </table>
  76 <table cellspacing="5" cellpadding="0" border="0">
  77   <tr>
  78     <td>
  79       &nbsp;
  80     </td>
  81     <td>
  82
  83 <p>
  84 Each of these values represents a socket type in our reference table (the reference table itself is only accessible to <a class="el" href="socketengine_8cpp.html">socketengine.cpp</a>).
  85 <p>
  86
  87 <p>
  88 Definition at line <a class="el" href="socketengine_8h-source.html#l00041">41</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>.
  89 <p>
  90 Referenced by <a class="el" href="socketengine_8cpp-source.html#l00057">SocketEngine::GetType()</a>.    </td>
  91   </tr>
  92 </table>
  93 <a class="anchor" name="X_5FESTAB_5FCLIENT"></a><!-- doxytag: member="socketengine.h::X_ESTAB_CLIENT" ref="X_5FESTAB_5FCLIENT" args="" --><p>
  94 <table class="mdTable" cellpadding="2" cellspacing="0">
  95   <tr>
  96     <td class="mdRow">
  97       <table cellpadding="0" cellspacing="0" border="0">
  98         <tr>
  99           <td class="md" nowrap valign="top">const char <a class="el" href="socketengine_8h.html#X_5FESTAB_5FCLIENT">X_ESTAB_CLIENT</a> = 2          </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
 114 <p>
 115 Definition at line <a class="el" href="socketengine_8h-source.html#l00043">43</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>.
 116 <p>
 117 Referenced by <a class="el" href="users_8cpp-source.html#l00524">AddClient()</a>.    </td>
 118   </tr>
 119 </table>
 120 <a class="anchor" name="X_5FESTAB_5FDNS"></a><!-- doxytag: member="socketengine.h::X_ESTAB_DNS" ref="X_5FESTAB_5FDNS" args="" --><p>
 121 <table class="mdTable" 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">const char <a class="el" href="socketengine_8h.html#X_5FESTAB_5FDNS">X_ESTAB_DNS</a> = 4          </td>
 127         </tr>
 128       </table>
 129     </td>
 130   </tr>
 131 </table>
 132 <table cellspacing="5" cellpadding="0" border="0">
 133   <tr>
 134     <td>
 135       &nbsp;
 136     </td>
 137     <td>
 138
 139 <p>
 140
 141 <p>
 142 Definition at line <a class="el" href="socketengine_8h-source.html#l00045">45</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>.    </td>
 143   </tr>
 144 </table>
 145 <a class="anchor" name="X_5FESTAB_5FMODULE"></a><!-- doxytag: member="socketengine.h::X_ESTAB_MODULE" ref="X_5FESTAB_5FMODULE" args="" --><p>
 146 <table class="mdTable" cellpadding="2" cellspacing="0">
 147   <tr>
 148     <td class="mdRow">
 149       <table cellpadding="0" cellspacing="0" border="0">
 150         <tr>
 151           <td class="md" nowrap valign="top">const char <a class="el" href="socketengine_8h.html#X_5FESTAB_5FMODULE">X_ESTAB_MODULE</a> = 3          </td>
 152         </tr>
 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
 166 <p>
 167 Definition at line <a class="el" href="socketengine_8h-source.html#l00044">44</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>.
 168 <p>
 169 Referenced by <a class="el" href="socket_8cpp-source.html#l00050">InspSocket::InspSocket()</a>, and <a class="el" href="socket_8cpp-source.html#l00216">InspSocket::Poll()</a>.    </td>
 170   </tr>
 171 </table>
 172 <a class="anchor" name="X_5FLISTEN"></a><!-- doxytag: member="socketengine.h::X_LISTEN" ref="X_5FLISTEN" args="" --><p>
 173 <table class="mdTable" cellpadding="2" cellspacing="0">
 174   <tr>
 175     <td class="mdRow">
 176       <table cellpadding="0" cellspacing="0" border="0">
 177         <tr>
 178           <td class="md" nowrap valign="top">const char <a class="el" href="socketengine_8h.html#X_5FLISTEN">X_LISTEN</a> = 1          </td>
 179         </tr>
 180       </table>
 181     </td>
 182   </tr>
 183 </table>
 184 <table cellspacing="5" cellpadding="0" border="0">
 185   <tr>
 186     <td>
 187       &nbsp;
 188     </td>
 189     <td>
 190
 191 <p>
 192
 193 <p>
 194 Definition at line <a class="el" href="socketengine_8h-source.html#l00042">42</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>.    </td>
 195   </tr>
 196 </table>
 197 <a class="anchor" name="X_5FREADBIT"></a><!-- doxytag: member="socketengine.h::X_READBIT" ref="X_5FREADBIT" args="" --><p>
 198 <table class="mdTable" cellpadding="2" cellspacing="0">
 199   <tr>
 200     <td class="mdRow">
 201       <table cellpadding="0" cellspacing="0" border="0">
 202         <tr>
 203           <td class="md" nowrap valign="top">const char <a class="el" href="socketengine_8h.html#X_5FREADBIT">X_READBIT</a> = 0x80          </td>
 204         </tr>
 205       </table>
 206     </td>
 207   </tr>
 208 </table>
 209 <table cellspacing="5" cellpadding="0" border="0">
 210   <tr>
 211     <td>
 212       &nbsp;
 213     </td>
 214     <td>
 215
 216 <p>
 217 To indicate that a socket is readable, we mask its top bit with this X_READBIT value.
 218 <p>
 219 The socket engine can handle two types of socket, readable and writeable (error sockets are dealt with when read() and write() return negative or zero values).
 220 <p>
 221 Definition at line <a class="el" href="socketengine_8h-source.html#l00055">55</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>.
 222 <p>
 223 Referenced by <a class="el" href="socketengine_8cpp-source.html#l00065">SocketEngine::AddFd()</a>, <a class="el" href="socketengine_8cpp-source.html#l00103">SocketEngine::DelFd()</a>, and <a class="el" href="socketengine_8cpp-source.html#l00146">SocketEngine::Wait()</a>.    </td>
 224   </tr>
 225 </table>
 226 <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 19 18:05:21 2005 for InspIRCd by&nbsp;
 227 <a href="http://www.doxygen.org/index.html">
 228 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 229 </body>
 230 </html>