Added new documentation to cover ircd_connector

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@629 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 78 insertions, 55 deletions

diff --git a/docs/module-doc/functions.html b/docs/module-doc/functions.html
index 578a1298c..620e6e5df 100644
--- a/docs/module-doc/functions.html
+++ b/docs/module-doc/functions.html
@@ -14,7 +14,9 @@ Here is a list of all class members with links to the classes they belong to:<h3
 </h3><ul>
 <li>AddCommand()
 : <a class="el" href="classServer.html#a21">Server</a><li>AddExtendedMode()
-: <a class="el" href="classServer.html#a20">Server</a><li>Admin()
+: <a class="el" href="classServer.html#a20">Server</a><li>AddIncoming()
+: <a class="el" href="classconnection.html#a8">connection</a><li>addr
+: <a class="el" href="classircd__connector.html#o0">ircd_connector</a><li>Admin()
 : <a class="el" href="classAdmin.html#a0">Admin</a><li>age
 : <a class="el" href="classclassbase.html#m0">classbase</a><li>awaymsg
 : <a class="el" href="classuserrec.html#m7">userrec</a></ul>
@@ -24,27 +26,31 @@ Here is a list of all class members with links to the classes they belong to:<h3
 : <a class="el" href="classchanrec.html#m14">chanrec</a><li>BeginLink()
 : <a class="el" href="classconnection.html#a2">connection</a><li>Build
 : <a class="el" href="classVersion.html#m3">Version</a><li>bytes_in
-: <a class="el" href="classconnection.html#m5">connection</a><li>bytes_out
-: <a class="el" href="classconnection.html#m6">connection</a></ul>
+: <a class="el" href="classconnection.html#m4">connection</a><li>bytes_out
+: <a class="el" href="classconnection.html#m5">connection</a></ul>
 <h3><a name="index_c">- c -</a>
 </h3><ul>
 <li>c_private
 : <a class="el" href="classchanrec.html#m13">chanrec</a><li>cache
-: <a class="el" href="classConfigReader.html#n0">ConfigReader</a><li>carryover
-: <a class="el" href="classuserrec.html#m9">userrec</a><li>ChangeUserNick()
+: <a class="el" href="classConfigReader.html#n0">ConfigReader</a><li>CallCommandHandler()
+: <a class="el" href="classServer.html#a29">Server</a><li>ChangeGECOS()
+: <a class="el" href="classServer.html#a31">Server</a><li>ChangeHost()
+: <a class="el" href="classServer.html#a30">Server</a><li>ChangeUserNick()
 : <a class="el" href="classServer.html#a26">Server</a><li>ChanMode()
 : <a class="el" href="classServer.html#a16">Server</a><li>channel
 : <a class="el" href="classInvited.html#m0">Invited</a>, <a class="el" href="classucrec.html#m1">ucrec</a>, <a class="el" href="classModeParameter.html#m2">ModeParameter</a><li>chanrec()
 : <a class="el" href="classchanrec.html#a4">chanrec</a><li>chans
 : <a class="el" href="classuserrec.html#m5">userrec</a><li>classbase()
-: <a class="el" href="classclassbase.html#a0">classbase</a><li>cmds_in
-: <a class="el" href="classconnection.html#m7">connection</a><li>cmds_out
-: <a class="el" href="classconnection.html#m8">connection</a><li>command
+: <a class="el" href="classclassbase.html#a0">classbase</a><li>CloseConnection()
+: <a class="el" href="classircd__connector.html#a13">ircd_connector</a><li>cmds_in
+: <a class="el" href="classconnection.html#m6">connection</a><li>cmds_out
+: <a class="el" href="classconnection.html#m7">connection</a><li>command
 : <a class="el" href="classcommand__t.html#m0">command_t</a><li>CommonChannels()
 : <a class="el" href="classServer.html#a9">Server</a><li>ConfigReader()
 : <a class="el" href="classConfigReader.html#a1">ConfigReader</a><li>ConnectClass()
 : <a class="el" href="classConnectClass.html#a0">ConnectClass</a><li>connection()
-: <a class="el" href="classconnection.html#a0">connection</a><li>CountUsers()
+: <a class="el" href="classconnection.html#a0">connection</a><li>connectors
+: <a class="el" href="classconnection.html#m18">connection</a><li>CountUsers()
 : <a class="el" href="classServer.html#a13">Server</a><li>created
 : <a class="el" href="classchanrec.html#m3">chanrec</a><li>CreateListener()
 : <a class="el" href="classconnection.html#a1">connection</a><li>CreateModule()
@@ -53,7 +59,8 @@ Here is a list of all class members with links to the classes they belong to:<h3
 <h3><a name="index_d">- d -</a>
 </h3><ul>
 <li>data
-: <a class="el" href="classpacket.html#m3">packet</a>, <a class="el" href="classHostItem.html#m2">HostItem</a><li>dhost
+: <a class="el" href="classHostItem.html#m2">HostItem</a><li>description
+: <a class="el" href="classserverrec.html#m8">serverrec</a>, <a class="el" href="classircd__connector.html#o3">ircd_connector</a><li>dhost
 : <a class="el" href="classuserrec.html#m2">userrec</a></ul>
 <h3><a name="index_e">- e -</a>
 </h3><ul>
@@ -68,45 +75,52 @@ Here is a list of all class members with links to the classes they belong to:<h3
 </h3><ul>
 <li>fc
 : <a class="el" href="classFileReader.html#o0">FileReader</a><li>fd
-: <a class="el" href="classconnection.html#m1">connection</a><li>FileReader()
+: <a class="el" href="classconnection.html#m0">connection</a>, <a class="el" href="classircd__connector.html#o1">ircd_connector</a><li>FileReader()
 : <a class="el" href="classFileReader.html#a1">FileReader</a><li>FileSize()
 : <a class="el" href="classFileReader.html#a6">FileReader</a><li>FindChannel()
-: <a class="el" href="classServer.html#a15">Server</a><li>FindNick()
+: <a class="el" href="classServer.html#a15">Server</a><li>FindHost()
+: <a class="el" href="classconnection.html#a7">connection</a><li>FindNick()
 : <a class="el" href="classServer.html#a14">Server</a><li>flags_needed
-: <a class="el" href="classcommand__t.html#m2">command_t</a><li>fullname
+: <a class="el" href="classcommand__t.html#m2">command_t</a><li>flood
+: <a class="el" href="classuserrec.html#m9">userrec</a>, <a class="el" href="classConnectClass.html#m2">ConnectClass</a><li>fullname
 : <a class="el" href="classuserrec.html#m3">userrec</a></ul>
 <h3><a name="index_g">- g -</a>
 </h3><ul>
 <li>GenKey()
-: <a class="el" href="classconnection.html#a8">connection</a><li>GetAdmin()
-: <a class="el" href="classServer.html#a19">Server</a><li>GetFullHost()
+: <a class="el" href="classconnection.html#a9">connection</a><li>GetAdmin()
+: <a class="el" href="classServer.html#a19">Server</a><li>GetDescription()
+: <a class="el" href="classircd__connector.html#a8">ircd_connector</a><li>GetDescriptor()
+: <a class="el" href="classircd__connector.html#a3">ircd_connector</a><li>GetFullHost()
 : <a class="el" href="classuserrec.html#a2">userrec</a><li>GetFullRealHost()
 : <a class="el" href="classuserrec.html#a3">userrec</a><li>GetLine()
 : <a class="el" href="classFileReader.html#a5">FileReader</a><li>GetModeParameter()
 : <a class="el" href="classchanrec.html#a3">chanrec</a><li>GetNetworkName()
-: <a class="el" href="classServer.html#a18">Server</a><li>GetServerName()
-: <a class="el" href="classServer.html#a17">Server</a><li>GetVersion()
+: <a class="el" href="classServer.html#a18">Server</a><li>GetServerIP()
+: <a class="el" href="classircd__connector.html#a7">ircd_connector</a><li>GetServerName()
+: <a class="el" href="classServer.html#a17">Server</a>, <a class="el" href="classircd__connector.html#a1">ircd_connector</a><li>GetServerPort()
+: <a class="el" href="classircd__connector.html#a10">ircd_connector</a><li>GetState()
+: <a class="el" href="classircd__connector.html#a5">ircd_connector</a><li>GetVersion()
 : <a class="el" href="classModule.html#a2">Module</a></ul>
 <h3><a name="index_h">- h -</a>
 </h3><ul>
 <li>handler_function
 : <a class="el" href="classcommand__t.html#m1">command_t</a><li>haspassed
-: <a class="el" href="classconnection.html#m9">connection</a><li>hops_away
+: <a class="el" href="classconnection.html#m8">connection</a><li>hops_away
 : <a class="el" href="classserverrec.html#m5">serverrec</a><li>host
-: <a class="el" href="classConnectClass.html#m2">ConnectClass</a>, <a class="el" href="classconnection.html#m2">connection</a><li>HostItem()
+: <a class="el" href="classConnectClass.html#m3">ConnectClass</a>, <a class="el" href="classconnection.html#m1">connection</a>, <a class="el" href="classircd__connector.html#m0">ircd_connector</a><li>HostItem()
 : <a class="el" href="classHostItem.html#a0">HostItem</a></ul>
 <h3><a name="index_i">- i -</a>
 </h3><ul>
-<li>id
-: <a class="el" href="classpacket.html#m1">packet</a><li>ident
+<li>ident
 : <a class="el" href="classuserrec.html#m1">userrec</a><li>idle_lastmsg
 : <a class="el" href="classconnection.html#m14">connection</a><li>inbuf
-: <a class="el" href="classconnection.html#m4">connection</a><li>internal_addr
-: <a class="el" href="classconnection.html#m16">connection</a><li>inviteonly
+: <a class="el" href="classconnection.html#m3">connection</a><li>internal_addr
+: <a class="el" href="classconnection.html#m16">connection</a><li>internal_port
+: <a class="el" href="classconnection.html#m17">connection</a><li>inviteonly
 : <a class="el" href="classchanrec.html#m10">chanrec</a><li>invites
 : <a class="el" href="classuserrec.html#o0">userrec</a><li>InviteTo()
 : <a class="el" href="classuserrec.html#a5">userrec</a><li>ip
-: <a class="el" href="classconnection.html#m3">connection</a><li>IsCustomModeSet()
+: <a class="el" href="classconnection.html#m2">connection</a><li>IsCustomModeSet()
 : <a class="el" href="classchanrec.html#a2">chanrec</a><li>IsInvited()
 : <a class="el" href="classuserrec.html#a4">userrec</a><li>IsNick()
 : <a class="el" href="classServer.html#a12">Server</a></ul>
@@ -118,7 +132,7 @@ Here is a list of all class members with links to the classes they belong to:<h3
 <h3><a name="index_k">- k -</a>
 </h3><ul>
 <li>key
-: <a class="el" href="classconnection.html#m0">connection</a>, <a class="el" href="classpacket.html#m0">packet</a>, <a class="el" href="classchanrec.html#m7">chanrec</a></ul>
+: <a class="el" href="classchanrec.html#m7">chanrec</a></ul>
 <h3><a name="index_l">- l -</a>
 </h3><ul>
 <li>lastping
@@ -129,8 +143,10 @@ Here is a list of all class members with links to the classes they belong to:<h3
 <h3><a name="index_m">- m -</a>
 </h3><ul>
 <li>Major
-: <a class="el" href="classVersion.html#m0">Version</a><li>MatchText()
-: <a class="el" href="classServer.html#a28">Server</a><li>min_params
+: <a class="el" href="classVersion.html#m0">Version</a><li>MakeOutboundConnection()
+: <a class="el" href="classircd__connector.html#a0">ircd_connector</a><li>MatchText()
+: <a class="el" href="classServer.html#a28">Server</a><li>MeshCookie()
+: <a class="el" href="classconnection.html#a3">connection</a><li>min_params
 : <a class="el" href="classcommand__t.html#m3">command_t</a><li>Minor
 : <a class="el" href="classVersion.html#m1">Version</a><li>mode
 : <a class="el" href="classModeParameter.html#m0">ModeParameter</a><li>modechar
@@ -144,9 +160,9 @@ Here is a list of all class members with links to the classes they belong to:<h3
 <li>name
 : <a class="el" href="classserverrec.html#m0">serverrec</a>, <a class="el" href="classchanrec.html#m0">chanrec</a><li>Name
 : <a class="el" href="classAdmin.html#m0">Admin</a><li>needsoper
-: <a class="el" href="classExtMode.html#m4">ExtMode</a><li>nick
-: <a class="el" href="classuserrec.html#m0">userrec</a><li>Nick
-: <a class="el" href="classAdmin.html#m2">Admin</a><li>noexternal
+: <a class="el" href="classExtMode.html#m4">ExtMode</a><li>Nick
+: <a class="el" href="classAdmin.html#m2">Admin</a><li>nick
+: <a class="el" href="classuserrec.html#m0">userrec</a><li>noexternal
 : <a class="el" href="classchanrec.html#m9">chanrec</a><li>nping
 : <a class="el" href="classconnection.html#m15">connection</a></ul>
 <h3><a name="index_o">- o -</a>
@@ -170,15 +186,14 @@ Here is a list of all class members with links to the classes they belong to:<h3
 : <a class="el" href="classserverrec.html#m4">serverrec</a></ul>
 <h3><a name="index_p">- p -</a>
 </h3><ul>
-<li>packet()
-: <a class="el" href="classpacket.html#a0">packet</a><li>parameter
+<li>parameter
 : <a class="el" href="classModeParameter.html#m1">ModeParameter</a><li>params_when_off
 : <a class="el" href="classExtMode.html#m3">ExtMode</a><li>params_when_on
 : <a class="el" href="classExtMode.html#m2">ExtMode</a><li>PartUserFromChannel()
 : <a class="el" href="classServer.html#a25">Server</a><li>pass
-: <a class="el" href="classConnectClass.html#m3">ConnectClass</a><li>pingtime
+: <a class="el" href="classConnectClass.html#m4">ConnectClass</a><li>pingtime
 : <a class="el" href="classserverrec.html#m1">serverrec</a><li>port
-: <a class="el" href="classconnection.html#m10">connection</a></ul>
+: <a class="el" href="classconnection.html#m9">connection</a>, <a class="el" href="classircd__connector.html#m1">ircd_connector</a></ul>
 <h3><a name="index_q">- q -</a>
 </h3><ul>
 <li>QuitUser()
@@ -187,48 +202,57 @@ Here is a list of all class members with links to the classes they belong to:<h3
 </h3><ul>
 <li>ReadValue()
 : <a class="el" href="classConfigReader.html#a3">ConfigReader</a><li>RecvPacket()
-: <a class="el" href="classconnection.html#a5">connection</a><li>registered
-: <a class="el" href="classconnection.html#m11">connection</a><li>registration_timeout
+: <a class="el" href="classconnection.html#a6">connection</a><li>registered
+: <a class="el" href="classconnection.html#m10">connection</a><li>registration_timeout
 : <a class="el" href="classConnectClass.html#m1">ConnectClass</a><li>RemoveInvite()
 : <a class="el" href="classuserrec.html#a6">userrec</a><li>result
 : <a class="el" href="classuserrec.html#m8">userrec</a><li>Revision
-: <a class="el" href="classVersion.html#m2">Version</a></ul>
+: <a class="el" href="classVersion.html#m2">Version</a><li>routes
+: <a class="el" href="classircd__connector.html#m2">ircd_connector</a></ul>
 <h3><a name="index_s">- s -</a>
 </h3><ul>
 <li>secret
 : <a class="el" href="classchanrec.html#m12">chanrec</a><li>Send()
-: <a class="el" href="classServer.html#a4">Server</a><li>SendACK()
-: <a class="el" href="classconnection.html#a7">connection</a><li>SendChannel()
+: <a class="el" href="classServer.html#a4">Server</a><li>SendChannel()
 : <a class="el" href="classServer.html#a8">Server</a><li>SendCommon()
 : <a class="el" href="classServer.html#a10">Server</a><li>SendFrom()
 : <a class="el" href="classServer.html#a6">Server</a><li>SendMode()
 : <a class="el" href="classServer.html#a22">Server</a><li>SendOpers()
 : <a class="el" href="classServer.html#a2">Server</a><li>SendPacket()
-: <a class="el" href="classconnection.html#a4">connection</a><li>SendServ()
-: <a class="el" href="classServer.html#a5">Server</a><li>SendSYN()
-: <a class="el" href="classconnection.html#a6">connection</a><li>SendTo()
+: <a class="el" href="classconnection.html#a5">connection</a><li>SendServ()
+: <a class="el" href="classServer.html#a5">Server</a><li>SendTo()
 : <a class="el" href="classServer.html#a7">Server</a><li>SendToModeMask()
 : <a class="el" href="classServer.html#a23">Server</a><li>SendWallops()
-: <a class="el" href="classServer.html#a11">Server</a><li>Server()
-: <a class="el" href="classServer.html#a0">Server</a><li>server
-: <a class="el" href="classuserrec.html#m6">userrec</a><li>serverrec()
+: <a class="el" href="classServer.html#a11">Server</a><li>server
+: <a class="el" href="classuserrec.html#m6">userrec</a><li>Server()
+: <a class="el" href="classServer.html#a0">Server</a><li>servername
+: <a class="el" href="classircd__connector.html#o2">ircd_connector</a><li>serverrec()
 : <a class="el" href="classserverrec.html#a1">serverrec</a><li>set_by
 : <a class="el" href="classHostItem.html#m1">HostItem</a><li>set_time
 : <a class="el" href="classHostItem.html#m0">HostItem</a><li>setby
 : <a class="el" href="classchanrec.html#m5">chanrec</a><li>SetCustomMode()
 : <a class="el" href="classchanrec.html#a0">chanrec</a><li>SetCustomModeParam()
-: <a class="el" href="classchanrec.html#a1">chanrec</a><li>signon
-: <a class="el" href="classconnection.html#m13">connection</a></ul>
+: <a class="el" href="classchanrec.html#a1">chanrec</a><li>SetDescription()
+: <a class="el" href="classircd__connector.html#a9">ircd_connector</a><li>SetDescriptor()
+: <a class="el" href="classircd__connector.html#a4">ircd_connector</a><li>SetHostAddress()
+: <a class="el" href="classircd__connector.html#c0">ircd_connector</a><li>SetHostAndPort()
+: <a class="el" href="classircd__connector.html#a12">ircd_connector</a><li>SetServerName()
+: <a class="el" href="classircd__connector.html#a2">ircd_connector</a><li>SetServerPort()
+: <a class="el" href="classircd__connector.html#a11">ircd_connector</a><li>SetState()
+: <a class="el" href="classircd__connector.html#a6">ircd_connector</a><li>signon
+: <a class="el" href="classconnection.html#m13">connection</a><li>state
+: <a class="el" href="classconnection.html#m11">connection</a>, <a class="el" href="classircd__connector.html#o4">ircd_connector</a><li>sync_soon
+: <a class="el" href="classserverrec.html#m9">serverrec</a></ul>
 <h3><a name="index_t">- t -</a>
 </h3><ul>
 <li>TerminateLink()
-: <a class="el" href="classconnection.html#a3">connection</a><li>timeout
+: <a class="el" href="classconnection.html#a4">connection</a><li>timeout
 : <a class="el" href="classuserrec.html#m10">userrec</a><li>topic
 : <a class="el" href="classchanrec.html#m2">chanrec</a><li>topiclock
 : <a class="el" href="classchanrec.html#m8">chanrec</a><li>topicset
 : <a class="el" href="classchanrec.html#m4">chanrec</a><li>total_bytes
 : <a class="el" href="classcommand__t.html#m5">command_t</a><li>type
-: <a class="el" href="classConnectClass.html#m0">ConnectClass</a>, <a class="el" href="classpacket.html#m2">packet</a>, <a class="el" href="classExtMode.html#m1">ExtMode</a></ul>
+: <a class="el" href="classConnectClass.html#m0">ConnectClass</a>, <a class="el" href="classExtMode.html#m1">ExtMode</a></ul>
 <h3><a name="index_u">- u -</a>
 </h3><ul>
 <li>uc_modes
@@ -241,9 +265,9 @@ Here is a list of all class members with links to the classes they belong to:<h3
 <h3><a name="index_v">- v -</a>
 </h3><ul>
 <li>Verify()
-: <a class="el" href="classConfigReader.html#a5">ConfigReader</a><li>version
-: <a class="el" href="classserverrec.html#m6">serverrec</a><li>Version()
-: <a class="el" href="classVersion.html#a0">Version</a></ul>
+: <a class="el" href="classConfigReader.html#a5">ConfigReader</a><li>Version()
+: <a class="el" href="classVersion.html#a0">Version</a><li>version
+: <a class="el" href="classserverrec.html#m6">serverrec</a></ul>
 <h3><a name="index_~">- ~ -</a>
 </h3><ul>
 <li>~chanrec()
@@ -253,13 +277,12 @@ Here is a list of all class members with links to the classes they belong to:<h3
 : <a class="el" href="classFileReader.html#a2">FileReader</a><li>~HostItem()
 : <a class="el" href="classHostItem.html#a1">HostItem</a><li>~Module()
 : <a class="el" href="classModule.html#a1">Module</a><li>~ModuleFactory()
-: <a class="el" href="classModuleFactory.html#a1">ModuleFactory</a><li>~packet()
-: <a class="el" href="classpacket.html#a1">packet</a><li>~Server()
+: <a class="el" href="classModuleFactory.html#a1">ModuleFactory</a><li>~Server()
 : <a class="el" href="classServer.html#a1">Server</a><li>~serverrec()
 : <a class="el" href="classserverrec.html#a2">serverrec</a><li>~ucrec()
 : <a class="el" href="classucrec.html#a1">ucrec</a><li>~userrec()
 : <a class="el" href="classuserrec.html#a1">userrec</a></ul>
-<hr><address style="align: right;"><small>Generated on Thu Apr 8 19:12:45 2004 for InspIRCd by
+<hr><address style="align: right;"><small>Generated on Sat Apr 17 13:31:44 2004 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>