diff options
Diffstat (limited to 'docs/module-doc/classircd__connector.html')
| -rw-r--r-- | docs/module-doc/classircd__connector.html | 1542 |
1 files changed, 0 insertions, 1542 deletions
diff --git a/docs/module-doc/classircd__connector.html b/docs/module-doc/classircd__connector.html deleted file mode 100644 index 930a30da1..000000000 --- a/docs/module-doc/classircd__connector.html +++ /dev/null @@ -1,1542 +0,0 @@ -<!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>InspIRCd: ircd_connector class Reference</title> -<link href="inspircd.doxygen.css" rel="stylesheet" type="text/css"> -</head><body> -<!-- 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="namespacemembers.html">Namespace Members</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="21,82,103,109" alt=""> -<area href="classclassbase.html" shape="rect" coords="22,8,102,34" 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="37,8,120,34" 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> -<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> </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a0">ircd_connector</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor clears the sendq and initialises the fd to -1. </em> <a href="#a0"></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#a1">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="#a1"></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#a2">GetServerName</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the servername on this established connection. </em> <a href="#a2"></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#a3">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="#a3"></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#a4">GetDescriptor</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the file descriptor associated with this connection. </em> <a href="#a4"></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#a5">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="#a5"></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#a6">GetState</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get 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>void </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a7">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="#a7"></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#a8">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="#a8"></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#a9">GetDescription</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get 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>void </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#a10">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="#a10"></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#a11">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#a8">GetServerIP()</a>. </em> <a href="#a11"></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#a12">SetServerPort</a> (int p)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the port used by this connection. </em> <a href="#a12"></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#a13">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="#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">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="#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">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. </em> <a href="#a15"></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#a16">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="#a16"></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#a17">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="#a17"></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#a18">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="#a18"></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#a19">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="#a19"></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#a20">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="#a20"></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#a21">AddWriteBuf</a> (std::string data)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds data to the connection's sendQ to be flushed later. </em> <a href="#a21"></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#a22">FlushWriteBuf</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Flushes as much of the data from the buffer as possible, and advances the queue pointer to what is left. </em> <a href="#a22"></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#a23">SetWriteError</a> (std::string error)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the error string for this connection. </em> <a href="#a23"></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#a24">GetWriteError</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the error string for this connection. </em> <a href="#a24"></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#a25">HasBufferedOutput</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if there is data to be written that hasn't been sent yet. </em> <a href="#a25"></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#a26">CheckPing</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if the connection replied to its last ping, and if it did sends another and returns true, if not, returns false. </em> <a href="#a26"></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#a27">ResetPing</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets the ping counter. </em> <a href="#a27"></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 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> -<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="#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#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> -<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>char </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> -<tr><td class="memItemLeft" nowrap align=right valign=top>std::string </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#r6">sendq</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">SendQ of the outbound connector, does not have a limit. </em> <a href="#r6"></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#r7">WriteError</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Write error of connection. </em> <a href="#r7"></a><em><br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>time_t </td><td class="memItemRight" valign=bottom><a class="el" href="classircd__connector.html#r8">nextping</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Time this connection was last pinged. </em> <a href="#r8"></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#r9">replied</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Did this connection reply to its last ping? </em> <a href="#r9"></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. -<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#l00056">56</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> -<a name="a0" doxytag="ircd_connector::ircd_connector"></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"> ircd_connector::ircd_connector </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> -Constructor clears the sendq and initialises the fd to -1. -<p> - </td> - </tr> -</table> -<hr><h2>Member Function Documentation</h2> -<a name="a15" 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"> bool 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> -This method adds text to the ircd connection's buffer. -<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>a</em> </td><td>The text to add to the buffer up to a maximum size of 1MB</td></tr> - </table> -</dl> -This buffer's maximum size is one megabyte, the method returning false if the buffer is full.<p> -<dl compact><dt><b>Returns:</b></dt><dd>True on success, false if the buffer is full or the connection is down</dd></dl> - </td> - </tr> -</table> -<a name="a21" doxytag="ircd_connector::AddWriteBuf"></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::AddWriteBuf </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">std::string </td> - <td class="mdname1" valign="top" nowrap> <em>data</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> -Adds data to the connection's sendQ to be flushed later. -<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>data</em> </td><td>The data to add to the write buffer</td></tr> - </table> -</dl> -Fails if there is an error pending on the connection.<p> -<dl compact><dt><b>Returns:</b></dt><dd>True on success, false if the connection is down or the buffer is full</dd></dl> - -<p> -Referenced by <a class="el" href="servers_8cpp-source.html#l00350">serverrec::SendPacket()</a>. </td> - </tr> -</table> -<a name="a16" 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> -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.<p> -<dl compact><dt><b>Returns:</b></dt><dd>True if there is at least one complete line waiting to be processed</dd></dl> - </td> - </tr> -</table> -<a name="a26" doxytag="ircd_connector::CheckPing"></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::CheckPing </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> -Checks if the connection replied to its last ping, and if it did sends another and returns true, if not, returns false. -<p> -<dl compact><dt><b>Returns:</b></dt><dd>True if the server is still replying to pings</dd></dl> - </td> - </tr> -</table> -<a name="a17" 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> -This method clears the server's buffer by setting it to an empty string. -<p> - </td> - </tr> -</table> -<a name="a14" doxytag="ircd_connector::CloseConnection"></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::CloseConnection </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> -Close the connection by calling close() on its file descriptor This function call updates no other data. -<p> - -<p> -Referenced by <a class="el" href="servers_8cpp-source.html#l00350">serverrec::SendPacket()</a>. </td> - </tr> -</table> -<a name="a22" doxytag="ircd_connector::FlushWriteBuf"></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::FlushWriteBuf </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> -Flushes as much of the data from the buffer as possible, and advances the queue pointer to what is left. -<p> -<dl compact><dt><b>Returns:</b></dt><dd>True if the flush succeeded, false if the connection is down</dd></dl> - -<p> -Referenced by <a class="el" href="servers_8cpp-source.html#l00350">serverrec::SendPacket()</a>. </td> - </tr> -</table> -<a name="a18" 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> -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> -<dl compact><dt><b>Returns:</b></dt><dd>The first line of the buffer up to a carriage return</dd></dl> - </td> - </tr> -</table> -<a name="a9" doxytag="ircd_connector::GetDescription"></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::GetDescription </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> -Get the server description of this connection. -<p> -<dl compact><dt><b>Returns:</b></dt><dd>The description (GECOS) of this connection</dd></dl> - </td> - </tr> -</table> -<a name="a4" doxytag="ircd_connector::GetDescriptor"></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 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="md" nowrap></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Get the file descriptor associated with this connection. -<p> -<dl compact><dt><b>Returns:</b></dt><dd>The file descriptor associated with this connection</dd></dl> - </td> - </tr> -</table> -<a name="a8" doxytag="ircd_connector::GetServerIP"></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* 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="md" nowrap></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Get the ip address (not servername) associated with this connection. -<p> -<dl compact><dt><b>Returns:</b></dt><dd>The connections IP address in dotted decimal form</dd></dl> - </td> - </tr> -</table> -<a name="a2" doxytag="ircd_connector::GetServerName"></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::GetServerName </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> -Return the servername on this established connection. -<p> - -<p> -Referenced by <a class="el" href="servers_8cpp-source.html#l00350">serverrec::SendPacket()</a>. </td> - </tr> -</table> -<a name="a11" doxytag="ircd_connector::GetServerPort"></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 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="md" nowrap></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <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#a8">GetServerIP()</a>. -<p> -<dl compact><dt><b>Returns:</b></dt><dd>The port number of this connection</dd></dl> - </td> - </tr> -</table> -<a name="a6" doxytag="ircd_connector::GetState"></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 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="md" nowrap></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Get the state flags for this connection. -<p> -<dl compact><dt><b>Returns:</b></dt><dd>The state flags associated with this connection</dd></dl> - -<p> -Referenced by <a class="el" href="servers_8cpp-source.html#l00350">serverrec::SendPacket()</a>. </td> - </tr> -</table> -<a name="a20" 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.<p> -<dl compact><dt><b>Returns:</b></dt><dd>The version text of this connection</dd></dl> - </td> - </tr> -</table> -<a name="a24" doxytag="ircd_connector::GetWriteError"></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::GetWriteError </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> -Gets the error string for this connection. -<p> -<dl compact><dt><b>Returns:</b></dt><dd>The last error to occur or an empty string</dd></dl> - -<p> -Referenced by <a class="el" href="servers_8cpp-source.html#l00350">serverrec::SendPacket()</a>. </td> - </tr> -</table> -<a name="a25" doxytag="ircd_connector::HasBufferedOutput"></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::HasBufferedOutput </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> -Returns true if there is data to be written that hasn't been sent yet. -<p> -<dl compact><dt><b>Returns:</b></dt><dd>True if the buffer is not empty</dd></dl> - </td> - </tr> -</table> -<a name="a1" doxytag="ircd_connector::MakeOutboundConnection"></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::MakeOutboundConnection </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">char * </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>newport</em></td> - </tr> - <tr> - <td></td> - <td class="md">) </td> - <td class="md" colspan="2"></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Create an outbound connection to a listening socket. -<p> - -<p> -Referenced by <a class="el" href="servers_8cpp-source.html#l00142">serverrec::BeginLink()</a>, and <a class="el" href="servers_8cpp-source.html#l00182">serverrec::MeshCookie()</a>. </td> - </tr> -</table> -<a name="a27" doxytag="ircd_connector::ResetPing"></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::ResetPing </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> -Resets the ping counter. -<p> - </td> - </tr> -</table> -<a name="a10" doxytag="ircd_connector::SetDescription"></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::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="md" nowrap></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Set the server description of this connection. -<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>desc</em> </td><td>The description (GECOS) of this connection to be set</td></tr> - </table> -</dl> - </td> - </tr> -</table> -<a name="a5" doxytag="ircd_connector::SetDescriptor"></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::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="md" nowrap></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Set the file descriptor for this connection. -<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>fd</em> </td><td>The file descriptor to associate with the connection</td></tr> - </table> -</dl> - -<p> -Referenced by <a class="el" href="servers_8cpp-source.html#l00212">serverrec::AddIncoming()</a>. </td> - </tr> -</table> -<a name="d0" doxytag="ircd_connector::SetHostAddress"></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::SetHostAddress </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">char * </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> - </tr> - <tr> - <td></td> - <td class="md">) </td> - <td class="md" colspan="2"><code> [private]</code></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -PRIVATE function to set the host address and port to connect to. -<p> - </td> - </tr> -</table> -<a name="a13" doxytag="ircd_connector::SetHostAndPort"></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::SetHostAndPort </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">char * </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>newport</em></td> - </tr> - <tr> - <td></td> - <td class="md">) </td> - <td class="md" colspan="2"></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Set both the host and the port in one operation for this connection. -<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>newhost</em> </td><td>The hostname to set for this connection </td></tr> - <tr><td valign=top><em>newport</em> </td><td>The port number to set for this connection </td></tr> - </table> -</dl> -<dl compact><dt><b>Returns:</b></dt><dd>True on success, false on failure</dd></dl> - -<p> -Referenced by <a class="el" href="servers_8cpp-source.html#l00212">serverrec::AddIncoming()</a>, <a class="el" href="servers_8cpp-source.html#l00142">serverrec::BeginLink()</a>, and <a class="el" href="servers_8cpp-source.html#l00182">serverrec::MeshCookie()</a>. </td> - </tr> -</table> -<a name="a3" doxytag="ircd_connector::SetServerName"></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::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="md" nowrap></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Set the server name of this connection. -<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>serv</em> </td><td>The server name to set</td></tr> - </table> -</dl> - -<p> -Referenced by <a class="el" href="servers_8cpp-source.html#l00212">serverrec::AddIncoming()</a>, <a class="el" href="servers_8cpp-source.html#l00142">serverrec::BeginLink()</a>, and <a class="el" href="servers_8cpp-source.html#l00182">serverrec::MeshCookie()</a>. </td> - </tr> -</table> -<a name="a12" doxytag="ircd_connector::SetServerPort"></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::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="md" nowrap></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Set the port used by this connection. -<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>p</em> </td><td>The port number to set for this connection</td></tr> - </table> -</dl> - </td> - </tr> -</table> -<a name="a7" doxytag="ircd_connector::SetState"></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::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="md" nowrap></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Set the state flags for this connection. -<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>state</em> </td><td>The state flags to set for this connection</td></tr> - </table> -</dl> - -<p> -Referenced by <a class="el" href="servers_8cpp-source.html#l00212">serverrec::AddIncoming()</a>, <a class="el" href="servers_8cpp-source.html#l00142">serverrec::BeginLink()</a>, <a class="el" href="servers_8cpp-source.html#l00182">serverrec::MeshCookie()</a>, and <a class="el" href="servers_8cpp-source.html#l00350">serverrec::SendPacket()</a>. </td> - </tr> -</table> -<a name="a19" 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> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>newversion</em> </td><td>The version string to set</td></tr> - </table> -</dl> - </td> - </tr> -</table> -<a name="a23" doxytag="ircd_connector::SetWriteError"></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::SetWriteError </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">std::string </td> - <td class="mdname1" valign="top" nowrap> <em>error</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> -Sets the error string for this connection. -<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign=top><em>error</em> </td><td>The error string to set</td></tr> - </table> -</dl> - </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"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <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> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Sockaddr of the outbound ip and port. -<p> - -<p> -Definition at line <a class="el" href="connection_8h-source.html#l00061">61</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> -<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#r3">ircd_connector::description</a><code> [private]</code> - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -<a class="el" href="classServer.html">Server</a> 'GECOS'. -<p> - -<p> -Definition at line <a class="el" href="connection_8h-source.html#l00073">73</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> -<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#r1">ircd_connector::fd</a><code> [private]</code> - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -File descriptor of the connection. -<p> - -<p> -Definition at line <a class="el" href="connection_8h-source.html#l00065">65</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> - </tr> -</table> -<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#o1">ircd_connector::host</a>[MAXBUF] - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -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#l00117">117</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 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#l00110">110</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> - </tr> -</table> -<a name="r8" doxytag="ircd_connector::nextping"></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"> time_t <a class="el" href="classircd__connector.html#r8">ircd_connector::nextping</a><code> [private]</code> - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Time this connection was last pinged. -<p> - -<p> -Definition at line <a class="el" href="connection_8h-source.html#l00098">98</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> -<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#o2">ircd_connector::port</a> - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -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#l00123">123</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> - </tr> -</table> -<a name="r9" doxytag="ircd_connector::replied"></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 <a class="el" href="classircd__connector.html#r9">ircd_connector::replied</a><code> [private]</code> - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Did this connection reply to its last ping? -<p> - -<p> -Definition at line <a class="el" href="connection_8h-source.html#l00102">102</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> -<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#o3">ircd_connector::routes</a> - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <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. -<p> - -<p> -Definition at line <a class="el" href="connection_8h-source.html#l00129">129</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> - </tr> -</table> -<a name="r6" doxytag="ircd_connector::sendq"></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#r6">ircd_connector::sendq</a><code> [private]</code> - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -SendQ of the outbound connector, does not have a limit. -<p> - -<p> -Definition at line <a class="el" href="connection_8h-source.html#l00090">90</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> -<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#r2">ircd_connector::servername</a><code> [private]</code> - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -<a class="el" href="classServer.html">Server</a> name. -<p> - -<p> -Definition at line <a class="el" href="connection_8h-source.html#l00069">69</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> -<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#r4">ircd_connector::state</a><code> [private]</code> - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -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#l00078">78</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#l00086">86</a> of file <a class="el" href="connection_8h-source.html">connection.h</a>. </td> - </tr> -</table> -<a name="r7" doxytag="ircd_connector::WriteError"></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#r7">ircd_connector::WriteError</a><code> [private]</code> - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -Write error of connection. -<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> -<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 Mon May 30 05:17:18 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> -</body> -</html> |