diff options
Diffstat (limited to 'docs/module-doc/classircd__connector.html')
| -rw-r--r-- | docs/module-doc/classircd__connector.html | 128 |
1 files changed, 119 insertions, 9 deletions
diff --git a/docs/module-doc/classircd__connector.html b/docs/module-doc/classircd__connector.html index a5acb44f1..b0027cdda 100644 --- a/docs/module-doc/classircd__connector.html +++ b/docs/module-doc/classircd__connector.html @@ -59,16 +59,27 @@ Inherits <a class="el" href="classExtensible.html">Extensible</a>. <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="mdescLeft"> </td><td class="mdescRight">This method adds text to the ircd connection's buffer There is no limitation on how much text of what line width may be added to this buffer. </em> <a href="#a14"></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#a15">BufferIsComplete</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This method returns true if the buffer contains at least one carriage return character, e.g. </em> <a href="#a15"></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#a16">ClearBuffer</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This method clears the server's buffer by setting it to an empty string. </em> <a href="#a16"></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#a17">GetBuffer</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This method retrieves the first string from the tail end of the buffer and advances the tail end of the buffer past the returned string, in a similar manner to strtok(). </em> <a href="#a17"></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#a18">SetVersionString</a> (std::string newversion)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This method sets the version string of the remote server. </em> <a href="#a18"></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#a19">GetVersionString</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This method returns the version string of the remote server. </em> <a href="#a19"></a><em><br><br></td></tr> <tr><td colspan=2><br><h2>Public Attributes</h2></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">IRCD Buffer for input characters, holds one line. </em> <a href="#o0"></a><em><br><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">IRCD Buffer for input characters, holds as many lines as are pending - Note that the final line may not be complete and should only be read when there is a <br> + seperator. </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> @@ -98,6 +109,9 @@ Inherits <a class="el" href="classExtensible.html">Extensible</a>. <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> +<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#r5">version</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This string holds the ircd's version response. </em> <a href="#r5"></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. @@ -133,7 +147,9 @@ Definition at line <a class="el" href="connection_8h-source.html#l00054">54</a> <td> <p> - </td> +This method adds text to the ircd connection's buffer There is no limitation on how much text of what line width may be added to this buffer. +<p> +It is the sending server's responsibility to ensure sent data is kept within reasonable quanities. </td> </tr> </table> <a name="a15" doxytag="ircd_connector::BufferIsComplete"></a><p> @@ -161,7 +177,9 @@ Definition at line <a class="el" href="connection_8h-source.html#l00054">54</a> <td> <p> - </td> +This method returns true if the buffer contains at least one carriage return character, e.g. +<p> +one line can be read from the buffer successfully. </td> </tr> </table> <a name="a16" doxytag="ircd_connector::ClearBuffer"></a><p> @@ -189,6 +207,8 @@ Definition at line <a class="el" href="connection_8h-source.html#l00054">54</a> <td> <p> +This method clears the server's buffer by setting it to an empty string. +<p> </td> </tr> </table> @@ -247,6 +267,8 @@ Close the connection by calling close() on its file descriptor This function cal <td> <p> +This method retrieves the first string from the tail end of the buffer and advances the tail end of the buffer past the returned string, in a similar manner to strtok(). +<p> </td> </tr> </table> @@ -430,6 +452,36 @@ Get the state flags for this connection. </td> </tr> </table> +<a name="a19" doxytag="ircd_connector::GetVersionString"></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::GetVersionString </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> +This method returns the version string of the remote server. +<p> +If the server has no version string an empty string is returned. </td> + </tr> +</table> <a name="a0" doxytag="ircd_connector::MakeOutboundConnection"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> @@ -705,6 +757,37 @@ Set the state flags for this connection. </td> </tr> </table> +<a name="a18" doxytag="ircd_connector::SetVersionString"></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::SetVersionString </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">std::string </td> + <td class="mdname1" valign="top" nowrap> <em>newversion</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> +This method sets the version string of the remote server. +<p> + </td> + </tr> +</table> <hr><h2>Member Data Documentation</h2> <a name="r0" doxytag="ircd_connector::addr"></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> @@ -807,7 +890,7 @@ 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> +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="o0" doxytag="ircd_connector::ircdbuffer"></a><p> @@ -829,11 +912,12 @@ Definition at line <a class="el" href="connection_8h-source.html#l00094">94</a> <td> <p> -IRCD Buffer for input characters, holds one line. +IRCD Buffer for input characters, holds as many lines as are pending - Note that the final line may not be complete and should only be read when there is a <br> + seperator. <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#l00092">92</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> </tr> </table> <a name="o2" doxytag="ircd_connector::port"></a><p> @@ -859,7 +943,7 @@ When MakeOutboundConnection is called, these public members are filled with the <p> <p> -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> +Definition at line <a class="el" href="connection_8h-source.html#l00105">105</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> </tr> </table> <a name="o3" doxytag="ircd_connector::routes"></a><p> @@ -885,7 +969,7 @@ Definition at line <a class="el" href="connection_8h-source.html#l00100">100</a> <p> <p> -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> +Definition at line <a class="el" href="connection_8h-source.html#l00111">111</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> @@ -940,9 +1024,35 @@ STATE_NOAUTH_INBOUND, STATE_NOAUTH_OUTBOUND STATE_SYNC, STATE_DISCONNECTED, STAT 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> +<a name="r5" doxytag="ircd_connector::version"></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#r5">ircd_connector::version</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This string holds the ircd's version response. +<p> + +<p> +Definition at line <a class="el" href="connection_8h-source.html#l00084">84</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 Tue Apr 26 17:11:48 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Sat May 7 15:34:25 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> |