docs/module-doc/socket_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: socket.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>socket.h File Reference</h1><code>#include &lt;sys/types.h&gt;</code><br>
  11 <code>#include &lt;sys/socket.h&gt;</code><br>
  12 <code>#include &lt;netinet/in.h&gt;</code><br>
  13 <code>#include &lt;sstream&gt;</code><br>
  14 <code>#include &lt;string&gt;</code><br>
  15
  16 <p>
  17 Include dependency graph for socket.h:<p><center><img src="socket_8h__incl.gif" border="0" usemap="#socket.h_map" alt=""></center>
  18
  19 <p>
  20 This graph shows which files directly or indirectly include this file:<p><center><img src="socket_8h__dep__incl.gif" border="0" usemap="#socket.hdep_map" alt=""></center>
  21 <map name="socket.hdep_map">
  22 <area href="modules_8cpp-source.html" shape="rect" coords="260,57,359,84" alt="">
  23 <area href="socket_8cpp-source.html" shape="rect" coords="267,133,352,160" alt="">
  24 <area href="modules_8h-source.html" shape="rect" coords="128,57,211,84" alt="">
  25 <area href="inspircd_8h-source.html" shape="rect" coords="129,108,209,135" alt="">
  26 </map>
  27
  28 <p>
  29 <a href="socket_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
  30 <tr><td></td></tr>
  31 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  32 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html">InspSocket</a></td></tr>
  33
  34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">InspSocket is an extendable socket class which modules can use for TCP socket support.  <a href="classInspSocket.html#_details">More...</a><br></td></tr>
  35 <tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
  36 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket_8h.html#InspSocketState">InspSocketState</a> { <br>
  37 &nbsp;&nbsp;<a class="el" href="socket_8h.html#InspSocketStateI_5FDISCONNECTED">I_DISCONNECTED</a>,
  38 <a class="el" href="socket_8h.html#InspSocketStateI_5FCONNECTING">I_CONNECTING</a>,
  39 <a class="el" href="socket_8h.html#InspSocketStateI_5FCONNECTED">I_CONNECTED</a>,
  40 <a class="el" href="socket_8h.html#InspSocketStateI_5FLISTENING">I_LISTENING</a>,
  41 <br>
  42 &nbsp;&nbsp;<a class="el" href="socket_8h.html#InspSocketStateI_5FERROR">I_ERROR</a>
  43 <br>
  44  }</td></tr>
  45
  46 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">States which a socket may be in.  <a href="socket_8h.html#InspSocketState">More...</a><br></td></tr>
  47 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket_8h.html#InspSocketError">InspSocketError</a> { <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FTIMEOUT">I_ERR_TIMEOUT</a>,
  48 <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FSOCKET">I_ERR_SOCKET</a>,
  49 <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FCONNECT">I_ERR_CONNECT</a>,
  50 <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FBIND">I_ERR_BIND</a>
  51  }</td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error types which a socket may exhibit.  <a href="socket_8h.html#InspSocketError">More...</a><br></td></tr>
  54 </table>
  55 <hr><h2>Enumeration Type Documentation</h2>
  56 <a class="anchor" name="InspSocketError"></a><!-- doxytag: member="socket.h::InspSocketError" ref="InspSocketError" args="" --><p>
  57 <table class="mdTable" cellpadding="2" cellspacing="0">
  58   <tr>
  59     <td class="mdRow">
  60       <table cellpadding="0" cellspacing="0" border="0">
  61         <tr>
  62           <td class="md" nowrap valign="top">enum <a class="el" href="socket_8h.html#InspSocketError">InspSocketError</a>          </td>
  63         </tr>
  64       </table>
  65     </td>
  66   </tr>
  67 </table>
  68 <table cellspacing="5" cellpadding="0" border="0">
  69   <tr>
  70     <td>
  71       &nbsp;
  72     </td>
  73     <td>
  74
  75 <p>
  76 Error types which a socket may exhibit.
  77 <p>
  78 <dl compact><dt><b>Enumerator: </b></dt><dd>
  79 <table border="0" cellspacing="2" cellpadding="0">
  80 <tr><td valign="top"><em><a class="anchor" name="InspSocketErrorI_5FERR_5FTIMEOUT"></a><!-- doxytag: member="I_ERR_TIMEOUT" ref="InspSocketErrorI_5FERR_5FTIMEOUT" args="" -->I_ERR_TIMEOUT</em>&nbsp;</td><td>
  81 </td></tr>
  82 <tr><td valign="top"><em><a class="anchor" name="InspSocketErrorI_5FERR_5FSOCKET"></a><!-- doxytag: member="I_ERR_SOCKET" ref="InspSocketErrorI_5FERR_5FSOCKET" args="" -->I_ERR_SOCKET</em>&nbsp;</td><td>
  83 </td></tr>
  84 <tr><td valign="top"><em><a class="anchor" name="InspSocketErrorI_5FERR_5FCONNECT"></a><!-- doxytag: member="I_ERR_CONNECT" ref="InspSocketErrorI_5FERR_5FCONNECT" args="" -->I_ERR_CONNECT</em>&nbsp;</td><td>
  85 </td></tr>
  86 <tr><td valign="top"><em><a class="anchor" name="InspSocketErrorI_5FERR_5FBIND"></a><!-- doxytag: member="I_ERR_BIND" ref="InspSocketErrorI_5FERR_5FBIND" args="" -->I_ERR_BIND</em>&nbsp;</td><td>
  87 </td></tr>
  88 </table>
  89 </dl>
  90
  91 <p>
  92 Definition at line <a class="el" href="socket_8h-source.html#l00034">34</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>.<div class="fragment"><pre class="fragment"><a name="l00034"></a>00034 { <a class="code" href="socket_8h.html#InspSocketErrorI_5FERR_5FTIMEOUT">I_ERR_TIMEOUT</a>, <a class="code" href="socket_8h.html#InspSocketErrorI_5FERR_5FSOCKET">I_ERR_SOCKET</a>, <a class="code" href="socket_8h.html#InspSocketErrorI_5FERR_5FCONNECT">I_ERR_CONNECT</a>, <a class="code" href="socket_8h.html#InspSocketErrorI_5FERR_5FBIND">I_ERR_BIND</a> };
  93 </pre></div>
  94 <p>
  95     </td>
  96   </tr>
  97 </table>
  98 <a class="anchor" name="InspSocketState"></a><!-- doxytag: member="socket.h::InspSocketState" ref="InspSocketState" args="" --><p>
  99 <table class="mdTable" cellpadding="2" cellspacing="0">
 100   <tr>
 101     <td class="mdRow">
 102       <table cellpadding="0" cellspacing="0" border="0">
 103         <tr>
 104           <td class="md" nowrap valign="top">enum <a class="el" href="socket_8h.html#InspSocketState">InspSocketState</a>          </td>
 105         </tr>
 106       </table>
 107     </td>
 108   </tr>
 109 </table>
 110 <table cellspacing="5" cellpadding="0" border="0">
 111   <tr>
 112     <td>
 113       &nbsp;
 114     </td>
 115     <td>
 116
 117 <p>
 118 States which a socket may be in.
 119 <p>
 120 <dl compact><dt><b>Enumerator: </b></dt><dd>
 121 <table border="0" cellspacing="2" cellpadding="0">
 122 <tr><td valign="top"><em><a class="anchor" name="InspSocketStateI_5FDISCONNECTED"></a><!-- doxytag: member="I_DISCONNECTED" ref="InspSocketStateI_5FDISCONNECTED" args="" -->I_DISCONNECTED</em>&nbsp;</td><td>
 123 </td></tr>
 124 <tr><td valign="top"><em><a class="anchor" name="InspSocketStateI_5FCONNECTING"></a><!-- doxytag: member="I_CONNECTING" ref="InspSocketStateI_5FCONNECTING" args="" -->I_CONNECTING</em>&nbsp;</td><td>
 125 </td></tr>
 126 <tr><td valign="top"><em><a class="anchor" name="InspSocketStateI_5FCONNECTED"></a><!-- doxytag: member="I_CONNECTED" ref="InspSocketStateI_5FCONNECTED" args="" -->I_CONNECTED</em>&nbsp;</td><td>
 127 </td></tr>
 128 <tr><td valign="top"><em><a class="anchor" name="InspSocketStateI_5FLISTENING"></a><!-- doxytag: member="I_LISTENING" ref="InspSocketStateI_5FLISTENING" args="" -->I_LISTENING</em>&nbsp;</td><td>
 129 </td></tr>
 130 <tr><td valign="top"><em><a class="anchor" name="InspSocketStateI_5FERROR"></a><!-- doxytag: member="I_ERROR" ref="InspSocketStateI_5FERROR" args="" -->I_ERROR</em>&nbsp;</td><td>
 131 </td></tr>
 132 </table>
 133 </dl>
 134
 135 <p>
 136 Definition at line <a class="el" href="socket_8h-source.html#l00029">29</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>.<div class="fragment"><pre class="fragment"><a name="l00029"></a>00029 { <a class="code" href="socket_8h.html#InspSocketStateI_5FDISCONNECTED">I_DISCONNECTED</a>, <a class="code" href="socket_8h.html#InspSocketStateI_5FCONNECTING">I_CONNECTING</a>, <a class="code" href="socket_8h.html#InspSocketStateI_5FCONNECTED">I_CONNECTED</a>, <a class="code" href="socket_8h.html#InspSocketStateI_5FLISTENING">I_LISTENING</a>, <a class="code" href="socket_8h.html#InspSocketStateI_5FERROR">I_ERROR</a> };
 137 </pre></div>
 138 <p>
 139     </td>
 140   </tr>
 141 </table>
 142 <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 19 18:02:14 2005 for InspIRCd by&nbsp;
 143 <a href="http://www.doxygen.org/index.html">
 144 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 145 </body>
 146 </html>