mirror of
https://github.com/inspircd/inspircd.git
synced 2025-03-12 12:09:03 -04:00
a753fb1bc7
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@351 e03df62e-2008-0410-955e-edbf42e46eb7
171 lines
18 KiB
HTML
171 lines
18 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>
|
|
<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 <string></span>
|
|
00025 <span class="preprocessor">#include <deque></span>
|
|
00026
|
|
<a name="l00029"></a><a class="code" href="modules_8h.html#a9">00029</a> <span class="keyword">typedef</span> std::deque<std::string> <a class="code" href="modules_8h.html#a9">file_cache</a>;
|
|
<a name="l00030"></a><a class="code" href="modules_8h.html#a10">00030</a> <span class="keyword">typedef</span> <a class="code" href="modules_8h.html#a9">file_cache</a> <a class="code" href="modules_8h.html#a10">string_list</a>;
|
|
00031
|
|
00032 <span class="comment">// This #define allows us to call a method in all</span>
|
|
00033 <span class="comment">// loaded modules in a readable simple way, e.g.:</span>
|
|
00034 <span class="comment">// 'FOREACH_MOD OnConnect(user);'</span>
|
|
00035
|
|
<a name="l00036"></a><a class="code" href="modules_8h.html#a8">00036</a> <span class="preprocessor">#define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]-></span>
|
|
00037 <span class="preprocessor"></span>
|
|
00038 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="modules_8h.html#a12">createcommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams);
|
|
00039
|
|
00040 <span class="comment">// class Version holds the version information of a Module, returned</span>
|
|
00041 <span class="comment">// by Module::GetVersion (thanks RD)</span>
|
|
00042
|
|
<a name="l00047"></a><a class="code" href="classVersion.html">00047</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>
|
|
00048 {
|
|
00049 <span class="keyword">public</span>:
|
|
<a name="l00050"></a><a class="code" href="classVersion.html#m2">00050</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>;
|
|
00051 <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);
|
|
00052 };
|
|
00053
|
|
<a name="l00059"></a><a class="code" href="classAdmin.html">00059</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>
|
|
00060 {
|
|
00061 <span class="keyword">public</span>:
|
|
<a name="l00062"></a><a class="code" href="classAdmin.html#m2">00062</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>;
|
|
00063 <a class="code" href="classAdmin.html#a0">Admin</a>(std::string name, std::string email, std::string nick);
|
|
00064 };
|
|
00065
|
|
<a name="l00071"></a><a class="code" href="classModule.html">00071</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>
|
|
00072 {
|
|
00073 <span class="keyword">public</span>:
|
|
00074
|
|
00078 <a class="code" href="classModule.html#a0">Module</a>();
|
|
00079
|
|
00083 <span class="keyword">virtual</span> <a class="code" href="classModule.html#a1">~Module</a>();
|
|
00084
|
|
00089 <span class="keyword">virtual</span> <a class="code" href="classVersion.html">Version</a> <a class="code" href="classModule.html#a2">GetVersion</a>();
|
|
00090
|
|
00094 <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);
|
|
00095
|
|
00099 <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);
|
|
00100
|
|
00105 <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);
|
|
00106
|
|
00111 <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);
|
|
00112
|
|
00119 <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);
|
|
00120
|
|
00128 <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);
|
|
00129
|
|
00135 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a9">OnRehash</a>();
|
|
00136
|
|
00143 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classModule.html#a10">OnServerRaw</a>(std::string &raw, <span class="keywordtype">bool</span> inbound);
|
|
00144
|
|
00153 <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, <a class="code" href="classchanrec.html">chanrec</a>* chan, <span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> mode_on, string_list &params);
|
|
00154
|
|
00155 };
|
|
00156
|
|
00157
|
|
<a name="l00163"></a><a class="code" href="classServer.html">00163</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>
|
|
00164 {
|
|
00165 <span class="keyword">public</span>:
|
|
00169 <a class="code" href="classServer.html#a0">Server</a>();
|
|
00173 <span class="keyword">virtual</span> <a class="code" href="classServer.html#a1">~Server</a>();
|
|
00174
|
|
00178 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a2">SendOpers</a>(std::string s);
|
|
00183 <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);
|
|
00188 <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);
|
|
00193 <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);
|
|
00198 <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);
|
|
00203 <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);
|
|
00210 <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);
|
|
00215 <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);
|
|
00223 <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);
|
|
00228 <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);
|
|
00229
|
|
00233 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a12">IsNick</a>(std::string nick);
|
|
00237 <span class="keyword">virtual</span> <a class="code" href="classuserrec.html">userrec</a>* <a class="code" href="classServer.html#a13">FindNick</a>(std::string nick);
|
|
00241 <span class="keyword">virtual</span> <a class="code" href="classchanrec.html">chanrec</a>* <a class="code" href="classServer.html#a14">FindChannel</a>(std::string channel);
|
|
00246 <span class="keyword">virtual</span> std::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);
|
|
00249 <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a16">GetServerName</a>();
|
|
00252 <span class="keyword">virtual</span> std::string <a class="code" href="classServer.html#a17">GetNetworkName</a>();
|
|
00258 <span class="keyword">virtual</span> <a class="code" href="classAdmin.html">Admin</a> <a class="code" href="classServer.html#a18">GetAdmin</a>();
|
|
00276 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classServer.html#a19">AddExtendedMode</a>(<span class="keywordtype">char</span> modechar, <span class="keywordtype">int</span> type, <span class="keywordtype">bool</span> default_on, <span class="keywordtype">int</span> params_when_on, <span class="keywordtype">int</span> params_when_off);
|
|
00277
|
|
00292 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classServer.html#a20">AddCommand</a>(<span class="keywordtype">char</span>* cmd, handlerfunc f, <span class="keywordtype">char</span> flags, <span class="keywordtype">int</span> minparams);
|
|
00293
|
|
00294 };
|
|
00295
|
|
<a name="l00302"></a><a class="code" href="classConfigReader.html">00302</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>
|
|
00303 {
|
|
00304 <span class="keyword">protected</span>:
|
|
<a name="l00307"></a><a class="code" href="classConfigReader.html#n0">00307</a> std::string <a class="code" href="classConfigReader.html#n0">fname</a>;
|
|
00308 <span class="keyword">public</span>:
|
|
00313 <a class="code" href="classConfigReader.html#a0">ConfigReader</a>(); <span class="comment">// default constructor reads ircd.conf</span>
|
|
00317 <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>
|
|
00321 <span class="comment"></span> <a class="code" href="classConfigReader.html#a2">~ConfigReader</a>();
|
|
00326 std::string <a class="code" href="classConfigReader.html#a3">ReadValue</a>(std::string tag, std::string name, <span class="keywordtype">int</span> index);
|
|
00333 <span class="keywordtype">int</span> <a class="code" href="classConfigReader.html#a4">Enumerate</a>(std::string tag);
|
|
00337 <span class="keywordtype">bool</span> <a class="code" href="classConfigReader.html#a5">Verify</a>();
|
|
00338 };
|
|
00339
|
|
00340
|
|
00341
|
|
<a name="l00347"></a><a class="code" href="classFileReader.html">00347</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>
|
|
00348 {
|
|
<a name="l00349"></a><a class="code" href="classFileReader.html#o0">00349</a> <a class="code" href="modules_8h.html#a9">file_cache</a> <a class="code" href="classFileReader.html#o0">fc</a>;
|
|
00350 <span class="keyword">public</span>:
|
|
00355 <a class="code" href="classFileReader.html#a0">FileReader</a>();
|
|
00361 <a class="code" href="classFileReader.html#a0">FileReader</a>(std::string filename);
|
|
00365 <a class="code" href="classFileReader.html#a2">~FileReader</a>();
|
|
00371 <span class="keywordtype">void</span> <a class="code" href="classFileReader.html#a3">LoadFile</a>(std::string filename);
|
|
00376 <span class="keywordtype">bool</span> <a class="code" href="classFileReader.html#a4">Exists</a>();
|
|
00377 std::string <a class="code" href="classFileReader.html#a5">GetLine</a>(<span class="keywordtype">int</span> x);
|
|
00383 <span class="keywordtype">int</span> <a class="code" href="classFileReader.html#a6">FileSize</a>();
|
|
00384 };
|
|
00385
|
|
00386
|
|
<a name="l00393"></a><a class="code" href="classModuleFactory.html">00393</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>
|
|
00394 {
|
|
00395 <span class="keyword">public</span>:
|
|
<a name="l00396"></a><a class="code" href="classModuleFactory.html#a0">00396</a> <a class="code" href="classModuleFactory.html#a0">ModuleFactory</a>() { }
|
|
<a name="l00397"></a><a class="code" href="classModuleFactory.html#a1">00397</a> <span class="keyword">virtual</span> <a class="code" href="classModuleFactory.html#a1">~ModuleFactory</a>() { }
|
|
00402 <span class="keyword">virtual</span> <a class="code" href="classModule.html">Module</a> * <a class="code" href="classModuleFactory.html#a2">CreateModule</a>() = 0;
|
|
00403 };
|
|
00404
|
|
00405
|
|
<a name="l00406"></a><a class="code" href="modules_8h.html#a11">00406</a> <span class="keyword">typedef</span> DLLFactory<ModuleFactory> <a class="code" href="modules_8h.html#a11">ircd_module</a>;
|
|
00407
|
|
00408 <span class="preprocessor">#endif</span>
|
|
</pre></div><hr><address style="align: right;"><small>Generated on Fri Apr 2 13:37: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-rc3 </small></address>
|
|
</body>
|
|
</html>
|