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