]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/connection_8h-source.html
Added docs for new smaller memory footprint classes
[user/henk/code/inspircd.git] / docs / module-doc / connection_8h-source.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: connection.h Source File</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>connection.h</h1><a href="connection_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*       +------------------------------------+</span>
9 00002 <span class="comment"> *       | Inspire Internet Relay Chat Daemon |</span>
10 00003 <span class="comment"> *       +------------------------------------+</span>
11 00004 <span class="comment"> *</span>
12 00005 <span class="comment"> *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.</span>
13 00006 <span class="comment"> *                       E-mail:</span>
14 00007 <span class="comment"> *                &lt;brain@chatspike.net&gt;</span>
15 00008 <span class="comment"> *                &lt;Craig@chatspike.net&gt;</span>
16 00009 <span class="comment"> *     </span>
17 00010 <span class="comment"> * Written by Craig Edwards, Craig McLure, and others.</span>
18 00011 <span class="comment"> * This program is free but copyrighted software; see</span>
19 00012 <span class="comment"> *            the file COPYING for details.</span>
20 00013 <span class="comment"> *</span>
21 00014 <span class="comment"> * ---------------------------------------------------</span>
22 00015 <span class="comment"> */</span>
23 00016 
24 00017 <span class="preprocessor">#include "inspircd_config.h"</span>
25 00018 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
26 00019 <span class="preprocessor">#include &lt;string&gt;</span>
27 00020 <span class="preprocessor">#include &lt;map&gt;</span>
28 00021 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
29 00022 <span class="preprocessor">#include &lt;sys/socket.h&gt;</span>
30 00023 <span class="preprocessor">#include &lt;netdb.h&gt;</span>
31 00024 <span class="preprocessor">#include &lt;netinet/in.h&gt;</span>
32 00025 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
33 00026 <span class="preprocessor">#include &lt;errno.h&gt;</span>
34 00027 <span class="preprocessor">#include &lt;time.h&gt;</span>
35 00028 <span class="preprocessor">#include &lt;vector&gt;</span>
36 00029 <span class="preprocessor">#include &lt;deque&gt;</span>
37 00030 <span class="preprocessor">#include &lt;sstream&gt;</span>
38 00031 
39 00032 <span class="preprocessor">#ifndef __CONNECTION_H__</span>
40 00033 <span class="preprocessor"></span><span class="preprocessor">#define __CONNECTION_H__</span>
41 00034 <span class="preprocessor"></span>
42 <a name="l00035"></a><a class="code" href="connection_8h.html#a0">00035</a> <span class="preprocessor">#define STATE_DISCONNECTED      0</span>
43 <a name="l00036"></a><a class="code" href="connection_8h.html#a1">00036</a> <span class="preprocessor"></span><span class="preprocessor">#define STATE_CONNECTED         1</span>
44 <a name="l00037"></a><a class="code" href="connection_8h.html#a2">00037</a> <span class="preprocessor"></span><span class="preprocessor">#define STATE_SYNC              2</span>
45 <a name="l00038"></a><a class="code" href="connection_8h.html#a3">00038</a> <span class="preprocessor"></span><span class="preprocessor">#define STATE_NOAUTH_INBOUND    3</span>
46 <a name="l00039"></a><a class="code" href="connection_8h.html#a4">00039</a> <span class="preprocessor"></span><span class="preprocessor">#define STATE_NOAUTH_OUTBOUND   4</span>
47 <a name="l00040"></a><a class="code" href="connection_8h.html#a5">00040</a> <span class="preprocessor"></span><span class="preprocessor">#define STATE_SERVICES          5</span>
48 00041 <span class="preprocessor"></span>
49 <a name="l00054"></a><a class="code" href="classircd__connector.html">00054</a> <span class="keyword">class </span><a class="code" href="classircd__connector.html">ircd_connector</a> : <span class="keyword">public</span> <a class="code" href="classExtensible.html">Extensible</a>
50 00055 {
51 00056  <span class="keyword">private</span>:
52 <a name="l00059"></a><a class="code" href="classircd__connector.html#r0">00059</a>         sockaddr_in <a class="code" href="classircd__connector.html#r0">addr</a>;
53 00060         
54 <a name="l00063"></a><a class="code" href="classircd__connector.html#r1">00063</a>         <span class="keywordtype">int</span> <a class="code" href="classircd__connector.html#r1">fd</a>;
55 00064         
56 <a name="l00067"></a><a class="code" href="classircd__connector.html#r2">00067</a>         std::string <a class="code" href="classircd__connector.html#r2">servername</a>;
57 00068         
58 <a name="l00071"></a><a class="code" href="classircd__connector.html#r3">00071</a>         std::string <a class="code" href="classircd__connector.html#r3">description</a>;
59 00072         
60 <a name="l00076"></a><a class="code" href="classircd__connector.html#r4">00076</a>         <span class="keywordtype">char</span> <a class="code" href="classircd__connector.html#r4">state</a>;
61 00077         
62 00080         <span class="keywordtype">bool</span> <a class="code" href="classircd__connector.html#d0">SetHostAddress</a>(<span class="keywordtype">char</span>* host, <span class="keywordtype">int</span> port);
63 00081 
64 <a name="l00084"></a><a class="code" href="classircd__connector.html#r5">00084</a>         std::string <a class="code" href="classircd__connector.html#r5">version</a>;
65 00085 
66 00086  <span class="keyword">public</span>:
67 00087 
68 <a name="l00092"></a><a class="code" href="classircd__connector.html#o0">00092</a>         std::string <a class="code" href="classircd__connector.html#o0">ircdbuffer</a>;
69 00093 
70 00094  
71 <a name="l00099"></a><a class="code" href="classircd__connector.html#o1">00099</a>         <span class="keywordtype">char</span> <a class="code" href="classircd__connector.html#o1">host</a>[MAXBUF];
72 00100 
73 <a name="l00105"></a><a class="code" href="classircd__connector.html#o2">00105</a>         <span class="keywordtype">int</span> <a class="code" href="classircd__connector.html#o2">port</a>;
74 00106         
75 <a name="l00111"></a><a class="code" href="classircd__connector.html#o3">00111</a>         std::vector&lt;std::string&gt; <a class="code" href="classircd__connector.html#o3">routes</a>;
76 00112         
77 00113 
78 00116         <span class="keywordtype">bool</span> <a class="code" href="classircd__connector.html#a0">MakeOutboundConnection</a>(<span class="keywordtype">char</span>* newhost, <span class="keywordtype">int</span> newport);
79 00117         
80 00120         std::string <a class="code" href="classircd__connector.html#a1">GetServerName</a>();
81 00121         
82 00124         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a2">SetServerName</a>(std::string serv);
83 00125         
84 00128         <span class="keywordtype">int</span> <a class="code" href="classircd__connector.html#a3">GetDescriptor</a>();
85 00129         
86 00132         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a4">SetDescriptor</a>(<span class="keywordtype">int</span> fd);
87 00133         
88 00136         <span class="keywordtype">int</span> <a class="code" href="classircd__connector.html#a5">GetState</a>();
89 00137         
90 00140         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a6">SetState</a>(<span class="keywordtype">int</span> state);
91 00141         
92 00144         <span class="keywordtype">char</span>* <a class="code" href="classircd__connector.html#a7">GetServerIP</a>();
93 00145         
94 00148         std::string <a class="code" href="classircd__connector.html#a8">GetDescription</a>();
95 00149         
96 00152         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a9">SetDescription</a>(std::string desc);
97 00153         
98 00159         <span class="keywordtype">int</span> <a class="code" href="classircd__connector.html#a10">GetServerPort</a>();
99 00160         
100 00163         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a11">SetServerPort</a>(<span class="keywordtype">int</span> p);
101 00164         
102 00167         <span class="keywordtype">bool</span> <a class="code" href="classircd__connector.html#a12">SetHostAndPort</a>(<span class="keywordtype">char</span>* newhost, <span class="keywordtype">int</span> newport);
103 00168         
104 00172         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a13">CloseConnection</a>();
105 00173 
106 00179         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a14">AddBuffer</a>(std::string a);
107 00180 
108 00185         <span class="keywordtype">bool</span> <a class="code" href="classircd__connector.html#a15">BufferIsComplete</a>();
109 00186 
110 00189         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a16">ClearBuffer</a>();
111 00190 
112 00195         std::string <a class="code" href="classircd__connector.html#a17">GetBuffer</a>();
113 00196 
114 00199         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a18">SetVersionString</a>(std::string newversion);
115 00200 
116 00204         std::string <a class="code" href="classircd__connector.html#a19">GetVersionString</a>();
117 00205 };
118 00206 
119 00207 
120 <a name="l00210"></a><a class="code" href="classconnection.html">00210</a> <span class="keyword">class </span><a class="code" href="classconnection.html">connection</a> : <span class="keyword">public</span> <a class="code" href="classExtensible.html">Extensible</a>
121 00211 {
122 00212  <span class="keyword">public</span>:
123 <a name="l00215"></a><a class="code" href="classconnection.html#o0">00215</a>         <span class="keywordtype">int</span> <a class="code" href="classconnection.html#o0">fd</a>;
124 00216         
125 <a name="l00219"></a><a class="code" href="classconnection.html#o1">00219</a>         <span class="keywordtype">char</span> <a class="code" href="classconnection.html#o1">host</a>[160];
126 00220         
127 <a name="l00223"></a><a class="code" href="classconnection.html#o2">00223</a>         <span class="keywordtype">char</span> <a class="code" href="classconnection.html#o2">ip</a>[16];
128 00224         
129 <a name="l00227"></a><a class="code" href="classconnection.html#o3">00227</a>         <span class="keywordtype">long</span> <a class="code" href="classconnection.html#o3">bytes_in</a>;
130 00228 
131 <a name="l00231"></a><a class="code" href="classconnection.html#o4">00231</a>         <span class="keywordtype">long</span> <a class="code" href="classconnection.html#o4">bytes_out</a>;
132 00232 
133 <a name="l00235"></a><a class="code" href="classconnection.html#o5">00235</a>         <span class="keywordtype">long</span> <a class="code" href="classconnection.html#o5">cmds_in</a>;
134 00236 
135 <a name="l00239"></a><a class="code" href="classconnection.html#o6">00239</a>         <span class="keywordtype">long</span> <a class="code" href="classconnection.html#o6">cmds_out</a>;
136 00240 
137 <a name="l00243"></a><a class="code" href="classconnection.html#o7">00243</a>         <span class="keywordtype">bool</span> <a class="code" href="classconnection.html#o7">haspassed</a>;
138 00244 
139 <a name="l00249"></a><a class="code" href="classconnection.html#o8">00249</a>         <span class="keywordtype">int</span> <a class="code" href="classconnection.html#o8">port</a>;
140 00250         
141 <a name="l00253"></a><a class="code" href="classconnection.html#o9">00253</a>         <span class="keywordtype">char</span> <a class="code" href="classconnection.html#o9">registered</a>;
142 00254         
143 <a name="l00257"></a><a class="code" href="classconnection.html#o10">00257</a>         time_t <a class="code" href="classconnection.html#o10">lastping</a>;
144 00258         
145 <a name="l00261"></a><a class="code" href="classconnection.html#o11">00261</a>         time_t <a class="code" href="classconnection.html#o11">signon</a>;
146 00262         
147 <a name="l00265"></a><a class="code" href="classconnection.html#o12">00265</a>         time_t <a class="code" href="classconnection.html#o12">idle_lastmsg</a>;
148 00266         
149 <a name="l00269"></a><a class="code" href="classconnection.html#o13">00269</a>         time_t <a class="code" href="classconnection.html#o13">nping</a>;
150 00270         
151 <a name="l00274"></a><a class="code" href="classconnection.html#o14">00274</a>         std::vector&lt;ircd_connector&gt; <a class="code" href="classconnection.html#o14">connectors</a>;
152 00275         
153 00278         <a class="code" href="classconnection.html#a0">connection</a>();
154 00279         
155 00282         <span class="keywordtype">bool</span> <a class="code" href="classconnection.html#a1">CreateListener</a>(<span class="keywordtype">char</span>* host, <span class="keywordtype">int</span> p);
156 00283         
157 00286         <span class="keywordtype">bool</span> <a class="code" href="classconnection.html#a2">BeginLink</a>(<span class="keywordtype">char</span>* targethost, <span class="keywordtype">int</span> port, <span class="keywordtype">char</span>* password, <span class="keywordtype">char</span>* servername, <span class="keywordtype">int</span> myport);
158 00287         
159 00290         <span class="keywordtype">bool</span> <a class="code" href="classconnection.html#a3">MeshCookie</a>(<span class="keywordtype">char</span>* targethost, <span class="keywordtype">int</span> port, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> cookie, <span class="keywordtype">char</span>* servername);
160 00291         
161 00294         <span class="keywordtype">void</span> <a class="code" href="classconnection.html#a4">TerminateLink</a>(<span class="keywordtype">char</span>* targethost);
162 00295         
163 00299         <span class="keywordtype">bool</span> <a class="code" href="classconnection.html#a5">SendPacket</a>(<span class="keywordtype">char</span> *message, <span class="keyword">const</span> <span class="keywordtype">char</span>* host);
164 00300         
165 00305         <span class="keywordtype">bool</span> <a class="code" href="classconnection.html#a6">RecvPacket</a>(std::deque&lt;std::string&gt; &amp;messages, <span class="keywordtype">char</span>* host);
166 00306         
167 00309         <a class="code" href="classircd__connector.html">ircd_connector</a>* <a class="code" href="classconnection.html#a7">FindHost</a>(std::string host);
168 00310         
169 00314         <span class="keywordtype">bool</span> <a class="code" href="classconnection.html#a8">AddIncoming</a>(<span class="keywordtype">int</span> fd,<span class="keywordtype">char</span>* targethost, <span class="keywordtype">int</span> sourceport);
170 00315         
171 00316 };
172 00317 
173 00318 
174 00319 <span class="preprocessor">#endif</span>
175 </pre></div><hr size="1"><address style="align: right;"><small>Generated on Thu May 12 22:58:58 2005 for InspIRCd by
176 <a href="http://www.doxygen.org/index.html">
177 <img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
178 </a>1.3.3 </small></address>
179 </body>
180 </html>