diff options
Diffstat (limited to 'docs/module-doc/modules_8h-source.html')
| -rw-r--r-- | docs/module-doc/modules_8h-source.html | 209 |
1 files changed, 105 insertions, 104 deletions
diff --git a/docs/module-doc/modules_8h-source.html b/docs/module-doc/modules_8h-source.html index 6c4a1e489..6d1bafadd 100644 --- a/docs/module-doc/modules_8h-source.html +++ b/docs/module-doc/modules_8h-source.html @@ -9,8 +9,8 @@ <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">Revision 1.3 2003/01/26 23:52:48 brain +00003 <span class="comment">Modified documentation for base classes 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> @@ -47,114 +47,115 @@ 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 <string></span> -00040 <span class="preprocessor">#include <deque></span> -00041 -<a name="l00044"></a><a class="code" href="modules_8h.html#a1">00044</a> <span class="keyword">typedef</span> deque<string> <a class="code" href="modules_8h.html#a1">file_cache</a>; -00045 +00039 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span> +00040 <span class="preprocessor">#include <string></span> +00041 <span class="preprocessor">#include <deque></span> +00042 +<a name="l00045"></a><a class="code" href="modules_8h.html#a1">00045</a> <span class="keyword">typedef</span> deque<string> <a class="code" href="modules_8h.html#a1">file_cache</a>; 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 <= MODCOUNT; i++) modules[i]-></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 +00047 +00048 <span class="comment">// This #define allows us to call a method in all</span> +00049 <span class="comment">// loaded modules in a readable simple way, e.g.:</span> +00050 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span> +00051 +<a name="l00052"></a><a class="code" href="modules_8h.html#a0">00052</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]-></span> +00053 <span class="preprocessor"></span> +00054 <span class="comment">// class Version holds the version information of a Module, returned</span> +00055 <span class="comment">// by Module::GetVersion (thanks RD)</span> +00056 +<a name="l00061"></a><a class="code" href="classVersion.html">00061</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> +00062 { +00063 <span class="keyword">public</span>: +<a name="l00064"></a><a class="code" href="classVersion.html#m2">00064</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>; +00065 <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); +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 }; -00120 +00068 +<a name="l00074"></a><a class="code" href="classAdmin.html">00074</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> +00075 { +00076 <span class="keyword">public</span>: +<a name="l00077"></a><a class="code" href="classAdmin.html#m2">00077</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>; +00078 <a class="code" href="classAdmin.html#a0">Admin</a>(string name,string email,string nick); +00079 }; +00080 +<a name="l00086"></a><a class="code" href="classModule.html">00086</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> +00087 { +00088 <span class="keyword">public</span>: +00092 <a class="code" href="classModule.html#a0">Module</a>(); +00096 <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>(); +00101 <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>(); +00105 <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); +00109 <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); +00114 <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); +00119 <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); +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 +00122 +<a name="l00128"></a><a class="code" href="classServer.html">00128</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> +00129 { +00130 <span class="keyword">public</span>: +00134 <a class="code" href="classServer.html#a0">Server</a>(); +00138 <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>(); +00139 +00143 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(string s); +00148 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a3">Debug</a>(string s); +00153 <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); +00158 <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); +00163 <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); +00168 <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); +00175 <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); +00180 <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); +00188 <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); +00193 <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); +00194 +00198 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(string nick); +00202 <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">FindNick</a>(string nick); +00206 <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">FindChannel</a>(string channel); +00211 <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); +00214 <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a16">GetServerName</a>(); +00217 <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a17">GetNetworkName</a>(); +00223 <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>(); +00224 +00225 }; +00226 +<a name="l00233"></a><a class="code" href="classConfigReader.html">00233</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> +00234 { +00235 <span class="keyword">protected</span>: +<a name="l00238"></a><a class="code" href="classConfigReader.html#n0">00238</a> string <a class="code" href="classConfigReader.html#n0">fname</a>; +00239 <span class="keyword">public</span>: +00244 <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(); <span class="comment">// default constructor reads ircd.conf</span> +00248 <span class="comment"></span> <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(string filename); <span class="comment">// read a module-specific config</span> +00252 <span class="comment"></span> <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>(); +00257 string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index); +00264 <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(string tag); +00268 <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>(); +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 +00272 +<a name="l00278"></a><a class="code" href="classFileReader.html">00278</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> +00279 { +<a name="l00280"></a><a class="code" href="classFileReader.html#o0">00280</a> <a class="code" href="modules_8h.html#a1">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>; +00281 <span class="keyword">public</span>: +00286 <a class="code" href="classFileReader.html#a0">FileReader</a>(); +00292 <a class="code" href="classFileReader.html#a0">FileReader</a>(string filename); +00296 <a class="code" href="classFileReader.html#a2">~FileReader</a>(); +00302 <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(string filename); +00307 string <a class="code" href="classFileReader.html#a4">GetLine</a>(<span class="keywordtype">int</span> x); +00313 <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileSize</a>(); +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 +00316 +<a name="l00323"></a><a class="code" href="classModuleFactory.html">00323</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> +00324 { +00325 <span class="keyword">public</span>: +<a name="l00326"></a><a class="code" href="classModuleFactory.html#a0">00326</a> <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { } +<a name="l00327"></a><a class="code" href="classModuleFactory.html#a1">00327</a> <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { } +00332 <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0; +00333 }; +00334 +00335 <span class="preprocessor">#endif</span> +</pre></div><hr><address style="align: right;"><small>Generated on Sun Jan 26 23:45:47 2003 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> |