]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/module-doc/modules_8h-source.html
New documentation for new ConfigReader methods
[user/henk/code/inspircd.git] / docs / module-doc / modules_8h-source.html
index 6c4a1e489a5c9c08e2333490410870f3b2a8359f..7b6666e5c07289dcc02e3348e3157ea612f46b1f 100644 (file)
 <!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>modules.h Source File</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="inspircd.css" rel="stylesheet" type="text/css">
 </head><body>
-<!-- Generated by Doxygen 1.3-rc2 -->
+<!-- Generated by Doxygen 1.3-rc3 -->
 <center>
-<a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
+<a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
 <hr><h1>modules.h</h1><a href="modules_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
 00002 <span class="comment"></span>
-00003 <span class="comment">$Log$
-00003 <span class="comment">Revision 1.2  2003/01/23 20:38:00  brain
-00003 <span class="comment">Updated documentation scripts
 00003 <span class="comment"></span>
-00004 <span class="comment">Revision 1.1.1.1  2003/01/23 19:45:58  brain</span>
-00005 <span class="comment">InspIRCd second source tree</span>
-00006 <span class="comment"></span>
-00007 <span class="comment">Revision 1.12  2003/01/22 20:59:10  brain</span>
-00008 <span class="comment">Added FileReader class documentation</span>
-00009 <span class="comment"></span>
-00010 <span class="comment">Revision 1.11  2003/01/22 20:49:16  brain</span>
-00011 <span class="comment">Added FileReader file-caching class</span>
-00012 <span class="comment">Changed m_randquote to use FileReader class</span>
-00013 <span class="comment"></span>
-00014 <span class="comment">Revision 1.10  2003/01/22 00:57:27  brain</span>
-00015 <span class="comment">Changes to documentation</span>
-00016 <span class="comment"></span>
-00017 <span class="comment">Revision 1.9  2003/01/22 00:44:26  brain</span>
-00018 <span class="comment">Added documentation comments</span>
-00019 <span class="comment"></span>
-00020 <span class="comment">Revision 1.8  2003/01/21 20:31:24  brain</span>
-00021 <span class="comment">Modified to add documentation</span>
-00022 <span class="comment">Added ConfigReader class for modules</span>
-00023 <span class="comment"></span>
-00024 <span class="comment">Revision 1.7  2003/01/15 22:47:44  brain</span>
-00025 <span class="comment">Changed user and channel structs to classes (finally)</span>
-00026 <span class="comment"></span>
-00027 <span class="comment">Revision 1.6  2003/01/13 22:30:50  brain</span>
-00028 <span class="comment">Added Admin class (holds /admin info for modules)</span>
-00029 <span class="comment">Added methods to Server class</span>
-00030 <span class="comment"></span>
-00031 <span class="comment"></span>
-00032 <span class="comment">*/</span>
-00033 
-00034 
-00035 <span class="preprocessor">#ifndef __PLUGIN_H</span>
-00036 <span class="preprocessor"></span><span class="preprocessor">#define __PLUGIN_H</span>
-00037 <span class="preprocessor"></span>
-00038 <span class="preprocessor">#include "dynamic.h"</span>
-00039 <span class="preprocessor">#include &lt;string&gt;</span>
-00040 <span class="preprocessor">#include &lt;deque&gt;</span>
-00041 
-<a name="l00044"></a><a class="code" href="modules_8h.html#a1">00044</a> <span class="keyword">typedef</span> deque&lt;string&gt; <a class="code" href="modules_8h.html#a1">file_cache</a>;
-00045 
-00046 
-00047 <span class="comment">// This #define allows us to call a method in all</span>
-00048 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
-00049 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
-00050 
-<a name="l00051"></a><a class="code" href="modules_8h.html#a0">00051</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i &lt;= MODCOUNT; i++) modules[i]-&gt;</span>
-00052 <span class="preprocessor"></span>
-00053 <span class="comment">// class Version holds the version information of a Module, returned</span>
-00054 <span class="comment">// by Module::GetVersion (thanks RD)</span>
-00055 
-<a name="l00060"></a><a class="code" href="classVersion.html">00060</a> <span class="keyword">class </span><a class="code" href="classVersion.html">Version</a>
-00061 {
-00062  <span class="keyword">public</span>:
-<a name="l00063"></a><a class="code" href="classVersion.html#m2">00063</a>          <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classVersion.html#m0">Major</a>, <a class="code" href="classVersion.html#m1">Minor</a>, <a class="code" href="classVersion.html#m2">Revision</a>, <a class="code" href="classVersion.html#m3">Build</a>;
-00064          <a class="code" href="classVersion.html#a0">Version</a>(<span class="keywordtype">int</span> major, <span class="keywordtype">int</span> minor, <span class="keywordtype">int</span> revision, <span class="keywordtype">int</span> build);
-00065 };
-00066 
-00067 
-<a name="l00073"></a><a class="code" href="classAdmin.html">00073</a> <span class="keyword">class </span><a class="code" href="classAdmin.html">Admin</a>
-00074 {
-00075  <span class="keyword">public</span>:
-<a name="l00076"></a><a class="code" href="classAdmin.html#m2">00076</a>          <span class="keyword">const</span> string <a class="code" href="classAdmin.html#m0">Name</a>, <a class="code" href="classAdmin.html#m1">Email</a>, <a class="code" href="classAdmin.html#m2">Nick</a>;
-00077          <a class="code" href="classAdmin.html#a0">Admin</a>(string name,string email,string nick);
-00078 };
-00079 
-<a name="l00085"></a><a class="code" href="classModule.html">00085</a> <span class="keyword">class </span><a class="code" href="classModule.html">Module</a>
-00086 {
-00087  <span class="keyword">public</span>:
-00091         <a class="code" href="classModule.html#a0">Module</a>();
-00095         <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
-00100         <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
-00104         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a3">OnUserConnect</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
-00108         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a4">OnUserQuit</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
-00113         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a5">OnUserJoin</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel);
-00118         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a6">OnUserPart</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel);
-00119 };
+00004 <span class="comment"></span>
+00005 <span class="comment">*/</span>
+00006 
+00007 
+00008 <span class="preprocessor">#ifndef __PLUGIN_H</span>
+00009 <span class="preprocessor"></span><span class="preprocessor">#define __PLUGIN_H</span>
+00010 <span class="preprocessor"></span>
+<a name="l00011"></a><a class="code" href="modules_8h.html#a0">00011</a> <span class="preprocessor">#define DEBUG 10</span>
+<a name="l00012"></a><a class="code" href="modules_8h.html#a1">00012</a> <span class="preprocessor"></span><span class="preprocessor">#define VERBOSE 20</span>
+<a name="l00013"></a><a class="code" href="modules_8h.html#a2">00013</a> <span class="preprocessor"></span><span class="preprocessor">#define DEFAULT 30</span>
+<a name="l00014"></a><a class="code" href="modules_8h.html#a3">00014</a> <span class="preprocessor"></span><span class="preprocessor">#define SPARSE 40</span>
+<a name="l00015"></a><a class="code" href="modules_8h.html#a4">00015</a> <span class="preprocessor"></span><span class="preprocessor">#define NONE 50</span>
+00016 <span class="preprocessor"></span>
+<a name="l00017"></a><a class="code" href="modules_8h.html#a5">00017</a> <span class="preprocessor">#define MT_CHANNEL 1</span>
+<a name="l00018"></a><a class="code" href="modules_8h.html#a6">00018</a> <span class="preprocessor"></span><span class="preprocessor">#define MT_CLIENT 2</span>
+<a name="l00019"></a><a class="code" href="modules_8h.html#a7">00019</a> <span class="preprocessor"></span><span class="preprocessor">#define MT_SERVER 3</span>
+00020 <span class="preprocessor"></span>
+00021 <span class="preprocessor">#include "dynamic.h"</span>
+00022 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
+00023 <span class="preprocessor">#include "<a class="code" href="ctables_8h.html">ctables.h</a>"</span>
+00024 <span class="preprocessor">#include &lt;string&gt;</span>
+00025 <span class="preprocessor">#include &lt;deque&gt;</span>
+00026 <span class="preprocessor">#include &lt;sstream&gt;</span>
+00027 
+<a name="l00030"></a><a class="code" href="modules_8h.html#a10">00030</a> <span class="keyword">typedef</span> std::deque&lt;std::string&gt; <a class="code" href="modules_8h.html#a10">file_cache</a>;
+<a name="l00031"></a><a class="code" href="modules_8h.html#a11">00031</a> <span class="keyword">typedef</span> <a class="code" href="modules_8h.html#a10">file_cache</a> <a class="code" href="modules_8h.html#a11">string_list</a>;
+00032 
+00033 <span class="comment">// This #define allows us to call a method in all</span>
+00034 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
+00035 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
+00036 
+<a name="l00037"></a><a class="code" href="modules_8h.html#a8">00037</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i &lt;= MODCOUNT; i++) modules[i]-&gt;</span>
+00038 <span class="preprocessor"></span>
+00039 <span class="comment">// This define is similar to the one above but returns a result in MOD_RESULT.</span>
+00040 <span class="comment">// The first module to return a nonzero result is the value to be accepted,</span>
+00041 <span class="comment">// and any modules after are ignored.</span>
+00042 
+00043 <span class="comment">// *********************************************************************************************</span>
+00044 
+<a name="l00045"></a><a class="code" href="modules_8h.html#a9">00045</a> <span class="preprocessor">#define FOREACH_RESULT(x) { MOD_RESULT = 0; \</span>
+00046 <span class="preprocessor">                        for (int i = 0; i &lt;= MODCOUNT; i++) { \</span>
+00047 <span class="preprocessor">                        int res = modules[i]-&gt;x ; \</span>
+00048 <span class="preprocessor">                        if (res) { \</span>
+00049 <span class="preprocessor">                                MOD_RESULT = res; \</span>
+00050 <span class="preprocessor">                                break; \</span>
+00051 <span class="preprocessor">                        } \</span>
+00052 <span class="preprocessor">                } \</span>
+00053 <span class="preprocessor">   } </span>
+00054 <span class="preprocessor"></span>   
+00055 <span class="comment">// *********************************************************************************************</span>
+00056 
+00057 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a13">createcommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams);
+00058 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a14">server_mode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user);
+00059 
+00060 <span class="comment">// class Version holds the version information of a Module, returned</span>
+00061 <span class="comment">// by Module::GetVersion (thanks RD)</span>
+00062 
+<a name="l00067"></a><a class="code" href="classVersion.html">00067</a> <span class="keyword">class </span><a class="code" href="classVersion.html">Version</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
+00068 {
+00069  <span class="keyword">public</span>:
+<a name="l00070"></a><a class="code" href="classVersion.html#m2">00070</a>          <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classVersion.html#m0">Major</a>, <a class="code" href="classVersion.html#m1">Minor</a>, <a class="code" href="classVersion.html#m2">Revision</a>, <a class="code" href="classVersion.html#m3">Build</a>;
+00071          <a class="code" href="classVersion.html#a0">Version</a>(<span class="keywordtype">int</span> major, <span class="keywordtype">int</span> minor, <span class="keywordtype">int</span> revision, <span class="keywordtype">int</span> build);
+00072 };
+00073 
+<a name="l00079"></a><a class="code" href="classAdmin.html">00079</a> <span class="keyword">class </span><a class="code" href="classAdmin.html">Admin</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
+00080 {
+00081  <span class="keyword">public</span>:
+<a name="l00082"></a><a class="code" href="classAdmin.html#m2">00082</a>          <span class="keyword">const</span> std::string <a class="code" href="classAdmin.html#m0">Name</a>, <a class="code" href="classAdmin.html#m1">Email</a>, <a class="code" href="classAdmin.html#m2">Nick</a>;
+00083          <a class="code" href="classAdmin.html#a0">Admin</a>(std::string name, std::string email, std::string nick);
+00084 };
+00085 
+<a name="l00091"></a><a class="code" href="classModule.html">00091</a> <span class="keyword">class </span><a class="code" href="classModule.html">Module</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
+00092 {
+00093  <span class="keyword">public</span>:
+00094 
+00098         <a class="code" href="classModule.html#a0">Module</a>();
+00099 
+00103         <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
+00104 
+00109         <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
+00110 
+00114         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a3">OnUserConnect</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
+00115 
+00119         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a4">OnUserQuit</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
 00120 
-00121 
-<a name="l00127"></a><a class="code" href="classServer.html">00127</a> <span class="keyword">class </span><a class="code" href="classServer.html">Server</a>
-00128 {
-00129  <span class="keyword">public</span>:
-00133         <a class="code" href="classServer.html#a0">Server</a>();
-00137         <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
-00138 
-00142         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(string s);
-00147         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Debug</a>(string s);
-00152         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a4">Send</a>(<span class="keywordtype">int</span> Socket, string s);
-00157         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a5">SendServ</a>(<span class="keywordtype">int</span> Socket, string s);
-00162         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a6">SendFrom</a>(<span class="keywordtype">int</span> Socket, <a class="code" href="classuserrec.html">userrec</a>* User, string s);
-00167         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a7">SendTo</a>(<a class="code" href="classuserrec.html">userrec</a>* Source, <a class="code" href="classuserrec.html">userrec</a>* Dest, string s);
-00174         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a8">SendChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Channel, string s,<span class="keywordtype">bool</span> IncludeSender);
-00179         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a9">CommonChannels</a>(<a class="code" href="classuserrec.html">userrec</a>* u1, <a class="code" href="classuserrec.html">userrec</a>* u2);
-00187         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a10">SendCommon</a>(<a class="code" href="classuserrec.html">userrec</a>* User, string text,<span class="keywordtype">bool</span> IncludeSender);
-00192         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a11">SendWallops</a>(<a class="code" href="classuserrec.html">userrec</a>* User, string text);
-00193 
-00197         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(string nick);
-00201         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">FindNick</a>(string nick);
-00205         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">FindChannel</a>(string channel);
-00210         <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a15">ChanMode</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Chan);
-00213         <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a16">GetServerName</a>();
-00216         <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a17">GetNetworkName</a>();
-00222         <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>();
-00223          
-00224 };
-00225 
-<a name="l00232"></a><a class="code" href="classConfigReader.html">00232</a> <span class="keyword">class </span><a class="code" href="classConfigReader.html">ConfigReader</a>
-00233 {
-00234   <span class="keyword">protected</span>:
-<a name="l00237"></a><a class="code" href="classConfigReader.html#n0">00237</a>         string <a class="code" href="classConfigReader.html#n0">fname</a>;
-00238   <span class="keyword">public</span>:
-00243         <a class="code" href="classConfigReader.html#a0">ConfigReader</a>();                 <span class="comment">// default constructor reads ircd.conf</span>
-00247 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(string filename);  <span class="comment">// read a module-specific config</span>
-00251 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
-00256         string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index);
-00263         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(string tag);
-00267         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
-00268 };
-00269 
-00270 
-00271 
-<a name="l00277"></a><a class="code" href="classFileReader.html">00277</a> <span class="keyword">class </span><a class="code" href="classFileReader.html">FileReader</a>
-00278 {
-<a name="l00279"></a><a class="code" href="classFileReader.html#o0">00279</a>  <a class="code" href="modules_8h.html#a1">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
-00280  <span class="keyword">public</span>:
-00285          <a class="code" href="classFileReader.html#a0">FileReader</a>();
-00291          <a class="code" href="classFileReader.html#a0">FileReader</a>(string filename);
-00295          <a class="code" href="classFileReader.html#a2">~FileReader</a>();
-00301          <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(string filename);
-00306          string <a class="code" href="classFileReader.html#a4">GetLine</a>(<span class="keywordtype">int</span> x);
-00312          <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileSize</a>();
-00313 };
-00314 
-00315 
-<a name="l00322"></a><a class="code" href="classModuleFactory.html">00322</a> <span class="keyword">class </span><a class="code" href="classModuleFactory.html">ModuleFactory</a>
-00323 {
-00324  <span class="keyword">public</span>:
-<a name="l00325"></a><a class="code" href="classModuleFactory.html#a0">00325</a>         <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
-<a name="l00326"></a><a class="code" href="classModuleFactory.html#a1">00326</a>         <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
-00331         <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
-00332 };
-00333 
-00334 <span class="preprocessor">#endif</span>
-</pre></div><hr><address style="align: right;"><small>Generated on Thu Jan 23 20:28:57 2003 for InspIRCd by
+00125         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a5">OnUserJoin</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel);
+00126 
+00131         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a6">OnUserPart</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* channel);
+00132 
+00139         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a7">OnPacketTransmit</a>(<span class="keywordtype">char</span> *p);
+00140 
+00148         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a8">OnPacketReceive</a>(<span class="keywordtype">char</span> *p);
+00149 
+00155         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">OnRehash</a>();
+00156 
+00163         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a10">OnServerRaw</a>(std::string &amp;raw, <span class="keywordtype">bool</span> inbound);
+00164 
+00174         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classModule.html#a11">OnExtendedMode</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <span class="keywordtype">void</span>* target, <span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> mode_on, string_list &amp;params);
+00175         
+00188         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a12">OnUserPreJoin</a>(<a class="code" href="classuserrec.html">userrec</a>* user, <a class="code" href="classchanrec.html">chanrec</a>* chan, <span class="keyword">const</span> <span class="keywordtype">char</span>* cname);
+00189         
+00190         
+00195         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a13">OnOper</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
+00196         
+00205         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a14">OnInfo</a>(<a class="code" href="classuserrec.html">userrec</a>* user);
+00206         
+00211         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a15">OnWhois</a>(<a class="code" href="classuserrec.html">userrec</a>* source, <a class="code" href="classuserrec.html">userrec</a>* dest);
+00212         
+00221         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a16">OnUserPreMessage</a>(<a class="code" href="classuserrec.html">userrec</a>* user,<span class="keywordtype">void</span>* dest,<span class="keywordtype">int</span> target_type, std::string text);
+00222 
+00231         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classModule.html#a17">OnUserPreNotice</a>(<a class="code" href="classuserrec.html">userrec</a>* user,<span class="keywordtype">void</span>* dest,<span class="keywordtype">int</span> target_type, std::string text);
+00232 };
+00233 
+00234 
+<a name="l00240"></a><a class="code" href="classServer.html">00240</a> <span class="keyword">class </span><a class="code" href="classServer.html">Server</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
+00241 {
+00242  <span class="keyword">public</span>:
+00246         <a class="code" href="classServer.html#a0">Server</a>();
+00250         <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
+00251 
+00255         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(std::string s);
+00260         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Log</a>(<span class="keywordtype">int</span> level, std::string s);
+00265         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a4">Send</a>(<span class="keywordtype">int</span> Socket, std::string s);
+00270         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a5">SendServ</a>(<span class="keywordtype">int</span> Socket, std::string s);
+00275         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a6">SendFrom</a>(<span class="keywordtype">int</span> Socket, <a class="code" href="classuserrec.html">userrec</a>* User, std::string s);
+00290         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a7">SendTo</a>(<a class="code" href="classuserrec.html">userrec</a>* Source, <a class="code" href="classuserrec.html">userrec</a>* Dest, std::string s);
+00297         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a8">SendChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Channel, std::string s,<span class="keywordtype">bool</span> IncludeSender);
+00302         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a9">CommonChannels</a>(<a class="code" href="classuserrec.html">userrec</a>* u1, <a class="code" href="classuserrec.html">userrec</a>* u2);
+00310         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a10">SendCommon</a>(<a class="code" href="classuserrec.html">userrec</a>* User, std::string text,<span class="keywordtype">bool</span> IncludeSender);
+00315         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a11">SendWallops</a>(<a class="code" href="classuserrec.html">userrec</a>* User, std::string text);
+00316 
+00320         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(std::string nick);
+00324         <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classServer.html#a13">CountUsers</a>(<a class="code" href="classchanrec.html">chanrec</a>* c);
+00328         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a14">FindNick</a>(std::string nick);
+00332         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a15">FindChannel</a>(std::string channel);
+00337         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a16">ChanMode</a>(<a class="code" href="classuserrec.html">userrec</a>* User, <a class="code" href="classchanrec.html">chanrec</a>* Chan);
+00340         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a17">GetServerName</a>();
+00343         <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a18">GetNetworkName</a>();
+00349         <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a19">GetAdmin</a>();
+00368         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a20">AddExtendedMode</a>(<span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> requires_oper, <span class="keywordtype">int</span> params_when_on, <span class="keywordtype">int</span> params_when_off);
+00369 
+00384         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a21">AddCommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams);
+00385          
+00407         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a22">SendMode</a>(<span class="keywordtype">char</span> **parameters, <span class="keywordtype">int</span> pcnt, <a class="code" href="classuserrec.html">userrec</a> *user);
+00408         
+00421         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a23">SendToModeMask</a>(std::string modes, <span class="keywordtype">int</span> flags, std::string text);
+00422 
+00428         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a24">JoinUserToChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string cname, std::string key);
+00429         
+00435         <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a25">PartUserFromChannel</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string cname, std::string reason);
+00436         
+00442         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a26">ChangeUserNick</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string nickname);
+00443         
+00454         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a27">QuitUser</a>(<a class="code" href="classuserrec.html">userrec</a>* user, std::string reason);
+00455         
+00460         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a28">MatchText</a>(std::string sliteral, std::string spattern);
+00461 };
+00462 
+<a name="l00469"></a><a class="code" href="classConfigReader.html">00469</a> <span class="keyword">class </span><a class="code" href="classConfigReader.html">ConfigReader</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
+00470 {
+00471   <span class="keyword">protected</span>:
+<a name="l00477"></a><a class="code" href="classConfigReader.html#n0">00477</a>         std::stringstream *<a class="code" href="classConfigReader.html#n0">cache</a>;
+<a name="l00480"></a><a class="code" href="classConfigReader.html#n1">00480</a>         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#n1">error</a>;
+00481         
+00482   <span class="keyword">public</span>:
+00487         <a class="code" href="classConfigReader.html#a0">ConfigReader</a>();                 <span class="comment">// default constructor reads ircd.conf</span>
+00491 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(std::string filename);     <span class="comment">// read a module-specific config</span>
+00495 <span class="comment"></span>        <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
+00500         std::string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index);
+00507         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(std::string tag);
+00512         <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
+00513 
+00519         <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a6">EnumerateValues</a>(std::string tag, <span class="keywordtype">int</span> index);
+00520 };
+00521 
+00522 
+00523 
+<a name="l00529"></a><a class="code" href="classFileReader.html">00529</a> <span class="keyword">class </span><a class="code" href="classFileReader.html">FileReader</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
+00530 {
+<a name="l00531"></a><a class="code" href="classFileReader.html#o0">00531</a>  <a class="code" href="modules_8h.html#a10">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
+00532  <span class="keyword">public</span>:
+00537          <a class="code" href="classFileReader.html#a0">FileReader</a>();
+00538 
+00544          <a class="code" href="classFileReader.html#a0">FileReader</a>(std::string filename);
+00545 
+00549          <a class="code" href="classFileReader.html#a2">~FileReader</a>();
+00550 
+00556          <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(std::string filename);
+00557 
+00561          <span class="keywordtype">bool</span> <a class="code" href="classFileReader.html#a4">Exists</a>();
+00562          
+00567          std::string <a class="code" href="classFileReader.html#a5">GetLine</a>(<span class="keywordtype">int</span> x);
+00568 
+00574          <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a6">FileSize</a>();
+00575 };
+00576 
+00577 
+<a name="l00584"></a><a class="code" href="classModuleFactory.html">00584</a> <span class="keyword">class </span><a class="code" href="classModuleFactory.html">ModuleFactory</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
+00585 {
+00586  <span class="keyword">public</span>:
+<a name="l00587"></a><a class="code" href="classModuleFactory.html#a0">00587</a>         <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
+<a name="l00588"></a><a class="code" href="classModuleFactory.html#a1">00588</a>         <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
+00593         <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
+00594 };
+00595 
+00596 
+<a name="l00597"></a><a class="code" href="modules_8h.html#a12">00597</a> <span class="keyword">typedef</span> DLLFactory&lt;ModuleFactory&gt; <a class="code" href="modules_8h.html#a12">ircd_module</a>;
+00598 
+00599 <span class="preprocessor">#endif</span>
+</pre></div><hr><address style="align: right;"><small>Generated on Thu Apr 8 19:12:27 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-rc2 </small></address>
+width=110 height=53></a>1.3-rc3 </small></address>
 </body>
 </html>