]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/socket_8h-source.html
601404fc35f7eff838e21f2cbbea5604b67239b5
[user/henk/code/inspircd.git] / docs / module-doc / socket_8h-source.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 Source File</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</h1><a href="socket_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*       +------------------------------------+</span>
11 <a name="l00002"></a>00002 <span class="comment"> *       | Inspire Internet Relay Chat Daemon |</span>
12 <a name="l00003"></a>00003 <span class="comment"> *       +------------------------------------+</span>
13 <a name="l00004"></a>00004 <span class="comment"> *</span>
14 <a name="l00005"></a>00005 <span class="comment"> *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.</span>
15 <a name="l00006"></a>00006 <span class="comment"> *                       E-mail:</span>
16 <a name="l00007"></a>00007 <span class="comment"> *                &lt;brain@chatspike.net&gt;</span>
17 <a name="l00008"></a>00008 <span class="comment"> *                &lt;Craig@chatspike.net&gt;</span>
18 <a name="l00009"></a>00009 <span class="comment"> *     </span>
19 <a name="l00010"></a>00010 <span class="comment"> * Written by Craig Edwards, Craig McLure, and others.</span>
20 <a name="l00011"></a>00011 <span class="comment"> * This program is free but copyrighted software; see</span>
21 <a name="l00012"></a>00012 <span class="comment"> *            the file COPYING for details.</span>
22 <a name="l00013"></a>00013 <span class="comment"> *</span>
23 <a name="l00014"></a>00014 <span class="comment"> * ---------------------------------------------------</span>
24 <a name="l00015"></a>00015 <span class="comment"> */</span>
25 <a name="l00016"></a>00016 
26 <a name="l00017"></a>00017 <span class="preprocessor">#ifndef __INSP_SOCKET_H__</span>
27 <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __INSP_SOCKET_H__</span>
28 <a name="l00019"></a>00019 <span class="preprocessor"></span>
29 <a name="l00020"></a>00020 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
30 <a name="l00021"></a>00021 <span class="preprocessor">#include &lt;sys/socket.h&gt;</span>
31 <a name="l00022"></a>00022 <span class="preprocessor">#include &lt;netinet/in.h&gt;</span>
32 <a name="l00023"></a>00023 <span class="preprocessor">#include &lt;sstream&gt;</span>
33 <a name="l00024"></a>00024 <span class="preprocessor">#include &lt;string&gt;</span>
34 <a name="l00025"></a>00025 
35 <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> };
36 <a name="l00030"></a>00030 
37 <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> };
38 <a name="l00035"></a>00035 
39 <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>
40 <a name="l00048"></a>00048 {
41 <a name="l00049"></a>00049 <span class="keyword">private</span>:
42 <a name="l00050"></a>00050 
43 <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>;
44 <a name="l00055"></a>00055 
45 <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>;
46 <a name="l00060"></a>00060 
47 <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>;
48 <a name="l00066"></a>00066 
49 <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>;
50 <a name="l00073"></a>00073 
51 <a name="l00078"></a><a class="code" href="classInspSocket.html#addr">00078</a>         sockaddr_in <a class="code" href="classInspSocket.html#addr">addr</a>;
52 <a name="l00079"></a>00079 
53 <a name="l00084"></a><a class="code" href="classInspSocket.html#addy">00084</a>         in_addr <a class="code" href="classInspSocket.html#addy">addy</a>;
54 <a name="l00085"></a>00085 
55 <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>;
56 <a name="l00092"></a>00092 
57 <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>;
58 <a name="l00098"></a>00098         
59 <a name="l00106"></a><a class="code" href="classInspSocket.html#ibuf_5B_36_35_35_33_35_5D">00106</a>         <span class="keywordtype">char</span> <a class="code" href="classInspSocket.html#ibuf_5B_36_35_35_33_35_5D">ibuf</a>[65535];
60 <a name="l00107"></a>00107 
61 <a name="l00111"></a><a class="code" href="classInspSocket.html#Buffer">00111</a>         <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classInspSocket.html#Buffer">Buffer</a>;
62 <a name="l00112"></a>00112 
63 <a name="l00118"></a><a class="code" href="classInspSocket.html#IP">00118</a>         <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classInspSocket.html#IP">IP</a>;
64 <a name="l00119"></a>00119 
65 <a name="l00124"></a><a class="code" href="classInspSocket.html#client">00124</a>         sockaddr_in <a class="code" href="classInspSocket.html#client">client</a>;
66 <a name="l00125"></a>00125 
67 <a name="l00130"></a><a class="code" href="classInspSocket.html#server">00130</a>         sockaddr_in <a class="code" href="classInspSocket.html#server">server</a>;
68 <a name="l00131"></a>00131 
69 <a name="l00136"></a><a class="code" href="classInspSocket.html#length">00136</a>         socklen_t <a class="code" href="classInspSocket.html#length">length</a>;
70 <a name="l00137"></a>00137 
71 <a name="l00140"></a>00140         <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#FlushWriteBuffer_28_29">FlushWriteBuffer</a>();
72 <a name="l00141"></a>00141 
73 <a name="l00142"></a>00142 <span class="keyword">public</span>:
74 <a name="l00143"></a>00143 
75 <a name="l00148"></a>00148         <a class="code" href="classInspSocket.html#InspSocket_28_29">InspSocket</a>();
76 <a name="l00149"></a>00149 
77 <a name="l00158"></a>00158         <a class="code" href="classInspSocket.html#InspSocket_28_29">InspSocket</a>(<span class="keywordtype">int</span> newfd, <span class="keywordtype">char</span>* ip);
78 <a name="l00159"></a>00159 
79 <a name="l00169"></a>00169         <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);
80 <a name="l00170"></a>00170 
81 <a name="l00176"></a>00176         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#OnConnected_28_29">OnConnected</a>();
82 <a name="l00177"></a>00177 
83 <a name="l00184"></a>00184         <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);
84 <a name="l00185"></a>00185 
85 <a name="l00190"></a>00190         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#OnDisconnect_28_29">OnDisconnect</a>();
86 <a name="l00191"></a>00191 
87 <a name="l00204"></a>00204         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#OnDataReady_28_29">OnDataReady</a>();
88 <a name="l00205"></a>00205 
89 <a name="l00213"></a>00213         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#OnTimeout_28_29">OnTimeout</a>();
90 <a name="l00214"></a>00214 
91 <a name="l00223"></a>00223         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#OnClose_28_29">OnClose</a>();
92 <a name="l00224"></a>00224 
93 <a name="l00230"></a>00230         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classInspSocket.html#Read_28_29">Read</a>();
94 <a name="l00231"></a>00231 
95 <a name="l00237"></a>00237         <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classInspSocket.html#GetIP_28_29">GetIP</a>();
96 <a name="l00238"></a>00238 
97 <a name="l00245"></a>00245         <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#Timeout_28time_5Ft_20current_29">Timeout</a>(time_t current);
98 <a name="l00246"></a>00246 
99 <a name="l00252"></a>00252         <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);
100 <a name="l00253"></a>00253 
101 <a name="l00267"></a>00267         <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);
102 <a name="l00268"></a>00268 
103 <a name="l00274"></a>00274         <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);
104 <a name="l00275"></a>00275 
105 <a name="l00279"></a>00279         <a class="code" href="socket_8h.html#InspSocketState">InspSocketState</a> <a class="code" href="classInspSocket.html#GetState_28_29">GetState</a>();
106 <a name="l00280"></a>00280 
107 <a name="l00289"></a>00289         <span class="keywordtype">bool</span> <a class="code" href="classInspSocket.html#Poll_28_29">Poll</a>();
108 <a name="l00290"></a>00290 
109 <a name="l00296"></a>00296         <span class="keywordtype">int</span> <a class="code" href="classInspSocket.html#GetFd_28_29">GetFd</a>();
110 <a name="l00297"></a>00297 
111 <a name="l00303"></a>00303         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classInspSocket.html#Close_28_29">Close</a>();
112 <a name="l00304"></a>00304 
113 <a name="l00310"></a>00310         <span class="keyword">virtual</span> <a class="code" href="classInspSocket.html#_7EInspSocket_28_29">~InspSocket</a>();
114 <a name="l00311"></a>00311 };
115 <a name="l00312"></a>00312 
116 <a name="l00313"></a>00313 <span class="preprocessor">#endif</span>
117 </pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Dec 19 18:02:13 2005 for InspIRCd by&nbsp;
118 <a href="http://www.doxygen.org/index.html">
119 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
120 </body>
121 </html>