docs/module-doc/classircd__connector.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>ircd_connector class Reference</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>ircd_connector Class Reference</h1>Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds.
  10 <a href="#_details">More...</a>
  11 <p>
  12 <code>#include &lt;<a class="el" href="connection_8h-source.html">connection.h</a>&gt;</code>
  13 <p>
  14 Inheritance diagram for ircd_connector:<p><center><img src="classircd__connector__inherit__graph.gif" border="0" usemap="#ircd__connector__inherit__map" alt="Inheritance graph"></center>
  15 <map name="ircd__connector__inherit__map">
  16 <area href="classExtensible.html" shape="rect" coords="20,85,89,106" alt="">
  17 <area href="classclassbase.html" shape="rect" coords="21,16,88,37" alt="">
  18 </map>
  19 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ircd_connector:<p><center><img src="classircd__connector__coll__graph.gif" border="0" usemap="#ircd__connector__coll__map" alt="Collaboration graph"></center>
  20 <map name="ircd__connector__coll__map">
  21 <area href="classExtensible.html" shape="rect" coords="45,8,115,29" alt="">
  22 </map>
  23 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classircd__connector-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  24 <tr><td></td></tr>
  25 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  26 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a0">MakeOutboundConnection</a> (char *<a class="el" href="classircd__connector.html#m0">host</a>, int <a class="el" href="classircd__connector.html#m1">port</a>)</td></tr>
  27 <tr><td>&nbsp;</td><td><font size=-1><em>Create an outbound connection to a listening socket.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
  28 <tr><td nowrap align=right valign=top>std::string&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a1">GetServerName</a> ()</td></tr>
  29 <tr><td>&nbsp;</td><td><font size=-1><em>Return the servername on this established connection.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
  30 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a2">SetServerName</a> (std::string serv)</td></tr>
  31 <tr><td>&nbsp;</td><td><font size=-1><em>Set the server name of this connection.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
  32 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a3">GetDescriptor</a> ()</td></tr>
  33 <tr><td>&nbsp;</td><td><font size=-1><em>Get the file descriptor associated with this connection.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
  34 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a4">SetDescriptor</a> (int <a class="el" href="classircd__connector.html#o1">fd</a>)</td></tr>
  35 <tr><td>&nbsp;</td><td><font size=-1><em>Set the file descriptor for this connection.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
  36 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a5">GetState</a> ()</td></tr>
  37 <tr><td>&nbsp;</td><td><font size=-1><em>Get the state flags for this connection.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
  38 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a6">SetState</a> (int <a class="el" href="classircd__connector.html#o4">state</a>)</td></tr>
  39 <tr><td>&nbsp;</td><td><font size=-1><em>Set the state flags for this connection.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
  40 <tr><td nowrap align=right valign=top>char *&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a7">GetServerIP</a> ()</td></tr>
  41 <tr><td>&nbsp;</td><td><font size=-1><em>Get the ip address (not servername) associated with this connection.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
  42 <tr><td nowrap align=right valign=top>std::string&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a8">GetDescription</a> ()</td></tr>
  43 <tr><td>&nbsp;</td><td><font size=-1><em>Get the server description of this connection.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
  44 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a9">SetDescription</a> (std::string desc)</td></tr>
  45 <tr><td>&nbsp;</td><td><font size=-1><em>Set the server description of this connection.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
  46 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a10">GetServerPort</a> ()</td></tr>
  47 <tr><td>&nbsp;</td><td><font size=-1><em>Get the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in <a class="el" href="classircd__connector.html#a7">GetServerIP()</a>.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
  48 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a11">SetServerPort</a> (int p)</td></tr>
  49 <tr><td>&nbsp;</td><td><font size=-1><em>Set the port used by this connection.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
  50 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a12">SetHostAndPort</a> (char *<a class="el" href="classircd__connector.html#m0">host</a>, int <a class="el" href="classircd__connector.html#m1">port</a>)</td></tr>
  51 <tr><td>&nbsp;</td><td><font size=-1><em>Set both the host and the port in one operation for this connection.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
  52 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#a13">CloseConnection</a> ()</td></tr>
  53 <tr><td>&nbsp;</td><td><font size=-1><em>Close the connection by calling close() on its file descriptor This function call updates no other data.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
  54 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  55 <tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#m0">host</a> [MAXBUF]</td></tr>
  56 <tr><td>&nbsp;</td><td><font size=-1><em>When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.</em> <a href="#m0"></a><em></em></font><br><br></td></tr>
  57 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#m1">port</a></td></tr>
  58 <tr><td>&nbsp;</td><td><font size=-1><em>When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.</em> <a href="#m1"></a><em></em></font><br><br></td></tr>
  59 <tr><td nowrap align=right valign=top>std::vector&lt; std::string &gt;&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#m2">routes</a></td></tr>
  60 <tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classServer.html">Server</a> names of servers that this server is linked to So for A-&gt;B-&gt;C, if this was the record for B it would contain A and C whilever both servers are connected to B.</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
  61 <tr><td colspan=2><br><h2>Private Member Functions</h2></td></tr>
  62 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#c0">SetHostAddress</a> (char *<a class="el" href="classircd__connector.html#m0">host</a>, int <a class="el" href="classircd__connector.html#m1">port</a>)</td></tr>
  63 <tr><td>&nbsp;</td><td><font size=-1><em>PRIVATE function to set the host address and port to connect to.</em> <a href="#c0"></a><em></em></font><br><br></td></tr>
  64 <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
  65 <tr><td nowrap align=right valign=top>sockaddr_in&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#o0">addr</a></td></tr>
  66 <tr><td>&nbsp;</td><td><font size=-1><em>Sockaddr of the outbound ip and port.</em> <a href="#o0"></a><em></em></font><br><br></td></tr>
  67 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#o1">fd</a></td></tr>
  68 <tr><td>&nbsp;</td><td><font size=-1><em>File descriptor of the connection.</em> <a href="#o1"></a><em></em></font><br><br></td></tr>
  69 <tr><td nowrap align=right valign=top>std::string&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#o2">servername</a></td></tr>
  70 <tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classServer.html">Server</a> name.</em> <a href="#o2"></a><em></em></font><br><br></td></tr>
  71 <tr><td nowrap align=right valign=top>std::string&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#o3">description</a></td></tr>
  72 <tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classServer.html">Server</a> 'GECOS'.</em> <a href="#o3"></a><em></em></font><br><br></td></tr>
  73 <tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classircd__connector.html#o4">state</a></td></tr>
  74 <tr><td>&nbsp;</td><td><font size=-1><em>State.</em> <a href="#o4"></a><em></em></font><br><br></td></tr>
  75 </table>
  76 <hr><a name="_details"></a><h2>Detailed Description</h2>
  77 Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds.
  78 <p>
  79 A listening socket that accepts server type connections is represented by one class serverrec. Class serverrec will instantiate several objects of type ircd_connector to represent each established connection, inbound or outbound. So, to determine all linked servers you must walk through all the serverrecs that the core defines, and in each one iterate through until you find connection(s) relating to the server you want information on. The core and module API provide functions for this.
  80 <p>
  81
  82 <p>
  83 Definition at line <a class="el" href="connection_8h-source.html#l00041">41</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.<hr><h2>Member Function Documentation</h2>
  84 <a name="a13" doxytag="ircd_connector::CloseConnection"></a><p>
  85 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  86   <tr>
  87     <td class="md">
  88       <table cellpadding="0" cellspacing="0" border="0">
  89         <tr>
  90           <td class="md" nowrap valign="top"> void ircd_connector::CloseConnection </td>
  91           <td class="md" valign="top">(&nbsp;</td>
  92           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  93           <td class="md" valign="top">)&nbsp;</td>
  94           <td class="md" nowrap></td>
  95         </tr>
  96
  97       </table>
  98     </td>
  99   </tr>
 100 </table>
 101 <table cellspacing=5 cellpadding=0 border=0>
 102   <tr>
 103     <td>
 104       &nbsp;
 105     </td>
 106     <td>
 107
 108 <p>
 109 Close the connection by calling close() on its file descriptor This function call updates no other data.
 110 <p>
 111     </td>
 112   </tr>
 113 </table>
 114 <a name="a8" doxytag="ircd_connector::GetDescription"></a><p>
 115 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 116   <tr>
 117     <td class="md">
 118       <table cellpadding="0" cellspacing="0" border="0">
 119         <tr>
 120           <td class="md" nowrap valign="top"> std::string ircd_connector::GetDescription </td>
 121           <td class="md" valign="top">(&nbsp;</td>
 122           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 123           <td class="md" valign="top">)&nbsp;</td>
 124           <td class="md" nowrap></td>
 125         </tr>
 126
 127       </table>
 128     </td>
 129   </tr>
 130 </table>
 131 <table cellspacing=5 cellpadding=0 border=0>
 132   <tr>
 133     <td>
 134       &nbsp;
 135     </td>
 136     <td>
 137
 138 <p>
 139 Get the server description of this connection.
 140 <p>
 141     </td>
 142   </tr>
 143 </table>
 144 <a name="a3" doxytag="ircd_connector::GetDescriptor"></a><p>
 145 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 146   <tr>
 147     <td class="md">
 148       <table cellpadding="0" cellspacing="0" border="0">
 149         <tr>
 150           <td class="md" nowrap valign="top"> int ircd_connector::GetDescriptor </td>
 151           <td class="md" valign="top">(&nbsp;</td>
 152           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 153           <td class="md" valign="top">)&nbsp;</td>
 154           <td class="md" nowrap></td>
 155         </tr>
 156
 157       </table>
 158     </td>
 159   </tr>
 160 </table>
 161 <table cellspacing=5 cellpadding=0 border=0>
 162   <tr>
 163     <td>
 164       &nbsp;
 165     </td>
 166     <td>
 167
 168 <p>
 169 Get the file descriptor associated with this connection.
 170 <p>
 171     </td>
 172   </tr>
 173 </table>
 174 <a name="a7" doxytag="ircd_connector::GetServerIP"></a><p>
 175 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 176   <tr>
 177     <td class="md">
 178       <table cellpadding="0" cellspacing="0" border="0">
 179         <tr>
 180           <td class="md" nowrap valign="top"> char* ircd_connector::GetServerIP </td>
 181           <td class="md" valign="top">(&nbsp;</td>
 182           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 183           <td class="md" valign="top">)&nbsp;</td>
 184           <td class="md" nowrap></td>
 185         </tr>
 186
 187       </table>
 188     </td>
 189   </tr>
 190 </table>
 191 <table cellspacing=5 cellpadding=0 border=0>
 192   <tr>
 193     <td>
 194       &nbsp;
 195     </td>
 196     <td>
 197
 198 <p>
 199 Get the ip address (not servername) associated with this connection.
 200 <p>
 201     </td>
 202   </tr>
 203 </table>
 204 <a name="a1" doxytag="ircd_connector::GetServerName"></a><p>
 205 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 206   <tr>
 207     <td class="md">
 208       <table cellpadding="0" cellspacing="0" border="0">
 209         <tr>
 210           <td class="md" nowrap valign="top"> std::string ircd_connector::GetServerName </td>
 211           <td class="md" valign="top">(&nbsp;</td>
 212           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 213           <td class="md" valign="top">)&nbsp;</td>
 214           <td class="md" nowrap></td>
 215         </tr>
 216
 217       </table>
 218     </td>
 219   </tr>
 220 </table>
 221 <table cellspacing=5 cellpadding=0 border=0>
 222   <tr>
 223     <td>
 224       &nbsp;
 225     </td>
 226     <td>
 227
 228 <p>
 229 Return the servername on this established connection.
 230 <p>
 231     </td>
 232   </tr>
 233 </table>
 234 <a name="a10" doxytag="ircd_connector::GetServerPort"></a><p>
 235 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 236   <tr>
 237     <td class="md">
 238       <table cellpadding="0" cellspacing="0" border="0">
 239         <tr>
 240           <td class="md" nowrap valign="top"> int ircd_connector::GetServerPort </td>
 241           <td class="md" valign="top">(&nbsp;</td>
 242           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 243           <td class="md" valign="top">)&nbsp;</td>
 244           <td class="md" nowrap></td>
 245         </tr>
 246
 247       </table>
 248     </td>
 249   </tr>
 250 </table>
 251 <table cellspacing=5 cellpadding=0 border=0>
 252   <tr>
 253     <td>
 254       &nbsp;
 255     </td>
 256     <td>
 257
 258 <p>
 259 Get the port number being used for this connection If the connection is outbound this will be the remote port otherwise it will be the local port, so it can always be gautanteed as open at the address given in <a class="el" href="classircd__connector.html#a7">GetServerIP()</a>.
 260 <p>
 261     </td>
 262   </tr>
 263 </table>
 264 <a name="a5" doxytag="ircd_connector::GetState"></a><p>
 265 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 266   <tr>
 267     <td class="md">
 268       <table cellpadding="0" cellspacing="0" border="0">
 269         <tr>
 270           <td class="md" nowrap valign="top"> int ircd_connector::GetState </td>
 271           <td class="md" valign="top">(&nbsp;</td>
 272           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 273           <td class="md" valign="top">)&nbsp;</td>
 274           <td class="md" nowrap></td>
 275         </tr>
 276
 277       </table>
 278     </td>
 279   </tr>
 280 </table>
 281 <table cellspacing=5 cellpadding=0 border=0>
 282   <tr>
 283     <td>
 284       &nbsp;
 285     </td>
 286     <td>
 287
 288 <p>
 289 Get the state flags for this connection.
 290 <p>
 291     </td>
 292   </tr>
 293 </table>
 294 <a name="a0" doxytag="ircd_connector::MakeOutboundConnection"></a><p>
 295 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 296   <tr>
 297     <td class="md">
 298       <table cellpadding="0" cellspacing="0" border="0">
 299         <tr>
 300           <td class="md" nowrap valign="top"> bool ircd_connector::MakeOutboundConnection </td>
 301           <td class="md" valign="top">(&nbsp;</td>
 302           <td class="md" nowrap valign="top">char *&nbsp;</td>
 303           <td class="mdname" nowrap>&nbsp; <em>host</em>, </td>
 304         </tr>
 305         <tr>
 306           <td></td>
 307           <td></td>
 308           <td class="md" nowrap>int&nbsp;</td>
 309           <td class="mdname" nowrap>&nbsp; <em>port</em></td>
 310         </tr>
 311         <tr>
 312           <td></td>
 313           <td class="md">)&nbsp;</td>
 314           <td class="md" colspan="2"></td>
 315         </tr>
 316
 317       </table>
 318     </td>
 319   </tr>
 320 </table>
 321 <table cellspacing=5 cellpadding=0 border=0>
 322   <tr>
 323     <td>
 324       &nbsp;
 325     </td>
 326     <td>
 327
 328 <p>
 329 Create an outbound connection to a listening socket.
 330 <p>
 331     </td>
 332   </tr>
 333 </table>
 334 <a name="a9" doxytag="ircd_connector::SetDescription"></a><p>
 335 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 336   <tr>
 337     <td class="md">
 338       <table cellpadding="0" cellspacing="0" border="0">
 339         <tr>
 340           <td class="md" nowrap valign="top"> void ircd_connector::SetDescription </td>
 341           <td class="md" valign="top">(&nbsp;</td>
 342           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 343           <td class="mdname1" valign="top" nowrap>&nbsp; <em>desc</em>          </td>
 344           <td class="md" valign="top">)&nbsp;</td>
 345           <td class="md" nowrap></td>
 346         </tr>
 347
 348       </table>
 349     </td>
 350   </tr>
 351 </table>
 352 <table cellspacing=5 cellpadding=0 border=0>
 353   <tr>
 354     <td>
 355       &nbsp;
 356     </td>
 357     <td>
 358
 359 <p>
 360 Set the server description of this connection.
 361 <p>
 362     </td>
 363   </tr>
 364 </table>
 365 <a name="a4" doxytag="ircd_connector::SetDescriptor"></a><p>
 366 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 367   <tr>
 368     <td class="md">
 369       <table cellpadding="0" cellspacing="0" border="0">
 370         <tr>
 371           <td class="md" nowrap valign="top"> void ircd_connector::SetDescriptor </td>
 372           <td class="md" valign="top">(&nbsp;</td>
 373           <td class="md" nowrap valign="top">int&nbsp;</td>
 374           <td class="mdname1" valign="top" nowrap>&nbsp; <em>fd</em>          </td>
 375           <td class="md" valign="top">)&nbsp;</td>
 376           <td class="md" nowrap></td>
 377         </tr>
 378
 379       </table>
 380     </td>
 381   </tr>
 382 </table>
 383 <table cellspacing=5 cellpadding=0 border=0>
 384   <tr>
 385     <td>
 386       &nbsp;
 387     </td>
 388     <td>
 389
 390 <p>
 391 Set the file descriptor for this connection.
 392 <p>
 393     </td>
 394   </tr>
 395 </table>
 396 <a name="c0" doxytag="ircd_connector::SetHostAddress"></a><p>
 397 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 398   <tr>
 399     <td class="md">
 400       <table cellpadding="0" cellspacing="0" border="0">
 401         <tr>
 402           <td class="md" nowrap valign="top"> bool ircd_connector::SetHostAddress </td>
 403           <td class="md" valign="top">(&nbsp;</td>
 404           <td class="md" nowrap valign="top">char *&nbsp;</td>
 405           <td class="mdname" nowrap>&nbsp; <em>host</em>, </td>
 406         </tr>
 407         <tr>
 408           <td></td>
 409           <td></td>
 410           <td class="md" nowrap>int&nbsp;</td>
 411           <td class="mdname" nowrap>&nbsp; <em>port</em></td>
 412         </tr>
 413         <tr>
 414           <td></td>
 415           <td class="md">)&nbsp;</td>
 416           <td class="md" colspan="2"><code> [private]</code></td>
 417         </tr>
 418
 419       </table>
 420     </td>
 421   </tr>
 422 </table>
 423 <table cellspacing=5 cellpadding=0 border=0>
 424   <tr>
 425     <td>
 426       &nbsp;
 427     </td>
 428     <td>
 429
 430 <p>
 431 PRIVATE function to set the host address and port to connect to.
 432 <p>
 433     </td>
 434   </tr>
 435 </table>
 436 <a name="a12" doxytag="ircd_connector::SetHostAndPort"></a><p>
 437 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 438   <tr>
 439     <td class="md">
 440       <table cellpadding="0" cellspacing="0" border="0">
 441         <tr>
 442           <td class="md" nowrap valign="top"> bool ircd_connector::SetHostAndPort </td>
 443           <td class="md" valign="top">(&nbsp;</td>
 444           <td class="md" nowrap valign="top">char *&nbsp;</td>
 445           <td class="mdname" nowrap>&nbsp; <em>host</em>, </td>
 446         </tr>
 447         <tr>
 448           <td></td>
 449           <td></td>
 450           <td class="md" nowrap>int&nbsp;</td>
 451           <td class="mdname" nowrap>&nbsp; <em>port</em></td>
 452         </tr>
 453         <tr>
 454           <td></td>
 455           <td class="md">)&nbsp;</td>
 456           <td class="md" colspan="2"></td>
 457         </tr>
 458
 459       </table>
 460     </td>
 461   </tr>
 462 </table>
 463 <table cellspacing=5 cellpadding=0 border=0>
 464   <tr>
 465     <td>
 466       &nbsp;
 467     </td>
 468     <td>
 469
 470 <p>
 471 Set both the host and the port in one operation for this connection.
 472 <p>
 473     </td>
 474   </tr>
 475 </table>
 476 <a name="a2" doxytag="ircd_connector::SetServerName"></a><p>
 477 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 478   <tr>
 479     <td class="md">
 480       <table cellpadding="0" cellspacing="0" border="0">
 481         <tr>
 482           <td class="md" nowrap valign="top"> void ircd_connector::SetServerName </td>
 483           <td class="md" valign="top">(&nbsp;</td>
 484           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 485           <td class="mdname1" valign="top" nowrap>&nbsp; <em>serv</em>          </td>
 486           <td class="md" valign="top">)&nbsp;</td>
 487           <td class="md" nowrap></td>
 488         </tr>
 489
 490       </table>
 491     </td>
 492   </tr>
 493 </table>
 494 <table cellspacing=5 cellpadding=0 border=0>
 495   <tr>
 496     <td>
 497       &nbsp;
 498     </td>
 499     <td>
 500
 501 <p>
 502 Set the server name of this connection.
 503 <p>
 504     </td>
 505   </tr>
 506 </table>
 507 <a name="a11" doxytag="ircd_connector::SetServerPort"></a><p>
 508 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 509   <tr>
 510     <td class="md">
 511       <table cellpadding="0" cellspacing="0" border="0">
 512         <tr>
 513           <td class="md" nowrap valign="top"> void ircd_connector::SetServerPort </td>
 514           <td class="md" valign="top">(&nbsp;</td>
 515           <td class="md" nowrap valign="top">int&nbsp;</td>
 516           <td class="mdname1" valign="top" nowrap>&nbsp; <em>p</em>          </td>
 517           <td class="md" valign="top">)&nbsp;</td>
 518           <td class="md" nowrap></td>
 519         </tr>
 520
 521       </table>
 522     </td>
 523   </tr>
 524 </table>
 525 <table cellspacing=5 cellpadding=0 border=0>
 526   <tr>
 527     <td>
 528       &nbsp;
 529     </td>
 530     <td>
 531
 532 <p>
 533 Set the port used by this connection.
 534 <p>
 535     </td>
 536   </tr>
 537 </table>
 538 <a name="a6" doxytag="ircd_connector::SetState"></a><p>
 539 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 540   <tr>
 541     <td class="md">
 542       <table cellpadding="0" cellspacing="0" border="0">
 543         <tr>
 544           <td class="md" nowrap valign="top"> void ircd_connector::SetState </td>
 545           <td class="md" valign="top">(&nbsp;</td>
 546           <td class="md" nowrap valign="top">int&nbsp;</td>
 547           <td class="mdname1" valign="top" nowrap>&nbsp; <em>state</em>          </td>
 548           <td class="md" valign="top">)&nbsp;</td>
 549           <td class="md" nowrap></td>
 550         </tr>
 551
 552       </table>
 553     </td>
 554   </tr>
 555 </table>
 556 <table cellspacing=5 cellpadding=0 border=0>
 557   <tr>
 558     <td>
 559       &nbsp;
 560     </td>
 561     <td>
 562
 563 <p>
 564 Set the state flags for this connection.
 565 <p>
 566     </td>
 567   </tr>
 568 </table>
 569 <hr><h2>Member Data Documentation</h2>
 570 <a name="o0" doxytag="ircd_connector::addr"></a><p>
 571 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 572   <tr>
 573     <td class="md">
 574       <table cellpadding="0" cellspacing="0" border="0">
 575         <tr>
 576           <td class="md" nowrap valign="top"> sockaddr_in ircd_connector::addr<code> [private]</code>
 577       </table>
 578     </td>
 579   </tr>
 580 </table>
 581 <table cellspacing=5 cellpadding=0 border=0>
 582   <tr>
 583     <td>
 584       &nbsp;
 585     </td>
 586     <td>
 587
 588 <p>
 589 Sockaddr of the outbound ip and port.
 590 <p>
 591
 592 <p>
 593 Definition at line <a class="el" href="connection_8h-source.html#l00046">46</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
 594   </tr>
 595 </table>
 596 <a name="o3" doxytag="ircd_connector::description"></a><p>
 597 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 598   <tr>
 599     <td class="md">
 600       <table cellpadding="0" cellspacing="0" border="0">
 601         <tr>
 602           <td class="md" nowrap valign="top"> std::string ircd_connector::description<code> [private]</code>
 603       </table>
 604     </td>
 605   </tr>
 606 </table>
 607 <table cellspacing=5 cellpadding=0 border=0>
 608   <tr>
 609     <td>
 610       &nbsp;
 611     </td>
 612     <td>
 613
 614 <p>
 615 <a class="el" href="classServer.html">Server</a> 'GECOS'.
 616 <p>
 617
 618 <p>
 619 Definition at line <a class="el" href="connection_8h-source.html#l00058">58</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
 620   </tr>
 621 </table>
 622 <a name="o1" doxytag="ircd_connector::fd"></a><p>
 623 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 624   <tr>
 625     <td class="md">
 626       <table cellpadding="0" cellspacing="0" border="0">
 627         <tr>
 628           <td class="md" nowrap valign="top"> int ircd_connector::fd<code> [private]</code>
 629       </table>
 630     </td>
 631   </tr>
 632 </table>
 633 <table cellspacing=5 cellpadding=0 border=0>
 634   <tr>
 635     <td>
 636       &nbsp;
 637     </td>
 638     <td>
 639
 640 <p>
 641 File descriptor of the connection.
 642 <p>
 643
 644 <p>
 645 Definition at line <a class="el" href="connection_8h-source.html#l00050">50</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
 646   </tr>
 647 </table>
 648 <a name="m0" doxytag="ircd_connector::host"></a><p>
 649 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 650   <tr>
 651     <td class="md">
 652       <table cellpadding="0" cellspacing="0" border="0">
 653         <tr>
 654           <td class="md" nowrap valign="top"> char ircd_connector::host[MAXBUF]
 655       </table>
 656     </td>
 657   </tr>
 658 </table>
 659 <table cellspacing=5 cellpadding=0 border=0>
 660   <tr>
 661     <td>
 662       &nbsp;
 663     </td>
 664     <td>
 665
 666 <p>
 667 When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.
 668 <p>
 669
 670 <p>
 671 Definition at line <a class="el" href="connection_8h-source.html#l00075">75</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
 672   </tr>
 673 </table>
 674 <a name="m1" doxytag="ircd_connector::port"></a><p>
 675 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 676   <tr>
 677     <td class="md">
 678       <table cellpadding="0" cellspacing="0" border="0">
 679         <tr>
 680           <td class="md" nowrap valign="top"> int ircd_connector::port
 681       </table>
 682     </td>
 683   </tr>
 684 </table>
 685 <table cellspacing=5 cellpadding=0 border=0>
 686   <tr>
 687     <td>
 688       &nbsp;
 689     </td>
 690     <td>
 691
 692 <p>
 693 When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference.
 694 <p>
 695
 696 <p>
 697 Definition at line <a class="el" href="connection_8h-source.html#l00081">81</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
 698   </tr>
 699 </table>
 700 <a name="m2" doxytag="ircd_connector::routes"></a><p>
 701 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 702   <tr>
 703     <td class="md">
 704       <table cellpadding="0" cellspacing="0" border="0">
 705         <tr>
 706           <td class="md" nowrap valign="top"> std::vector&lt;std::string&gt; ircd_connector::routes
 707       </table>
 708     </td>
 709   </tr>
 710 </table>
 711 <table cellspacing=5 cellpadding=0 border=0>
 712   <tr>
 713     <td>
 714       &nbsp;
 715     </td>
 716     <td>
 717
 718 <p>
 719 <a class="el" href="classServer.html">Server</a> names of servers that this server is linked to So for A-&gt;B-&gt;C, if this was the record for B it would contain A and C whilever both servers are connected to B.
 720 <p>
 721
 722 <p>
 723 Definition at line <a class="el" href="connection_8h-source.html#l00087">87</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
 724   </tr>
 725 </table>
 726 <a name="o2" doxytag="ircd_connector::servername"></a><p>
 727 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 728   <tr>
 729     <td class="md">
 730       <table cellpadding="0" cellspacing="0" border="0">
 731         <tr>
 732           <td class="md" nowrap valign="top"> std::string ircd_connector::servername<code> [private]</code>
 733       </table>
 734     </td>
 735   </tr>
 736 </table>
 737 <table cellspacing=5 cellpadding=0 border=0>
 738   <tr>
 739     <td>
 740       &nbsp;
 741     </td>
 742     <td>
 743
 744 <p>
 745 <a class="el" href="classServer.html">Server</a> name.
 746 <p>
 747
 748 <p>
 749 Definition at line <a class="el" href="connection_8h-source.html#l00054">54</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
 750   </tr>
 751 </table>
 752 <a name="o4" doxytag="ircd_connector::state"></a><p>
 753 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 754   <tr>
 755     <td class="md">
 756       <table cellpadding="0" cellspacing="0" border="0">
 757         <tr>
 758           <td class="md" nowrap valign="top"> int ircd_connector::state<code> [private]</code>
 759       </table>
 760     </td>
 761   </tr>
 762 </table>
 763 <table cellspacing=5 cellpadding=0 border=0>
 764   <tr>
 765     <td>
 766       &nbsp;
 767     </td>
 768     <td>
 769
 770 <p>
 771 State.
 772 <p>
 773 STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTED
 774 <p>
 775 Definition at line <a class="el" href="connection_8h-source.html#l00063">63</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.    </td>
 776   </tr>
 777 </table>
 778 <hr>The documentation for this class was generated from the following file:<ul>
 779 <li><a class="el" href="connection_8h-source.html">connection.h</a></ul>
 780 <hr><address style="align: right;"><small>Generated on Fri Apr 30 15:46:42 2004 for InspIRCd by
 781 <a href="http://www.doxygen.org/index.html">
 782 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 783 width=110 height=53></a>1.3-rc3 </small></address>
 784 </body>
 785 </html>