mirror of
https://github.com/inspircd/inspircd.git
synced 2025-04-02 06:10:03 -04:00
7455e1c881
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@171 e03df62e-2008-0410-955e-edbf42e46eb7
159 lines
15 KiB
HTML
159 lines
15 KiB
HTML
<!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">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.3-rc3 -->
|
|
<center>
|
|
<a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </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"></span>
|
|
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>
|
|
00017 <span class="preprocessor">#include "dynamic.h"</span>
|
|
00018 <span class="preprocessor">#include "<a class="code" href="base_8h.html">base.h</a>"</span>
|
|
00019 <span class="preprocessor">#include <string></span>
|
|
00020 <span class="preprocessor">#include <deque></span>
|
|
00021
|
|
<a name="l00024"></a><a class="code" href="modules_8h.html#a6">00024</a> <span class="keyword">typedef</span> deque<string> <a class="code" href="modules_8h.html#a6">file_cache</a>;
|
|
00025
|
|
00026
|
|
00027 <span class="comment">// This #define allows us to call a method in all</span>
|
|
00028 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
|
|
00029 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
|
|
00030
|
|
<a name="l00031"></a><a class="code" href="modules_8h.html#a5">00031</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]-></span>
|
|
00032 <span class="preprocessor"></span>
|
|
00033 <span class="comment">// class Version holds the version information of a Module, returned</span>
|
|
00034 <span class="comment">// by Module::GetVersion (thanks RD)</span>
|
|
00035
|
|
<a name="l00040"></a><a class="code" href="classVersion.html">00040</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>
|
|
00041 {
|
|
00042 <span class="keyword">public</span>:
|
|
<a name="l00043"></a><a class="code" href="classVersion.html#m2">00043</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>;
|
|
00044 <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);
|
|
00045 };
|
|
00046
|
|
00047
|
|
<a name="l00053"></a><a class="code" href="classAdmin.html">00053</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>
|
|
00054 {
|
|
00055 <span class="keyword">public</span>:
|
|
<a name="l00056"></a><a class="code" href="classAdmin.html#m2">00056</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>;
|
|
00057 <a class="code" href="classAdmin.html#a0">Admin</a>(string name,string email,string nick);
|
|
00058 };
|
|
00059
|
|
<a name="l00065"></a><a class="code" href="classModule.html">00065</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>
|
|
00066 {
|
|
00067 <span class="keyword">public</span>:
|
|
00068
|
|
00072 <a class="code" href="classModule.html#a0">Module</a>();
|
|
00073
|
|
00077 <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
|
|
00078
|
|
00083 <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
|
|
00084
|
|
00088 <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);
|
|
00089
|
|
00093 <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);
|
|
00094
|
|
00099 <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);
|
|
00100
|
|
00105 <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);
|
|
00106
|
|
00113 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a7">Module::OnPacketTransmit</a>(<span class="keywordtype">char</span> *p);
|
|
00114
|
|
00122 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a8">Module::OnPacketReceive</a>(<span class="keywordtype">char</span> *p);
|
|
00123
|
|
00129 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">OnRehash</a>();
|
|
00130
|
|
00137 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a10">Module::OnServerRaw</a>(string &raw, <span class="keywordtype">bool</span> inbound);
|
|
00138
|
|
00139 };
|
|
00140
|
|
00141
|
|
<a name="l00147"></a><a class="code" href="classServer.html">00147</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>
|
|
00148 {
|
|
00149 <span class="keyword">public</span>:
|
|
00153 <a class="code" href="classServer.html#a0">Server</a>();
|
|
00157 <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
|
|
00158
|
|
00162 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(string s);
|
|
00167 <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, string s);
|
|
00172 <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);
|
|
00177 <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);
|
|
00182 <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);
|
|
00187 <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);
|
|
00194 <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);
|
|
00199 <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);
|
|
00207 <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);
|
|
00212 <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);
|
|
00213
|
|
00217 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(string nick);
|
|
00221 <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">FindNick</a>(string nick);
|
|
00225 <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">FindChannel</a>(string channel);
|
|
00230 <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);
|
|
00233 <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a16">GetServerName</a>();
|
|
00236 <span class="keyword">virtual</span> string <a class="code" href="classServer.html#a17">GetNetworkName</a>();
|
|
00242 <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>();
|
|
00243
|
|
00244 };
|
|
00245
|
|
<a name="l00252"></a><a class="code" href="classConfigReader.html">00252</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>
|
|
00253 {
|
|
00254 <span class="keyword">protected</span>:
|
|
<a name="l00257"></a><a class="code" href="classConfigReader.html#n0">00257</a> string <a class="code" href="classConfigReader.html#n0">fname</a>;
|
|
00258 <span class="keyword">public</span>:
|
|
00263 <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(); <span class="comment">// default constructor reads ircd.conf</span>
|
|
00267 <span class="comment"></span> <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(string filename); <span class="comment">// read a module-specific config</span>
|
|
00271 <span class="comment"></span> <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
|
|
00276 string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(string tag, string name, <span class="keywordtype">int</span> index);
|
|
00283 <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(string tag);
|
|
00287 <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
|
|
00288 };
|
|
00289
|
|
00290
|
|
00291
|
|
<a name="l00297"></a><a class="code" href="classFileReader.html">00297</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>
|
|
00298 {
|
|
<a name="l00299"></a><a class="code" href="classFileReader.html#o0">00299</a> <a class="code" href="modules_8h.html#a6">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
|
|
00300 <span class="keyword">public</span>:
|
|
00305 <a class="code" href="classFileReader.html#a0">FileReader</a>();
|
|
00311 <a class="code" href="classFileReader.html#a0">FileReader</a>(string filename);
|
|
00315 <a class="code" href="classFileReader.html#a2">~FileReader</a>();
|
|
00321 <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(string filename);
|
|
00326 string <a class="code" href="classFileReader.html#a4">GetLine</a>(<span class="keywordtype">int</span> x);
|
|
00332 <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a5">FileSize</a>();
|
|
00333 };
|
|
00334
|
|
00335
|
|
<a name="l00342"></a><a class="code" href="classModuleFactory.html">00342</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>
|
|
00343 {
|
|
00344 <span class="keyword">public</span>:
|
|
<a name="l00345"></a><a class="code" href="classModuleFactory.html#a0">00345</a> <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
|
|
<a name="l00346"></a><a class="code" href="classModuleFactory.html#a1">00346</a> <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
|
|
00351 <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
|
|
00352 };
|
|
00353
|
|
00354
|
|
<a name="l00355"></a><a class="code" href="modules_8h.html#a7">00355</a> <span class="keyword">typedef</span> DLLFactory<ModuleFactory> <a class="code" href="modules_8h.html#a7">ircd_module</a>;
|
|
00356
|
|
00357 <span class="preprocessor">#endif</span>
|
|
</pre></div><hr><address style="align: right;"><small>Generated on Sun Mar 30 19:34:54 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-rc3 </small></address>
|
|
</body>
|
|
</html>
|