Added module message passing architecture

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

1 files changed, 34 insertions, 23 deletions

diff --git a/docs/module-doc/modules_8h.html b/docs/module-doc/modules_8h.html
index 7e9f36f86..5c8d5320e 100644
--- a/docs/module-doc/modules_8h.html
+++ b/docs/module-doc/modules_8h.html
@@ -22,6 +22,9 @@
 <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classConfigReader.html">ConfigReader</a></td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file. </em> <a href="classConfigReader.html#_details">More...</a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classEvent.html">Event</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The Event class is a unicast message directed at all modules. </em> <a href="classEvent.html#_details">More...</a><em><br><br></td></tr>
 <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFileReader.html">FileReader</a></td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Caches a text file into memory and can be used to retrieve lines from it. </em> <a href="classFileReader.html#_details">More...</a><em><br><br></td></tr>
@@ -31,6 +34,12 @@
 <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModuleFactory.html">ModuleFactory</a></td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Instantiates classes inherited from <a class="el" href="classModule.html">Module</a> This class creates a class inherited from type <a class="el" href="classModule.html">Module</a>, using new. </em> <a href="classModuleFactory.html#_details">More...</a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModuleMessage.html">ModuleMessage</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The ModuleMessage class is the base class of <a class="el" href="classRequest.html">Request</a> and <a class="el" href="classEvent.html">Event</a> This class is used to represent a basic data structure which is passed between modules for safe inter-module communications. </em> <a href="classModuleMessage.html#_details">More...</a><em><br><br></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRequest.html">Request</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The Request class is a unicast message directed at a given module. </em> <a href="classRequest.html#_details">More...</a><em><br><br></td></tr>
 <tr><td class="memItemLeft" nowrap align=right valign=top>class &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classServer.html">Server</a></td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. </em> <a href="classServer.html#_details">More...</a><em><br><br></td></tr>
@@ -381,7 +390,7 @@ Definition at line <a class="el" href="modules_8h-source.html#l00039">39</a> of
 <p>
 Definition at line <a class="el" href="modules_8h-source.html#l00037">37</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00327">Module::OnAccessCheck()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00383">Module::OnAccessCheck()</a>.    </td>
   </tr>
 </table>
 <a name="a9" doxytag="modules.h::ACR_DENY"></a><p>
@@ -429,9 +438,9 @@ Definition at line <a class="el" href="modules_8h-source.html#l00038">38</a> of
 <p>
 
 <p>
-Definition at line <a class="el" href="modules_8h-source.html#l00935">935</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
+Definition at line <a class="el" href="modules_8h-source.html#l01063">1063</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00762">ConfigReader::ConfigReader()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00833">ConfigReader::ConfigReader()</a>.    </td>
   </tr>
 </table>
 <a name="a27" doxytag="modules.h::CONF_NOT_A_NUMBER"></a><p>
@@ -455,9 +464,9 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00762">ConfigReader:
 <p>
 
 <p>
-Definition at line <a class="el" href="modules_8h-source.html#l00932">932</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
+Definition at line <a class="el" href="modules_8h-source.html#l01060">1060</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00823">ConfigReader::ReadInteger()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00894">ConfigReader::ReadInteger()</a>.    </td>
   </tr>
 </table>
 <a name="a28" doxytag="modules.h::CONF_NOT_UNSIGNED"></a><p>
@@ -481,9 +490,9 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00823">ConfigReader:
 <p>
 
 <p>
-Definition at line <a class="el" href="modules_8h-source.html#l00933">933</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
+Definition at line <a class="el" href="modules_8h-source.html#l01061">1061</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00823">ConfigReader::ReadInteger()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00894">ConfigReader::ReadInteger()</a>.    </td>
   </tr>
 </table>
 <a name="a29" doxytag="modules.h::CONF_VALUE_NOT_FOUND"></a><p>
@@ -507,9 +516,9 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00823">ConfigReader:
 <p>
 
 <p>
-Definition at line <a class="el" href="modules_8h-source.html#l00934">934</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
+Definition at line <a class="el" href="modules_8h-source.html#l01062">1062</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00806">ConfigReader::ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00823">ConfigReader::ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00790">ConfigReader::ReadValue()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00877">ConfigReader::ReadFlag()</a>, <a class="el" href="modules_8cpp-source.html#l00894">ConfigReader::ReadInteger()</a>, and <a class="el" href="modules_8cpp-source.html#l00861">ConfigReader::ReadValue()</a>.    </td>
   </tr>
 </table>
 <a name="a0" doxytag="modules.h::DEBUG"></a><p>
@@ -535,7 +544,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00806">ConfigReader:
 <p>
 Definition at line <a class="el" href="modules_8h-source.html#l00023">23</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00561">Server::AddExtendedMode()</a>, <a class="el" href="users_8cpp-source.html#l00114">userrec::HasPermission()</a>, <a class="el" href="channels_8cpp-source.html#l00180">chanrec::IsCustomModeSet()</a>, <a class="el" href="modules_8cpp-source.html#l00209">ModeDefined()</a>, <a class="el" href="modules_8cpp-source.html#l00235">ModeDefinedOper()</a>, <a class="el" href="modules_8cpp-source.html#l00222">ModeIsListMode()</a>, <a class="el" href="users_8cpp-source.html#l00092">userrec::RemoveInvite()</a>, <a class="el" href="channels_8cpp-source.html#l00124">chanrec::SetCustomMode()</a>, and <a class="el" href="channels_8cpp-source.html#l00149">chanrec::SetCustomModeParam()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00620">Server::AddExtendedMode()</a>, <a class="el" href="users_8cpp-source.html#l00114">userrec::HasPermission()</a>, <a class="el" href="channels_8cpp-source.html#l00180">chanrec::IsCustomModeSet()</a>, <a class="el" href="modules_8cpp-source.html#l00211">ModeDefined()</a>, <a class="el" href="modules_8cpp-source.html#l00237">ModeDefinedOper()</a>, <a class="el" href="modules_8cpp-source.html#l00224">ModeIsListMode()</a>, <a class="el" href="users_8cpp-source.html#l00092">userrec::RemoveInvite()</a>, <a class="el" href="channels_8cpp-source.html#l00124">chanrec::SetCustomMode()</a>, and <a class="el" href="channels_8cpp-source.html#l00149">chanrec::SetCustomModeParam()</a>.    </td>
   </tr>
 </table>
 <a name="a2" doxytag="modules.h::DEFAULT"></a><p>
@@ -585,7 +594,7 @@ Definition at line <a class="el" href="modules_8h-source.html#l00025">25</a> of
 <p>
 Definition at line <a class="el" href="modules_8h-source.html#l00099">99</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00604">Server::PseudoToUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00595">Server::UserToPseudo()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00663">Server::PseudoToUser()</a>, and <a class="el" href="modules_8cpp-source.html#l00654">Server::UserToPseudo()</a>.    </td>
   </tr>
 </table>
 <a name="a24" doxytag="modules.h::FOREACH_MOD"></a><p>
@@ -609,7 +618,9 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00604">Server::Pseud
 <p>
 
 <p>
-Definition at line <a class="el" href="modules_8h-source.html#l00079">79</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
+Definition at line <a class="el" href="modules_8h-source.html#l00079">79</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
+<p>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00349">Event::Send()</a>.    </td>
   </tr>
 </table>
 <a name="a25" doxytag="modules.h::FOREACH_RESULT"></a><p>
@@ -673,7 +684,7 @@ Definition at line <a class="el" href="modules_8h-source.html#l00087">87</a> of
 <p>
 Definition at line <a class="el" href="modules_8h-source.html#l00031">31</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00581">Server::AddExtendedListMode()</a>, and <a class="el" href="modules_8cpp-source.html#l00285">ModeMakeList()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00640">Server::AddExtendedListMode()</a>, and <a class="el" href="modules_8cpp-source.html#l00287">ModeMakeList()</a>.    </td>
   </tr>
 </table>
 <a name="a6" doxytag="modules.h::MT_CLIENT"></a><p>
@@ -699,7 +710,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00581">Server::AddEx
 <p>
 Definition at line <a class="el" href="modules_8h-source.html#l00032">32</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00561">Server::AddExtendedMode()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00620">Server::AddExtendedMode()</a>.    </td>
   </tr>
 </table>
 <a name="a7" doxytag="modules.h::MT_SERVER"></a><p>
@@ -725,7 +736,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00561">Server::AddEx
 <p>
 Definition at line <a class="el" href="modules_8h-source.html#l00033">33</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00561">Server::AddExtendedMode()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00620">Server::AddExtendedMode()</a>.    </td>
   </tr>
 </table>
 <a name="a4" doxytag="modules.h::NONE"></a><p>
@@ -895,7 +906,7 @@ Definition at line <a class="el" href="modules_8h-source.html#l00053">53</a> of
 <p>
 Definition at line <a class="el" href="modules_8h-source.html#l00054">54</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00318">Module::GetVersion()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00374">Module::GetVersion()</a>.    </td>
   </tr>
 </table>
 <hr><h2>Typedef Documentation</h2>
@@ -924,7 +935,7 @@ Holds a list of users in a channel.
 <p>
 Definition at line <a class="el" href="modules_8h-source.html#l00072">72</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00391">Server::GetUsers()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00450">Server::GetUsers()</a>.    </td>
   </tr>
 </table>
 <a name="a31" doxytag="modules.h::file_cache"></a><p>
@@ -952,7 +963,7 @@ Low level definition of a <a class="el" href="classFileReader.html">FileReader</
 <p>
 Definition at line <a class="el" href="modules_8h-source.html#l00067">67</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00908">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00919">FileReader::LoadFile()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00979">FileReader::FileReader()</a>, and <a class="el" href="modules_8cpp-source.html#l00990">FileReader::LoadFile()</a>.    </td>
   </tr>
 </table>
 <a name="a34" doxytag="modules.h::ircd_module"></a><p>
@@ -976,7 +987,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00908">FileReader::F
 <p>
 
 <p>
-Definition at line <a class="el" href="modules_8h-source.html#l01101">1101</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
+Definition at line <a class="el" href="modules_8h-source.html#l01229">1229</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
   </tr>
 </table>
 <a name="a32" doxytag="modules.h::string_list"></a><p>
@@ -1002,7 +1013,7 @@ Definition at line <a class="el" href="modules_8h-source.html#l01101">1101</a> o
 <p>
 Definition at line <a class="el" href="modules_8h-source.html#l00068">68</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00329">Module::OnChannelSync()</a>, and <a class="el" href="modules_8cpp-source.html#l00328">Module::OnUserSync()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00385">Module::OnChannelSync()</a>, and <a class="el" href="modules_8cpp-source.html#l00384">Module::OnUserSync()</a>.    </td>
   </tr>
 </table>
 <hr><h2>Function Documentation</h2>
@@ -1061,7 +1072,7 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00329">Module::OnCha
 <p>
 
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00436">Server::AddCommand()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00495">Server::AddCommand()</a>.    </td>
   </tr>
 </table>
 <a name="a36" doxytag="modules.h::server_mode"></a><p>
@@ -1107,10 +1118,10 @@ Referenced by <a class="el" href="modules_8cpp-source.html#l00436">Server::AddCo
 <p>
 
 <p>
-Referenced by <a class="el" href="modules_8cpp-source.html#l00441">Server::SendMode()</a>.    </td>
+Referenced by <a class="el" href="modules_8cpp-source.html#l00500">Server::SendMode()</a>.    </td>
   </tr>
 </table>
-<hr size="1"><address style="align: right;"><small>Generated on Sat Apr 16 18:57:15 2005 for InspIRCd by
+<hr size="1"><address style="align: right;"><small>Generated on Wed Apr 20 15:46:59 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>