diff options
Diffstat (limited to 'docs/module-doc/classircd__connector.html')
| -rw-r--r-- | docs/module-doc/classircd__connector.html | 395 |
1 files changed, 205 insertions, 190 deletions
diff --git a/docs/module-doc/classircd__connector.html b/docs/module-doc/classircd__connector.html index c88a7a0da..5d2bd7d4f 100644 --- a/docs/module-doc/classircd__connector.html +++ b/docs/module-doc/classircd__connector.html @@ -1,96 +1,111 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> -<title>ircd_connector class Reference</title> +<title>InspIRCd: ircd_connector class Reference</title> <link href="inspircd.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.3-rc3 --> -<center> -<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> -<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. +<!-- Generated by Doxygen 1.3.3 --> +<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<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. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="connection_8h-source.html">connection.h</a>></code> <p> -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> -<map name="ircd__connector__inherit__map"> -<area href="classExtensible.html" shape="rect" coords="20,85,89,106" alt=""> -<area href="classclassbase.html" shape="rect" coords="21,16,88,37" alt=""> -</map> -<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> -<map name="ircd__connector__coll__map"> -<area href="classExtensible.html" shape="rect" coords="45,8,115,29" alt=""> -</map> -<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> +Inherits <a class="el" href="classExtensible.html">Extensible</a>. +<p> +<a href="classircd__connector-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> -<tr><td nowrap align=right valign=top>bool </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> -<tr><td> </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> -<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classircd__connector.html#a1">GetServerName</a> ()</td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classircd__connector.html#a2">SetServerName</a> (std::string serv)</td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classircd__connector.html#a3">GetDescriptor</a> ()</td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>void </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> -<tr><td> </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> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classircd__connector.html#a5">GetState</a> ()</td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>void </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> -<tr><td> </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> -<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="classircd__connector.html#a7">GetServerIP</a> ()</td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classircd__connector.html#a8">GetDescription</a> ()</td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classircd__connector.html#a9">SetDescription</a> (std::string desc)</td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classircd__connector.html#a10">GetServerPort</a> ()</td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classircd__connector.html#a11">SetServerPort</a> (int p)</td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>bool </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> -<tr><td> </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> -<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classircd__connector.html#a13">CloseConnection</a> ()</td></tr> -<tr><td> </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> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a0">MakeOutboundConnection</a> (char *<a class="el" href="classircd__connector.html#o0">host</a>, int <a class="el" href="classircd__connector.html#o1">port</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an outbound connection to a listening socket. </em> <a href="#a0"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a1">GetServerName</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the servername on this established connection. </em> <a href="#a1"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a2">SetServerName</a> (std::string serv)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the server name of this connection. </em> <a href="#a2"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a3">GetDescriptor</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the file descriptor associated with this connection. </em> <a href="#a3"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a4">SetDescriptor</a> (int <a class="el" href="classircd__connector.html#r1">fd</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the file descriptor for this connection. </em> <a href="#a4"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a5">GetState</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the state flags for this connection. </em> <a href="#a5"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a6">SetState</a> (int <a class="el" href="classircd__connector.html#r4">state</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the state flags for this connection. </em> <a href="#a6"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>char * </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a7">GetServerIP</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the ip address (not servername) associated with this connection. </em> <a href="#a7"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a8">GetDescription</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the server description of this connection. </em> <a href="#a8"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a9">SetDescription</a> (std::string desc)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the server description of this connection. </em> <a href="#a9"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a10">GetServerPort</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">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><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a11">SetServerPort</a> (int p)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the port used by this connection. </em> <a href="#a11"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a12">SetHostAndPort</a> (char *<a class="el" href="classircd__connector.html#o0">host</a>, int <a class="el" href="classircd__connector.html#o1">port</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set both the host and the port in one operation for this connection. </em> <a href="#a12"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a13">CloseConnection</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the connection by calling close() on its file descriptor This function call updates no other data. </em> <a href="#a13"></a><em><br><br></td></tr> <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr> -<tr><td nowrap align=right valign=top>char </td><td valign=bottom><a class="el" href="classircd__connector.html#m0">host</a> [MAXBUF]</td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classircd__connector.html#m1">port</a></td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>std::vector< std::string > </td><td valign=bottom><a class="el" href="classircd__connector.html#m2">routes</a></td></tr> -<tr><td> </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->B->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> +<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#o0">host</a> [MAXBUF]</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. </em> <a href="#o0"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#o1">port</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. </em> <a href="#o1"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::vector< std::string > </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#o2">routes</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classServer.html">Server</a> names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B. </em> <a href="#o2"></a><em><br><br></td></tr> <tr><td colspan=2><br><h2>Private Member Functions</h2></td></tr> -<tr><td nowrap align=right valign=top>bool </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> -<tr><td> </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> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#d0">SetHostAddress</a> (char *<a class="el" href="classircd__connector.html#o0">host</a>, int <a class="el" href="classircd__connector.html#o1">port</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">PRIVATE function to set the host address and port to connect to. </em> <a href="#d0"></a><em><br><br></td></tr> <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> -<tr><td nowrap align=right valign=top>sockaddr_in </td><td valign=bottom><a class="el" href="classircd__connector.html#o0">addr</a></td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classircd__connector.html#o1">fd</a></td></tr> -<tr><td> </td><td><font size=-1><em>File descriptor of the connection.</em> <a href="#o1"></a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classircd__connector.html#o2">servername</a></td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>std::string </td><td valign=bottom><a class="el" href="classircd__connector.html#o3">description</a></td></tr> -<tr><td> </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> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classircd__connector.html#o4">state</a></td></tr> -<tr><td> </td><td><font size=-1><em>State.</em> <a href="#o4"></a><em></em></font><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>sockaddr_in </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#r0">addr</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sockaddr of the outbound ip and port. </em> <a href="#r0"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#r1">fd</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">File descriptor of the connection. </em> <a href="#r1"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#r2">servername</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classServer.html">Server</a> name. </em> <a href="#r2"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#r3">description</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classServer.html">Server</a> 'GECOS'. </em> <a href="#r3"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#r4">state</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">State. </em> <a href="#r4"></a><em><br><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> -Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. +Each connection has one or more of these each represents ONE outbound connection to another ircd so each inbound has multiple outbounds. <p> 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. <p> <p> -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> +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>.<hr><h2>Member Function Documentation</h2> <a name="a13" doxytag="ircd_connector::CloseConnection"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ircd_connector::CloseConnection </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -106,21 +121,21 @@ Definition at line <a class="el" href="connection_8h-source.html#l00041">41</a> <td> <p> -Close the connection by calling close() on its file descriptor This function call updates no other data. +Close the connection by calling close() on its file descriptor This function call updates no other data. <p> </td> </tr> </table> <a name="a8" doxytag="ircd_connector::GetDescription"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> std::string ircd_connector::GetDescription </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -136,21 +151,21 @@ Close the connection by calling close() on its file descriptor This function cal <td> <p> -Get the server description of this connection. +Get the server description of this connection. <p> </td> </tr> </table> <a name="a3" doxytag="ircd_connector::GetDescriptor"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int ircd_connector::GetDescriptor </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -166,21 +181,21 @@ Get the server description of this connection. <td> <p> -Get the file descriptor associated with this connection. +Get the file descriptor associated with this connection. <p> </td> </tr> </table> <a name="a7" doxytag="ircd_connector::GetServerIP"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> char* ircd_connector::GetServerIP </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -196,21 +211,21 @@ Get the file descriptor associated with this connection. <td> <p> -Get the ip address (not servername) associated with this connection. +Get the ip address (not servername) associated with this connection. <p> </td> </tr> </table> <a name="a1" doxytag="ircd_connector::GetServerName"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> std::string ircd_connector::GetServerName </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -226,21 +241,21 @@ Get the ip address (not servername) associated with this connection. <td> <p> -Return the servername on this established connection. +Return the servername on this established connection. <p> </td> </tr> </table> <a name="a10" doxytag="ircd_connector::GetServerPort"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int ircd_connector::GetServerPort </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -256,21 +271,21 @@ Return the servername on this established connection. <td> <p> -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>. +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>. <p> </td> </tr> </table> <a name="a5" doxytag="ircd_connector::GetState"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int ircd_connector::GetState </td> <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -286,27 +301,27 @@ Get the port number being used for this connection If the connection is outbound <td> <p> -Get the state flags for this connection. +Get the state flags for this connection. <p> </td> </tr> </table> <a name="a0" doxytag="ircd_connector::MakeOutboundConnection"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool ircd_connector::MakeOutboundConnection </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">char * </td> - <td class="mdname" nowrap> <em>host</em>, </td> + <td class="mdname" nowrap> <em>host</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> - <td class="mdname" nowrap> <em>port</em></td> + <td class="mdname" nowrap> <em>port</em></td> </tr> <tr> <td></td> @@ -326,22 +341,22 @@ Get the state flags for this connection. <td> <p> -Create an outbound connection to a listening socket. +Create an outbound connection to a listening socket. <p> </td> </tr> </table> <a name="a9" doxytag="ircd_connector::SetDescription"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ircd_connector::SetDescription </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">std::string </td> - <td class="mdname1" valign="top" nowrap> <em>desc</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>desc</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -357,22 +372,22 @@ Create an outbound connection to a listening socket. <td> <p> -Set the server description of this connection. +Set the server description of this connection. <p> </td> </tr> </table> <a name="a4" doxytag="ircd_connector::SetDescriptor"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ircd_connector::SetDescriptor </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> - <td class="mdname1" valign="top" nowrap> <em>fd</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>fd</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -388,27 +403,27 @@ Set the server description of this connection. <td> <p> -Set the file descriptor for this connection. +Set the file descriptor for this connection. <p> </td> </tr> </table> -<a name="c0" doxytag="ircd_connector::SetHostAddress"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="d0" doxytag="ircd_connector::SetHostAddress"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool ircd_connector::SetHostAddress </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">char * </td> - <td class="mdname" nowrap> <em>host</em>, </td> + <td class="mdname" nowrap> <em>host</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> - <td class="mdname" nowrap> <em>port</em></td> + <td class="mdname" nowrap> <em>port</em></td> </tr> <tr> <td></td> @@ -428,27 +443,27 @@ Set the file descriptor for this connection. <td> <p> -PRIVATE function to set the host address and port to connect to. +PRIVATE function to set the host address and port to connect to. <p> </td> </tr> </table> <a name="a12" doxytag="ircd_connector::SetHostAndPort"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool ircd_connector::SetHostAndPort </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">char * </td> - <td class="mdname" nowrap> <em>host</em>, </td> + <td class="mdname" nowrap> <em>host</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>int </td> - <td class="mdname" nowrap> <em>port</em></td> + <td class="mdname" nowrap> <em>port</em></td> </tr> <tr> <td></td> @@ -468,22 +483,22 @@ PRIVATE function to set the host address and port to connect to. <td> <p> -Set both the host and the port in one operation for this connection. +Set both the host and the port in one operation for this connection. <p> </td> </tr> </table> <a name="a2" doxytag="ircd_connector::SetServerName"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ircd_connector::SetServerName </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">std::string </td> - <td class="mdname1" valign="top" nowrap> <em>serv</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>serv</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -499,22 +514,22 @@ Set both the host and the port in one operation for this connection. <td> <p> -Set the server name of this connection. +Set the server name of this connection. <p> </td> </tr> </table> <a name="a11" doxytag="ircd_connector::SetServerPort"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ircd_connector::SetServerPort </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> - <td class="mdname1" valign="top" nowrap> <em>p</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>p</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -530,22 +545,22 @@ Set the server name of this connection. <td> <p> -Set the port used by this connection. +Set the port used by this connection. <p> </td> </tr> </table> <a name="a6" doxytag="ircd_connector::SetState"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void ircd_connector::SetState </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">int </td> - <td class="mdname1" valign="top" nowrap> <em>state</em> </td> - <td class="md" valign="top">) </td> + <td class="mdname1" valign="top" nowrap> <em>state</em> </td> + <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -561,19 +576,19 @@ Set the port used by this connection. <td> <p> -Set the state flags for this connection. +Set the state flags for this connection. <p> </td> </tr> </table> <hr><h2>Member Data Documentation</h2> -<a name="o0" doxytag="ircd_connector::addr"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="r0" doxytag="ircd_connector::addr"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> sockaddr_in ircd_connector::addr<code> [private]</code> + <td class="md" nowrap valign="top"> sockaddr_in <a class="el" href="classircd__connector.html#r0">ircd_connector::addr</a><code> [private]</code> </table> </td> </tr> @@ -586,20 +601,20 @@ Set the state flags for this connection. <td> <p> -Sockaddr of the outbound ip and port. +Sockaddr of the outbound ip and port. <p> <p> -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> +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> </tr> </table> -<a name="o3" doxytag="ircd_connector::description"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="r3" doxytag="ircd_connector::description"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> std::string ircd_connector::description<code> [private]</code> + <td class="md" nowrap valign="top"> std::string <a class="el" href="classircd__connector.html#r3">ircd_connector::description</a><code> [private]</code> </table> </td> </tr> @@ -612,20 +627,20 @@ Definition at line <a class="el" href="connection_8h-source.html#l00046">46</a> <td> <p> -<a class="el" href="classServer.html">Server</a> 'GECOS'. +<a class="el" href="classServer.html">Server</a> 'GECOS'. <p> <p> -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> +Definition at line <a class="el" href="connection_8h-source.html#l00070">70</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> </tr> </table> -<a name="o1" doxytag="ircd_connector::fd"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="r1" doxytag="ircd_connector::fd"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> int ircd_connector::fd<code> [private]</code> + <td class="md" nowrap valign="top"> int <a class="el" href="classircd__connector.html#r1">ircd_connector::fd</a><code> [private]</code> </table> </td> </tr> @@ -638,20 +653,20 @@ Definition at line <a class="el" href="connection_8h-source.html#l00058">58</a> <td> <p> -File descriptor of the connection. +File descriptor of the connection. <p> <p> -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> +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> </tr> </table> -<a name="m0" doxytag="ircd_connector::host"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="o0" doxytag="ircd_connector::host"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> char ircd_connector::host[MAXBUF] + <td class="md" nowrap valign="top"> char <a class="el" href="classircd__connector.html#o0">ircd_connector::host</a>[MAXBUF] </table> </td> </tr> @@ -664,20 +679,20 @@ Definition at line <a class="el" href="connection_8h-source.html#l00050">50</a> <td> <p> -When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. +When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. <p> <p> -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> +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> </tr> </table> -<a name="m1" doxytag="ircd_connector::port"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="o1" doxytag="ircd_connector::port"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> int ircd_connector::port + <td class="md" nowrap valign="top"> int <a class="el" href="classircd__connector.html#o1">ircd_connector::port</a> </table> </td> </tr> @@ -690,20 +705,20 @@ Definition at line <a class="el" href="connection_8h-source.html#l00075">75</a> <td> <p> -When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. +When MakeOutboundConnection is called, these public members are filled with the details passed to the function, for future reference. <p> <p> -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> +Definition at line <a class="el" href="connection_8h-source.html#l00093">93</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> </tr> </table> -<a name="m2" doxytag="ircd_connector::routes"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="o2" doxytag="ircd_connector::routes"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> std::vector<std::string> ircd_connector::routes + <td class="md" nowrap valign="top"> std::vector<std::string> <a class="el" href="classircd__connector.html#o2">ircd_connector::routes</a> </table> </td> </tr> @@ -716,20 +731,20 @@ Definition at line <a class="el" href="connection_8h-source.html#l00081">81</a> <td> <p> -<a class="el" href="classServer.html">Server</a> names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B. +<a class="el" href="classServer.html">Server</a> names of servers that this server is linked to So for A->B->C, if this was the record for B it would contain A and C whilever both servers are connected to B. <p> <p> -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> +Definition at line <a class="el" href="connection_8h-source.html#l00099">99</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> </tr> </table> -<a name="o2" doxytag="ircd_connector::servername"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="r2" doxytag="ircd_connector::servername"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> std::string ircd_connector::servername<code> [private]</code> + <td class="md" nowrap valign="top"> std::string <a class="el" href="classircd__connector.html#r2">ircd_connector::servername</a><code> [private]</code> </table> </td> </tr> @@ -742,20 +757,20 @@ Definition at line <a class="el" href="connection_8h-source.html#l00087">87</a> <td> <p> -<a class="el" href="classServer.html">Server</a> name. +<a class="el" href="classServer.html">Server</a> name. <p> <p> -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> +Definition at line <a class="el" href="connection_8h-source.html#l00066">66</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> </tr> </table> -<a name="o4" doxytag="ircd_connector::state"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> +<a name="r4" doxytag="ircd_connector::state"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> - <td class="md"> + <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> int ircd_connector::state<code> [private]</code> + <td class="md" nowrap valign="top"> int <a class="el" href="classircd__connector.html#r4">ircd_connector::state</a><code> [private]</code> </table> </td> </tr> @@ -768,18 +783,18 @@ Definition at line <a class="el" href="connection_8h-source.html#l00054">54</a> <td> <p> -State. +State. <p> STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTED, STATE_CONNECTED <p> -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> +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> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="connection_8h-source.html">connection.h</a></ul> -<hr><address style="align: right;"><small>Generated on Sun May 2 00:09:39 2004 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> -<img src="doxygen.png" alt="doxygen" align="middle" border=0 -width=110 height=53></a>1.3-rc3 </small></address> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.3 </small></address> </body> </html> |