]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/module-doc/connection_8h-source.html
Added extra docs to cover OnUserSync etc
[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>connection.h Source File</title>
4 <link href="inspircd.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.3-rc3 -->
7 <center>
8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
9 <hr><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>
10 00002 <span class="comment"></span>
11 00003 <span class="comment">*/</span>
12 00004 
13 00005 <span class="preprocessor">#include "inspircd_config.h"</span>
14 00006 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
15 00007 <span class="preprocessor">#include &lt;string&gt;</span>
16 00008 <span class="preprocessor">#include &lt;map&gt;</span>
17 00009 <span class="preprocessor">#include &lt;sys/socket.h&gt;</span>
18 00010 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
19 00011 <span class="preprocessor">#include &lt;netdb.h&gt;</span>
20 00012 <span class="preprocessor">#include &lt;netinet/in.h&gt;</span>
21 00013 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
22 00014 <span class="preprocessor">#include &lt;errno.h&gt;</span>
23 00015 <span class="preprocessor">#include &lt;time.h&gt;</span>
24 00016 <span class="preprocessor">#include &lt;vector&gt;</span>
25 00017 <span class="preprocessor">#include &lt;deque&gt;</span>
26 00018 
27 00019 <span class="preprocessor">#ifndef __CONNECTION_H__</span>
28 00020 <span class="preprocessor"></span><span class="preprocessor">#define __CONNECTION_H__</span>
29 00021 <span class="preprocessor"></span>
30 <a name="l00022"></a><a class="code" href="connection_8h.html#a0">00022</a> <span class="preprocessor">#define STATE_DISCONNECTED      0</span>
31 <a name="l00023"></a><a class="code" href="connection_8h.html#a1">00023</a> <span class="preprocessor"></span><span class="preprocessor">#define STATE_CONNECTED         1</span>
32 <a name="l00024"></a><a class="code" href="connection_8h.html#a2">00024</a> <span class="preprocessor"></span><span class="preprocessor">#define STATE_SYNC              2</span>
33 <a name="l00025"></a><a class="code" href="connection_8h.html#a3">00025</a> <span class="preprocessor"></span><span class="preprocessor">#define STATE_NOAUTH_INBOUND    3</span>
34 <a name="l00026"></a><a class="code" href="connection_8h.html#a4">00026</a> <span class="preprocessor"></span><span class="preprocessor">#define STATE_NOAUTH_OUTBOUND   4</span>
35 <a name="l00027"></a><a class="code" href="connection_8h.html#a5">00027</a> <span class="preprocessor"></span><span class="preprocessor">#define STATE_SERVICES          5</span>
36 00028 <span class="preprocessor"></span>
37 <a name="l00041"></a><a class="code" href="classircd__connector.html">00041</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>
38 00042 {
39 00043  <span class="keyword">private</span>:
40 <a name="l00046"></a><a class="code" href="classircd__connector.html#o0">00046</a>         sockaddr_in <a class="code" href="classircd__connector.html#o0">addr</a>;
41 00047         
42 <a name="l00050"></a><a class="code" href="classircd__connector.html#o1">00050</a>         <span class="keywordtype">int</span> <a class="code" href="classircd__connector.html#o1">fd</a>;
43 00051         
44 <a name="l00054"></a><a class="code" href="classircd__connector.html#o2">00054</a>         std::string <a class="code" href="classircd__connector.html#o2">servername</a>;
45 00055         
46 <a name="l00058"></a><a class="code" href="classircd__connector.html#o3">00058</a>         std::string <a class="code" href="classircd__connector.html#o3">description</a>;
47 00059         
48 <a name="l00063"></a><a class="code" href="classircd__connector.html#o4">00063</a>         <span class="keywordtype">int</span> <a class="code" href="classircd__connector.html#o4">state</a>;
49 00064         
50 00067         <span class="keywordtype">bool</span> <a class="code" href="classircd__connector.html#c0">SetHostAddress</a>(<span class="keywordtype">char</span>* host, <span class="keywordtype">int</span> port);
51 00068 
52 00069  <span class="keyword">public</span>:
53 00070  
54 <a name="l00075"></a><a class="code" href="classircd__connector.html#m0">00075</a>         <span class="keywordtype">char</span> <a class="code" href="classircd__connector.html#m0">host</a>[MAXBUF];
55 00076 
56 <a name="l00081"></a><a class="code" href="classircd__connector.html#m1">00081</a>         <span class="keywordtype">int</span> <a class="code" href="classircd__connector.html#m1">port</a>;
57 00082         
58 <a name="l00087"></a><a class="code" href="classircd__connector.html#m2">00087</a>         std::vector&lt;std::string&gt; <a class="code" href="classircd__connector.html#m2">routes</a>;
59 00088         
60 00089 
61 00092         <span class="keywordtype">bool</span> <a class="code" href="classircd__connector.html#a0">MakeOutboundConnection</a>(<span class="keywordtype">char</span>* host, <span class="keywordtype">int</span> port);
62 00093         
63 00096         std::string <a class="code" href="classircd__connector.html#a1">GetServerName</a>();
64 00097         
65 00100         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a2">SetServerName</a>(std::string serv);
66 00101         
67 00104         <span class="keywordtype">int</span> <a class="code" href="classircd__connector.html#a3">GetDescriptor</a>();
68 00105         
69 00108         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a4">SetDescriptor</a>(<span class="keywordtype">int</span> fd);
70 00109         
71 00112         <span class="keywordtype">int</span> <a class="code" href="classircd__connector.html#a5">GetState</a>();
72 00113         
73 00116         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a6">SetState</a>(<span class="keywordtype">int</span> state);
74 00117         
75 00120         <span class="keywordtype">char</span>* <a class="code" href="classircd__connector.html#a7">GetServerIP</a>();
76 00121         
77 00124         std::string <a class="code" href="classircd__connector.html#a8">GetDescription</a>();
78 00125         
79 00128         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a9">SetDescription</a>(std::string desc);
80 00129         
81 00135         <span class="keywordtype">int</span> <a class="code" href="classircd__connector.html#a10">GetServerPort</a>();
82 00136         
83 00139         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a11">SetServerPort</a>(<span class="keywordtype">int</span> p);
84 00140         
85 00143         <span class="keywordtype">bool</span> <a class="code" href="classircd__connector.html#a12">SetHostAndPort</a>(<span class="keywordtype">char</span>* host, <span class="keywordtype">int</span> port);
86 00144         
87 00148         <span class="keywordtype">void</span> <a class="code" href="classircd__connector.html#a13">CloseConnection</a>();
88 00149 };
89 00150 
90 00151 
91 <a name="l00155"></a><a class="code" href="classpacket.html">00155</a> <span class="keyword">class </span><a class="code" href="classpacket.html">packet</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
92 00156 {
93 00157 };
94 00158 
95 <a name="l00161"></a><a class="code" href="classconnection.html">00161</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>
96 00162 {
97 00163  <span class="keyword">public</span>:
98 <a name="l00166"></a><a class="code" href="classconnection.html#m0">00166</a>         <span class="keywordtype">int</span> <a class="code" href="classconnection.html#m0">fd</a>;
99 00167         
100 <a name="l00170"></a><a class="code" href="classconnection.html#m1">00170</a>         <span class="keywordtype">char</span> <a class="code" href="classconnection.html#m1">host</a>[256];
101 00171         
102 <a name="l00174"></a><a class="code" href="classconnection.html#m2">00174</a>         <span class="keywordtype">char</span> <a class="code" href="classconnection.html#m2">ip</a>[32];
103 00175         
104 <a name="l00178"></a><a class="code" href="classconnection.html#m3">00178</a>         <span class="keywordtype">char</span> <a class="code" href="classconnection.html#m3">inbuf</a>[MAXBUF];
105 00179         
106 <a name="l00182"></a><a class="code" href="classconnection.html#m4">00182</a>         <span class="keywordtype">long</span> <a class="code" href="classconnection.html#m4">bytes_in</a>;
107 00183 
108 <a name="l00186"></a><a class="code" href="classconnection.html#m5">00186</a>         <span class="keywordtype">long</span> <a class="code" href="classconnection.html#m5">bytes_out</a>;
109 00187 
110 <a name="l00190"></a><a class="code" href="classconnection.html#m6">00190</a>         <span class="keywordtype">long</span> <a class="code" href="classconnection.html#m6">cmds_in</a>;
111 00191 
112 <a name="l00194"></a><a class="code" href="classconnection.html#m7">00194</a>         <span class="keywordtype">long</span> <a class="code" href="classconnection.html#m7">cmds_out</a>;
113 00195 
114 <a name="l00198"></a><a class="code" href="classconnection.html#m8">00198</a>         <span class="keywordtype">bool</span> <a class="code" href="classconnection.html#m8">haspassed</a>;
115 00199 
116 <a name="l00204"></a><a class="code" href="classconnection.html#m9">00204</a>         <span class="keywordtype">int</span> <a class="code" href="classconnection.html#m9">port</a>;
117 00205         
118 <a name="l00208"></a><a class="code" href="classconnection.html#m10">00208</a>         <span class="keywordtype">int</span> <a class="code" href="classconnection.html#m10">registered</a>;
119 00209         
120 <a name="l00212"></a><a class="code" href="classconnection.html#m11">00212</a>         <span class="keywordtype">short</span> <span class="keywordtype">int</span> <a class="code" href="classconnection.html#m11">state</a>;
121 00213         
122 <a name="l00216"></a><a class="code" href="classconnection.html#m12">00216</a>         time_t <a class="code" href="classconnection.html#m12">lastping</a>;
123 00217         
124 <a name="l00220"></a><a class="code" href="classconnection.html#m13">00220</a>         time_t <a class="code" href="classconnection.html#m13">signon</a>;
125 00221         
126 <a name="l00224"></a><a class="code" href="classconnection.html#m14">00224</a>         time_t <a class="code" href="classconnection.html#m14">idle_lastmsg</a>;
127 00225         
128 <a name="l00228"></a><a class="code" href="classconnection.html#m15">00228</a>         time_t <a class="code" href="classconnection.html#m15">nping</a>;
129 00229         
130 <a name="l00232"></a><a class="code" href="classconnection.html#m16">00232</a>         <span class="keywordtype">char</span> <a class="code" href="classconnection.html#m16">internal_addr</a>[MAXBUF];
131 00233         
132 <a name="l00236"></a><a class="code" href="classconnection.html#m17">00236</a>         <span class="keywordtype">int</span> <a class="code" href="classconnection.html#m17">internal_port</a>;
133 00237 
134 <a name="l00241"></a><a class="code" href="classconnection.html#m18">00241</a>         std::vector&lt;ircd_connector&gt; <a class="code" href="classconnection.html#m18">connectors</a>;
135 00242         
136 00245         <a class="code" href="classconnection.html#a0">connection</a>();
137 00246         
138 00249         <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);
139 00250         
140 00253         <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);
141 00254         
142 00257         <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">long</span> cookie, <span class="keywordtype">char</span>* servername);
143 00258         
144 00261         <span class="keywordtype">void</span> <a class="code" href="classconnection.html#a4">TerminateLink</a>(<span class="keywordtype">char</span>* targethost);
145 00262         
146 00266         <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);
147 00267         
148 00272         <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);
149 00273         
150 00276         <a class="code" href="classircd__connector.html">ircd_connector</a>* <a class="code" href="classconnection.html#a7">FindHost</a>(std::string host);
151 00277         
152 00281         <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);
153 00282         
154 00285         <span class="keywordtype">long</span> <a class="code" href="classconnection.html#a9">GenKey</a>();
155 00286 };
156 00287 
157 00288 
158 00289 <span class="preprocessor">#endif</span>
159 00290 <span class="preprocessor"></span>
160 </pre></div><hr><address style="align: right;"><small>Generated on Sat May 1 17:50:06 2004 for InspIRCd by
161 <a href="http://www.doxygen.org/index.html">
162 <img src="doxygen.png" alt="doxygen" align="middle" border=0 
163 width=110 height=53></a>1.3-rc3 </small></address>
164 </body>
165 </html>