1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>Module class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
6 <!-- Generated by Doxygen 1.3-rc2 -->
8 <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>
9 <hr><h1>Module Class Reference</h1>Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
10 <a href="#_details">More...</a>
12 <code>#include <<a class="el" href="modules_8h-source.html">modules.h</a>></code>
14 <p>Inheritance diagram for Module:
15 <p><center><img src="classModule.png" usemap="#Module_map" border="0" alt=""></center>
16 <map name="Module_map">
17 <area href="classclassbase.html" alt="classbase" shape="rect" coords="0,0,68,24">
19 <a href="classModule-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
22 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classModule.html#a0">Module</a> ()</td></tr>
23 <tr><td> </td><td><font size=-1><em>Default constructor creates a module class.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
24 <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classModule.html#a1">~Module</a> ()</td></tr>
25 <tr><td> </td><td><font size=-1><em>Default destructor destroys a module class.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
26 <tr><td nowrap align=right valign=top>virtual <a class="el" href="classVersion.html">Version</a> </td><td valign=bottom><a class="el" href="classModule.html#a2">GetVersion</a> ()</td></tr>
27 <tr><td> </td><td><font size=-1><em>Returns the version number of a Module.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
28 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classModule.html#a3">OnUserConnect</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
29 <tr><td> </td><td><font size=-1><em>Called when a user connects.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
30 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classModule.html#a4">OnUserQuit</a> (<a class="el" href="classuserrec.html">userrec</a> *user)</td></tr>
31 <tr><td> </td><td><font size=-1><em>Called when a user quits.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
32 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classModule.html#a5">OnUserJoin</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr>
33 <tr><td> </td><td><font size=-1><em>Called when a user joins a channel.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
34 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classModule.html#a6">OnUserPart</a> (<a class="el" href="classuserrec.html">userrec</a> *user, <a class="el" href="classchanrec.html">chanrec</a> *channel)</td></tr>
35 <tr><td> </td><td><font size=-1><em>Called when a user parts a channel.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
37 <hr><a name="_details"></a><h2>Detailed Description</h2>
38 Base class for all InspIRCd modules This class is the base class for InspIRCd modules.
40 All modules must inherit from this class, its methods will be called when irc server events occur. class inherited from module must be instantiated by the <a class="el" href="classModuleFactory.html">ModuleFactory</a> class (see relevent section) for the plugin to be initialised.
44 Definition at line <a class="el" href="modules_8h-source.html#l00090">90</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
45 <a name="a0" doxytag="Module::Module"></a><p>
46 <table width="100%" cellpadding="2" cellspacing="0" border="0">
49 <table cellpadding="0" cellspacing="0" border="0">
51 <td class="md" nowrap valign="top"> Module::Module </td>
52 <td class="md" valign="top">( </td>
53 <td class="mdname1" valign="top" nowrap> </td>
54 <td class="md" valign="top">) </td>
55 <td class="md" nowrap></td>
62 <table cellspacing=5 cellpadding=0 border=0>
70 Default constructor creates a module class.
74 Definition at line <a class="el" href="modules_8cpp-source.html#l00043">43</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
76 <div class="fragment"><pre>00043 { }
80 <a name="a1" doxytag="Module::~Module"></a><p>
81 <table width="100%" cellpadding="2" cellspacing="0" border="0">
84 <table cellpadding="0" cellspacing="0" border="0">
86 <td class="md" nowrap valign="top"> Module::~Module </td>
87 <td class="md" valign="top">( </td>
88 <td class="mdname1" valign="top" nowrap> </td>
89 <td class="md" valign="top">) </td>
90 <td class="md" nowrap><code> [virtual]</code></td>
97 <table cellspacing=5 cellpadding=0 border=0>
105 Default destructor destroys a module class.
109 Definition at line <a class="el" href="modules_8cpp-source.html#l00044">44</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
111 <div class="fragment"><pre>00044 { }
115 <hr><h2>Member Function Documentation</h2>
116 <a name="a2" doxytag="Module::GetVersion"></a><p>
117 <table width="100%" cellpadding="2" cellspacing="0" border="0">
120 <table cellpadding="0" cellspacing="0" border="0">
122 <td class="md" nowrap valign="top"> <a class="el" href="classVersion.html">Version</a> Module::GetVersion </td>
123 <td class="md" valign="top">( </td>
124 <td class="mdname1" valign="top" nowrap> </td>
125 <td class="md" valign="top">) </td>
126 <td class="md" nowrap><code> [virtual]</code></td>
133 <table cellspacing=5 cellpadding=0 border=0>
141 Returns the version number of a Module.
143 The method should return a <a class="el" href="classVersion.html">Version</a> object with its version information assigned via <a class="el" href="classVersion.html#a0">Version::Version</a>
145 Definition at line <a class="el" href="modules_8cpp-source.html#l00049">49</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
147 <div class="fragment"><pre>00049 { <span class="keywordflow">return</span> <a class="code" href="classVersion.html">Version</a>(1,0,0,0); }
151 <a name="a3" doxytag="Module::OnUserConnect"></a><p>
152 <table width="100%" cellpadding="2" cellspacing="0" border="0">
155 <table cellpadding="0" cellspacing="0" border="0">
157 <td class="md" nowrap valign="top"> void Module::OnUserConnect </td>
158 <td class="md" valign="top">( </td>
159 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
160 <td class="mdname1" valign="top" nowrap> <em>user</em> </td>
161 <td class="md" valign="top">) </td>
162 <td class="md" nowrap><code> [virtual]</code></td>
169 <table cellspacing=5 cellpadding=0 border=0>
177 Called when a user connects.
179 The details of the connecting user are available to you in the parameter userrec *user
181 Definition at line <a class="el" href="modules_8cpp-source.html#l00045">45</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
183 <div class="fragment"><pre>00045 { }
187 <a name="a5" doxytag="Module::OnUserJoin"></a><p>
188 <table width="100%" cellpadding="2" cellspacing="0" border="0">
191 <table cellpadding="0" cellspacing="0" border="0">
193 <td class="md" nowrap valign="top"> void Module::OnUserJoin </td>
194 <td class="md" valign="top">( </td>
195 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
196 <td class="mdname" nowrap> <em>user</em>, </td>
201 <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td>
202 <td class="mdname" nowrap> <em>channel</em></td>
206 <td class="md">) </td>
207 <td class="md" colspan="2"><code> [virtual]</code></td>
214 <table cellspacing=5 cellpadding=0 border=0>
222 Called when a user joins a channel.
224 The details of the joining user are available to you in the parameter userrec *user, and the details of the channel they have joined is available in the variable chanrec *channel
226 Definition at line <a class="el" href="modules_8cpp-source.html#l00047">47</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
228 <div class="fragment"><pre>00047 { }
232 <a name="a6" doxytag="Module::OnUserPart"></a><p>
233 <table width="100%" cellpadding="2" cellspacing="0" border="0">
236 <table cellpadding="0" cellspacing="0" border="0">
238 <td class="md" nowrap valign="top"> void Module::OnUserPart </td>
239 <td class="md" valign="top">( </td>
240 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
241 <td class="mdname" nowrap> <em>user</em>, </td>
246 <td class="md" nowrap><a class="el" href="classchanrec.html">chanrec</a> * </td>
247 <td class="mdname" nowrap> <em>channel</em></td>
251 <td class="md">) </td>
252 <td class="md" colspan="2"><code> [virtual]</code></td>
259 <table cellspacing=5 cellpadding=0 border=0>
267 Called when a user parts a channel.
269 The details of the leaving user are available to you in the parameter userrec *user, and the details of the channel they have left is available in the variable chanrec *channel
271 Definition at line <a class="el" href="modules_8cpp-source.html#l00048">48</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
273 <div class="fragment"><pre>00048 { }
277 <a name="a4" doxytag="Module::OnUserQuit"></a><p>
278 <table width="100%" cellpadding="2" cellspacing="0" border="0">
281 <table cellpadding="0" cellspacing="0" border="0">
283 <td class="md" nowrap valign="top"> void Module::OnUserQuit </td>
284 <td class="md" valign="top">( </td>
285 <td class="md" nowrap valign="top"><a class="el" href="classuserrec.html">userrec</a> * </td>
286 <td class="mdname1" valign="top" nowrap> <em>user</em> </td>
287 <td class="md" valign="top">) </td>
288 <td class="md" nowrap><code> [virtual]</code></td>
295 <table cellspacing=5 cellpadding=0 border=0>
303 Called when a user quits.
305 The details of the exiting user are available to you in the parameter userrec *user
307 Definition at line <a class="el" href="modules_8cpp-source.html#l00046">46</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
309 <div class="fragment"><pre>00046 { }
313 <hr>The documentation for this class was generated from the following files:<ul>
314 <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
315 <hr><address style="align: right;"><small>Generated on Mon Jan 27 00:23:13 2003 for InspIRCd by
316 <a href="http://www.doxygen.org/index.html">
317 <img src="doxygen.png" alt="doxygen" align="middle" border=0
318 width=110 height=53></a>1.3-rc2 </small></address>