diff options
Diffstat (limited to 'docs/module-doc/classircd__connector.html')
| -rw-r--r-- | docs/module-doc/classircd__connector.html | 204 |
1 files changed, 177 insertions, 27 deletions
diff --git a/docs/module-doc/classircd__connector.html b/docs/module-doc/classircd__connector.html index 6a366234b..a5acb44f1 100644 --- a/docs/module-doc/classircd__connector.html +++ b/docs/module-doc/classircd__connector.html @@ -15,7 +15,7 @@ Inherits <a class="el" href="classExtensible.html">Extensible</a>. <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 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="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a0">MakeOutboundConnection</a> (char *newhost, int newport)</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> @@ -51,24 +51,35 @@ Inherits <a class="el" href="classExtensible.html">Extensible</a>. <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="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a12">SetHostAndPort</a> (char *newhost, int newport)</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 class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a14">AddBuffer</a> (std::string a)</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#a15">BufferIsComplete</a> ()</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#a16">ClearBuffer</a> ()</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#a17">GetBuffer</a> ()</td></tr> + <tr><td colspan=2><br><h2>Public Attributes</h2></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="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#o0">ircdbuffer</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="#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">IRCD Buffer for input characters, holds one line. </em> <a href="#o0"></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#o1">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="#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="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#o2">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="#o2"></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#o3">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 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="#o3"></a><em><br><br></td></tr> <tr><td colspan=2><br><h2>Private Member Functions</h2></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="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#o1">host</a>, int <a class="el" href="classircd__connector.html#o2">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> @@ -95,7 +106,92 @@ A listening socket that accepts server type connections is represented by one cl <p> <p> -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> +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>.<hr><h2>Member Function Documentation</h2> +<a name="a14" doxytag="ircd_connector::AddBuffer"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void ircd_connector::AddBuffer </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string </td> + <td class="mdname1" valign="top" nowrap> <em>a</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a name="a15" doxytag="ircd_connector::BufferIsComplete"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> bool ircd_connector::BufferIsComplete </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> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> +<a name="a16" doxytag="ircd_connector::ClearBuffer"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void ircd_connector::ClearBuffer </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> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> <a name="a13" doxytag="ircd_connector::CloseConnection"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> @@ -126,6 +222,34 @@ Close the connection by calling close() on its file descriptor This function cal </td> </tr> </table> +<a name="a17" doxytag="ircd_connector::GetBuffer"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string ircd_connector::GetBuffer </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> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + </td> + </tr> +</table> <a name="a8" doxytag="ircd_connector::GetDescription"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> @@ -315,13 +439,13 @@ Get the state flags for this connection. <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>newhost</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>newport</em></td> </tr> <tr> <td></td> @@ -457,13 +581,13 @@ PRIVATE function to set the host address and port to connect to. <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>newhost</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>newport</em></td> </tr> <tr> <td></td> @@ -605,7 +729,7 @@ Sockaddr of the outbound ip and port. <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#l00059">59</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> </tr> </table> <a name="r3" doxytag="ircd_connector::description"></a><p> @@ -631,7 +755,7 @@ Definition at line <a class="el" href="connection_8h-source.html#l00058">58</a> <p> <p> -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> +Definition at line <a class="el" href="connection_8h-source.html#l00071">71</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> </tr> </table> <a name="r1" doxytag="ircd_connector::fd"></a><p> @@ -657,16 +781,16 @@ File descriptor of the connection. <p> <p> -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> +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> </tr> </table> -<a name="o0" doxytag="ircd_connector::host"></a><p> +<a name="o1" doxytag="ircd_connector::host"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> char <a class="el" href="classircd__connector.html#o0">ircd_connector::host</a>[MAXBUF] + <td class="md" nowrap valign="top"> char <a class="el" href="classircd__connector.html#o1">ircd_connector::host</a>[MAXBUF] </table> </td> </tr> @@ -683,16 +807,42 @@ When MakeOutboundConnection is called, these public members are filled with the <p> <p> +Definition at line <a class="el" href="connection_8h-source.html#l00094">94</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> + </tr> +</table> +<a name="o0" doxytag="ircd_connector::ircdbuffer"></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> std::string <a class="el" href="classircd__connector.html#o0">ircd_connector::ircdbuffer</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +IRCD Buffer for input characters, holds one line. +<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> </tr> </table> -<a name="o1" doxytag="ircd_connector::port"></a><p> +<a name="o2" doxytag="ircd_connector::port"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> int <a class="el" href="classircd__connector.html#o1">ircd_connector::port</a> + <td class="md" nowrap valign="top"> int <a class="el" href="classircd__connector.html#o2">ircd_connector::port</a> </table> </td> </tr> @@ -709,16 +859,16 @@ When MakeOutboundConnection is called, these public members are filled with the <p> <p> -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> +Definition at line <a class="el" href="connection_8h-source.html#l00100">100</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> </tr> </table> -<a name="o2" doxytag="ircd_connector::routes"></a><p> +<a name="o3" doxytag="ircd_connector::routes"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> std::vector<std::string> <a class="el" href="classircd__connector.html#o2">ircd_connector::routes</a> + <td class="md" nowrap valign="top"> std::vector<std::string> <a class="el" href="classircd__connector.html#o3">ircd_connector::routes</a> </table> </td> </tr> @@ -735,7 +885,7 @@ Definition at line <a class="el" href="connection_8h-source.html#l00093">93</a> <p> <p> -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> +Definition at line <a class="el" href="connection_8h-source.html#l00106">106</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> </tr> </table> <a name="r2" doxytag="ircd_connector::servername"></a><p> @@ -761,7 +911,7 @@ Definition at line <a class="el" href="connection_8h-source.html#l00099">99</a> <p> <p> -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> +Definition at line <a class="el" href="connection_8h-source.html#l00067">67</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> </tr> </table> <a name="r4" doxytag="ircd_connector::state"></a><p> @@ -787,12 +937,12 @@ 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#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#l00076">76</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 size="1"><address style="align: right;"><small>Generated on Wed Apr 20 15:47:04 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Tue Apr 26 17:11:48 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.3 </small></address> |