Added extra documentation for InspSocket (at last)

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2356 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 82 insertions, 48 deletions

diff --git a/docs/module-doc/socket_8h-source.html b/docs/module-doc/socket_8h-source.html
index 3f5815e6c..21535c883 100644
--- a/docs/module-doc/socket_8h-source.html
+++ b/docs/module-doc/socket_8h-source.html
@@ -29,54 +29,88 @@
 <a name="l00020"></a>00020 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
 <a name="l00021"></a>00021 <span class="preprocessor">#include &lt;sys/socket.h&gt;</span>
 <a name="l00022"></a>00022 <span class="preprocessor">#include &lt;netinet/in.h&gt;</span>
-<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;poll.h&gt;</span>
-<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;sstream&gt;</span>
-<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;string&gt;</span>
-<a name="l00026"></a>00026 
-<a name="l00027"></a><a class="code" href="socket_8h.html#InspSocketState">00027</a> <span class="keyword">enum</span> <a class="code" href="socket_8h.html#InspSocketState">InspSocketState</a> { <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> };
-<a name="l00028"></a><a class="code" href="socket_8h.html#InspSocketError">00028</a> <span class="keyword">enum</span> <a class="code" href="socket_8h.html#InspSocketError">InspSocketError</a> { <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> };
-<a name="l00029"></a>00029 
-<a name="l00030"></a><a class="code" href="classInspSocket.html">00030</a> <span class="keyword">class </span><a class="code" href="classInspSocket.html">InspSocket</a>
-<a name="l00031"></a>00031 {
-<a name="l00032"></a>00032 <span class="keyword">private</span>:
-<a name="l00033"></a><a class="code" href="classInspSocket.html#fd">00033</a>         <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#fd">fd</a>;
-<a name="l00034"></a><a class="code" href="classInspSocket.html#host">00034</a>         <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classInspSocket.html#host">host</a>;
-<a name="l00035"></a><a class="code" href="classInspSocket.html#port">00035</a>         <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#port">port</a>;
-<a name="l00036"></a><a class="code" href="classInspSocket.html#state">00036</a>         <a class="code" href="socket_8h.html#InspSocketState">InspSocketState</a> <a class="code" href="classInspSocket.html#state">state</a>;
-<a name="l00037"></a><a class="code" href="classInspSocket.html#addr">00037</a>         sockaddr_in <a class="code" href="classInspSocket.html#addr">addr</a>;
-<a name="l00038"></a><a class="code" href="classInspSocket.html#addy">00038</a>         in_addr <a class="code" href="classInspSocket.html#addy">addy</a>;
-<a name="l00039"></a><a class="code" href="classInspSocket.html#timeout_5Fend">00039</a>         time_t <a class="code" href="classInspSocket.html#timeout_5Fend">timeout_end</a>;
-<a name="l00040"></a><a class="code" href="classInspSocket.html#timeout">00040</a>         <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#timeout">timeout</a>;
-<a name="l00041"></a><a class="code" href="classInspSocket.html#polls">00041</a>         pollfd <a class="code" href="classInspSocket.html#polls">polls</a>;
-<a name="l00042"></a><a class="code" href="classInspSocket.html#ibuf_5B_31_36_33_38_34_5D">00042</a>         <span class="keywordtype">char</span> <a class="code" href="classInspSocket.html#ibuf_5B_31_36_33_38_34_5D">ibuf</a>[16384];
-<a name="l00043"></a><a class="code" href="classInspSocket.html#IP">00043</a>         <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classInspSocket.html#IP">IP</a>;
-<a name="l00044"></a><a class="code" href="classInspSocket.html#client">00044</a>         sockaddr_in <a class="code" href="classInspSocket.html#client">client</a>;
-<a name="l00045"></a><a class="code" href="classInspSocket.html#server">00045</a>         sockaddr_in <a class="code" href="classInspSocket.html#server">server</a>;
-<a name="l00046"></a><a class="code" href="classInspSocket.html#length">00046</a>         socklen_t <a class="code" href="classInspSocket.html#length">length</a>;
-<a name="l00047"></a>00047 <span class="keyword">public</span>:
-<a name="l00048"></a>00048         <a class="code" href="classInspSocket.html#InspSocket_28_29">InspSocket</a>();
-<a name="l00049"></a>00049         <a class="code" href="classInspSocket.html#InspSocket_28_29">InspSocket</a>(<span class="keywordtype">int</span> newfd, <span class="keywordtype">char</span>* ip);
-<a name="l00050"></a>00050         <a class="code" href="classInspSocket.html#InspSocket_28_29">InspSocket</a>(<a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classInspSocket.html#host">host</a>, <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#port">port</a>, <span class="keywordtype">bool</span> listening, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxtime);
-<a name="l00051"></a>00051         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#OnConnected_28_29">OnConnected</a>();
-<a name="l00052"></a>00052         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#OnError_28InspSocketError_20e_29">OnError</a>(<a class="code" href="socket_8h.html#InspSocketError">InspSocketError</a> e);
-<a name="l00053"></a>00053         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#OnDisconnect_28_29">OnDisconnect</a>();
-<a name="l00054"></a>00054         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#OnDataReady_28_29">OnDataReady</a>();
-<a name="l00055"></a>00055         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#OnTimeout_28_29">OnTimeout</a>();
-<a name="l00056"></a>00056         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#OnClose_28_29">OnClose</a>();
-<a name="l00057"></a>00057         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classInspSocket.html#Read_28_29">Read</a>();
-<a name="l00058"></a>00058         <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classInspSocket.html#GetIP_28_29">GetIP</a>();
-<a name="l00059"></a>00059         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#Write_28std_3A_3Astring_20data_29">Write</a>(<a class="code" href="namespaceirc.html#string">std::string</a> data);
-<a name="l00060"></a>00060         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#OnIncomingConnection_28int_20newfd_2C_20char_20_2Aip_29">OnIncomingConnection</a>(<span class="keywordtype">int</span> newfd, <span class="keywordtype">char</span>* ip);
-<a name="l00061"></a>00061         <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#SetState_28InspSocketState_20s_29">SetState</a>(<a class="code" href="socket_8h.html#InspSocketState">InspSocketState</a> s);
-<a name="l00062"></a>00062         <a class="code" href="socket_8h.html#InspSocketState">InspSocketState</a> <a class="code" href="classInspSocket.html#GetState_28_29">GetState</a>();
-<a name="l00063"></a>00063         <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#Poll_28_29">Poll</a>();
-<a name="l00064"></a>00064         <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#GetFd_28_29">GetFd</a>();
-<a name="l00065"></a>00065         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#Close_28_29">Close</a>();
-<a name="l00066"></a>00066         <span class="keyword">virtual</span> <a class="code" href="classInspSocket.html#_7EInspSocket_28_29">~InspSocket</a>();
-<a name="l00067"></a>00067 };
-<a name="l00068"></a>00068 
-<a name="l00069"></a>00069 <span class="preprocessor">#endif</span>
-</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Dec 12 13:31:08 2005 for InspIRCd by&nbsp;
+<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;sstream&gt;</span>
+<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;string&gt;</span>
+<a name="l00025"></a>00025 
+<a name="l00029"></a><a class="code" href="socket_8h.html#InspSocketState">00029</a> <span class="keyword">enum</span> <a class="code" href="socket_8h.html#InspSocketState">InspSocketState</a> { <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> };
+<a name="l00030"></a>00030 
+<a name="l00034"></a><a class="code" href="socket_8h.html#InspSocketError">00034</a> <span class="keyword">enum</span> <a class="code" href="socket_8h.html#InspSocketError">InspSocketError</a> { <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> };
+<a name="l00035"></a>00035 
+<a name="l00047"></a><a class="code" href="classInspSocket.html">00047</a> <span class="keyword">class </span><a class="code" href="classInspSocket.html">InspSocket</a>
+<a name="l00048"></a>00048 {
+<a name="l00049"></a>00049 <span class="keyword">private</span>:
+<a name="l00050"></a>00050 
+<a name="l00054"></a><a class="code" href="classInspSocket.html#fd">00054</a>         <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#fd">fd</a>;
+<a name="l00055"></a>00055 
+<a name="l00059"></a><a class="code" href="classInspSocket.html#host">00059</a>         <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classInspSocket.html#host">host</a>;
+<a name="l00060"></a>00060 
+<a name="l00065"></a><a class="code" href="classInspSocket.html#port">00065</a>         <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#port">port</a>;
+<a name="l00066"></a>00066 
+<a name="l00072"></a><a class="code" href="classInspSocket.html#state">00072</a>         <a class="code" href="socket_8h.html#InspSocketState">InspSocketState</a> <a class="code" href="classInspSocket.html#state">state</a>;
+<a name="l00073"></a>00073 
+<a name="l00078"></a><a class="code" href="classInspSocket.html#addr">00078</a>         sockaddr_in <a class="code" href="classInspSocket.html#addr">addr</a>;
+<a name="l00079"></a>00079 
+<a name="l00084"></a><a class="code" href="classInspSocket.html#addy">00084</a>         in_addr <a class="code" href="classInspSocket.html#addy">addy</a>;
+<a name="l00085"></a>00085 
+<a name="l00091"></a><a class="code" href="classInspSocket.html#timeout_5Fend">00091</a>         time_t <a class="code" href="classInspSocket.html#timeout_5Fend">timeout_end</a>;
+<a name="l00092"></a>00092 
+<a name="l00097"></a><a class="code" href="classInspSocket.html#timeout">00097</a>         <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#timeout">timeout</a>;
+<a name="l00098"></a>00098         
+<a name="l00106"></a><a class="code" href="classInspSocket.html#ibuf_5B_31_36_33_38_34_5D">00106</a>         <span class="keywordtype">char</span> <a class="code" href="classInspSocket.html#ibuf_5B_31_36_33_38_34_5D">ibuf</a>[16384];
+<a name="l00107"></a>00107 
+<a name="l00113"></a><a class="code" href="classInspSocket.html#IP">00113</a>         <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classInspSocket.html#IP">IP</a>;
+<a name="l00114"></a>00114 
+<a name="l00119"></a><a class="code" href="classInspSocket.html#client">00119</a>         sockaddr_in <a class="code" href="classInspSocket.html#client">client</a>;
+<a name="l00120"></a>00120 
+<a name="l00125"></a><a class="code" href="classInspSocket.html#server">00125</a>         sockaddr_in <a class="code" href="classInspSocket.html#server">server</a>;
+<a name="l00126"></a>00126 
+<a name="l00131"></a><a class="code" href="classInspSocket.html#length">00131</a>         socklen_t <a class="code" href="classInspSocket.html#length">length</a>;
+<a name="l00132"></a>00132 
+<a name="l00133"></a>00133 <span class="keyword">public</span>:
+<a name="l00134"></a>00134 
+<a name="l00139"></a>00139         <a class="code" href="classInspSocket.html#InspSocket_28_29">InspSocket</a>();
+<a name="l00140"></a>00140 
+<a name="l00149"></a>00149         <a class="code" href="classInspSocket.html#InspSocket_28_29">InspSocket</a>(<span class="keywordtype">int</span> newfd, <span class="keywordtype">char</span>* ip);
+<a name="l00150"></a>00150 
+<a name="l00160"></a>00160         <a class="code" href="classInspSocket.html#InspSocket_28_29">InspSocket</a>(<a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classInspSocket.html#host">host</a>, <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#port">port</a>, <span class="keywordtype">bool</span> listening, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> maxtime);
+<a name="l00161"></a>00161 
+<a name="l00167"></a>00167         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#OnConnected_28_29">OnConnected</a>();
+<a name="l00168"></a>00168 
+<a name="l00175"></a>00175         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#OnError_28InspSocketError_20e_29">OnError</a>(<a class="code" href="socket_8h.html#InspSocketError">InspSocketError</a> e);
+<a name="l00176"></a>00176 
+<a name="l00181"></a>00181         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#OnDisconnect_28_29">OnDisconnect</a>();
+<a name="l00182"></a>00182 
+<a name="l00195"></a>00195         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#OnDataReady_28_29">OnDataReady</a>();
+<a name="l00196"></a>00196 
+<a name="l00204"></a>00204         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#OnTimeout_28_29">OnTimeout</a>();
+<a name="l00205"></a>00205 
+<a name="l00214"></a>00214         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#OnClose_28_29">OnClose</a>();
+<a name="l00215"></a>00215 
+<a name="l00221"></a>00221         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classInspSocket.html#Read_28_29">Read</a>();
+<a name="l00222"></a>00222 
+<a name="l00228"></a>00228         <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classInspSocket.html#GetIP_28_29">GetIP</a>();
+<a name="l00229"></a>00229 
+<a name="l00236"></a>00236         <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#Timeout_28time_5Ft_20current_29">Timeout</a>(time_t current);
+<a name="l00237"></a>00237 
+<a name="l00243"></a>00243         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#Write_28std_3A_3Astring_20data_29">Write</a>(<a class="code" href="namespaceirc.html#string">std::string</a> data);
+<a name="l00244"></a>00244 
+<a name="l00258"></a>00258         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#OnIncomingConnection_28int_20newfd_2C_20char_20_2Aip_29">OnIncomingConnection</a>(<span class="keywordtype">int</span> newfd, <span class="keywordtype">char</span>* ip);
+<a name="l00259"></a>00259 
+<a name="l00265"></a>00265         <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#SetState_28InspSocketState_20s_29">SetState</a>(<a class="code" href="socket_8h.html#InspSocketState">InspSocketState</a> s);
+<a name="l00266"></a>00266 
+<a name="l00270"></a>00270         <a class="code" href="socket_8h.html#InspSocketState">InspSocketState</a> <a class="code" href="classInspSocket.html#GetState_28_29">GetState</a>();
+<a name="l00271"></a>00271 
+<a name="l00280"></a>00280         <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#Poll_28_29">Poll</a>();
+<a name="l00281"></a>00281 
+<a name="l00287"></a>00287         <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#GetFd_28_29">GetFd</a>();
+<a name="l00288"></a>00288 
+<a name="l00294"></a>00294         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#Close_28_29">Close</a>();
+<a name="l00295"></a>00295 
+<a name="l00301"></a>00301         <span class="keyword">virtual</span> <a class="code" href="classInspSocket.html#_7EInspSocket_28_29">~InspSocket</a>();
+<a name="l00302"></a>00302 };
+<a name="l00303"></a>00303 
+<a name="l00304"></a>00304 <span class="preprocessor">#endif</span>
+</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Dec 12 18:30:58 2005 for InspIRCd by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 </body>