docs/module-doc/classModuleFactory.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>InspIRCd: ModuleFactory Class Reference</title>
   4 <link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.4.4-20050815 -->
   7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>ModuleFactory Class Reference</h1><!-- doxytag: class="ModuleFactory" --><!-- doxytag: inherits="classbase" -->Instantiates classes inherited from <a class="el" href="classModule.html">Module</a> This class creates a class inherited from type <a class="el" href="classModule.html">Module</a>, using new.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
  12 <p>
  13 Inheritance diagram for ModuleFactory:<p><center><img src="classModuleFactory__inherit__graph.gif" border="0" usemap="#ModuleFactory__inherit__map" alt="Inheritance graph"></center>
  14 <map name="ModuleFactory__inherit__map">
  15 <area href="classclassbase.html" shape="rect" coords="22,7,102,34" alt="">
  16 </map>
  17 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ModuleFactory:<p><center><img src="classModuleFactory__coll__graph.gif" border="0" usemap="#ModuleFactory__coll__map" alt="Collaboration graph"></center>
  18 <map name="ModuleFactory__coll__map">
  19 <area href="classclassbase.html" shape="rect" coords="22,97,102,124" alt="">
  20 </map>
  21 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classModuleFactory-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  22 <tr><td></td></tr>
  23 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  24 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModuleFactory.html#ModuleFactory_28_29">ModuleFactory</a> ()</td></tr>
  25
  26 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModuleFactory.html#_7EModuleFactory_28_29">~ModuleFactory</a> ()</td></tr>
  27
  28 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classModule.html">Module</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModuleFactory.html#CreateModule_28Server_20_2AMe_29_3D_30">CreateModule</a> (<a class="el" href="classServer.html">Server</a> *Me)=0</td></tr>
  29
  30 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new module.  <a href="#CreateModule_28Server_20_2AMe_29_3D_30"></a><br></td></tr>
  31 </table>
  32 <hr><a name="_details"></a><h2>Detailed Description</h2>
  33 Instantiates classes inherited from <a class="el" href="classModule.html">Module</a> This class creates a class inherited from type <a class="el" href="classModule.html">Module</a>, using new.
  34 <p>
  35 This is to allow for modules to create many different variants of <a class="el" href="classModule.html">Module</a>, dependent on architecture, configuration, etc. In most cases, the simple class shown in the example module m_foobar.so will suffice for most modules.
  36 <p>
  37
  38 <p>
  39 Definition at line <a class="el" href="modules_8h-source.html#l01669">1669</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  40 <a class="anchor" name="ModuleFactory_28_29"></a><!-- doxytag: member="ModuleFactory::ModuleFactory" ref="ModuleFactory_28_29" args="()" --><p>
  41 <table class="mdTable" cellpadding="2" cellspacing="0">
  42   <tr>
  43     <td class="mdRow">
  44       <table cellpadding="0" cellspacing="0" border="0">
  45         <tr>
  46           <td class="md" nowrap valign="top">ModuleFactory::ModuleFactory           </td>
  47           <td class="md" valign="top">(&nbsp;</td>
  48           <td class="mdname1" valign="top" nowrap>          </td>
  49           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  50           <td class="md" nowrap><code> [inline]</code></td>
  51         </tr>
  52       </table>
  53     </td>
  54   </tr>
  55 </table>
  56 <table cellspacing="5" cellpadding="0" border="0">
  57   <tr>
  58     <td>
  59       &nbsp;
  60     </td>
  61     <td>
  62
  63 <p>
  64
  65 <p>
  66 Definition at line <a class="el" href="modules_8h-source.html#l01672">1672</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<div class="fragment"><pre class="fragment"><a name="l01672"></a>01672 { }
  67 </pre></div>
  68 <p>
  69     </td>
  70   </tr>
  71 </table>
  72 <a class="anchor" name="_7EModuleFactory_28_29"></a><!-- doxytag: member="ModuleFactory::~ModuleFactory" ref="_7EModuleFactory_28_29" args="()" --><p>
  73 <table class="mdTable" cellpadding="2" cellspacing="0">
  74   <tr>
  75     <td class="mdRow">
  76       <table cellpadding="0" cellspacing="0" border="0">
  77         <tr>
  78           <td class="md" nowrap valign="top">virtual ModuleFactory::~ModuleFactory           </td>
  79           <td class="md" valign="top">(&nbsp;</td>
  80           <td class="mdname1" valign="top" nowrap>          </td>
  81           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  82           <td class="md" nowrap><code> [inline, virtual]</code></td>
  83         </tr>
  84       </table>
  85     </td>
  86   </tr>
  87 </table>
  88 <table cellspacing="5" cellpadding="0" border="0">
  89   <tr>
  90     <td>
  91       &nbsp;
  92     </td>
  93     <td>
  94
  95 <p>
  96
  97 <p>
  98 Definition at line <a class="el" href="modules_8h-source.html#l01673">1673</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<div class="fragment"><pre class="fragment"><a name="l01673"></a>01673 { }
  99 </pre></div>
 100 <p>
 101     </td>
 102   </tr>
 103 </table>
 104 <hr><h2>Member Function Documentation</h2>
 105 <a class="anchor" name="CreateModule_28Server_20_2AMe_29_3D_30"></a><!-- doxytag: member="ModuleFactory::CreateModule" ref="CreateModule_28Server_20_2AMe_29_3D_30" args="(Server *Me)=0" --><p>
 106 <table class="mdTable" cellpadding="2" cellspacing="0">
 107   <tr>
 108     <td class="mdRow">
 109       <table cellpadding="0" cellspacing="0" border="0">
 110         <tr>
 111           <td class="md" nowrap valign="top">virtual <a class="el" href="classModule.html">Module</a>* ModuleFactory::CreateModule           </td>
 112           <td class="md" valign="top">(&nbsp;</td>
 113           <td class="md" nowrap valign="top"><a class="el" href="classServer.html">Server</a> *&nbsp;</td>
 114           <td class="mdname1" valign="top" nowrap> <em>Me</em>          </td>
 115           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 116           <td class="md" nowrap><code> [pure virtual]</code></td>
 117         </tr>
 118       </table>
 119     </td>
 120   </tr>
 121 </table>
 122 <table cellspacing="5" cellpadding="0" border="0">
 123   <tr>
 124     <td>
 125       &nbsp;
 126     </td>
 127     <td>
 128
 129 <p>
 130 Creates a new module.
 131 <p>
 132 Your inherited class of ModuleFactory must return a pointer to your <a class="el" href="classModule.html">Module</a> class using this method.    </td>
 133   </tr>
 134 </table>
 135 <hr>The documentation for this class was generated from the following file:<ul>
 136 <li><a class="el" href="modules_8h-source.html">modules.h</a></ul>
 137 <hr size="1"><address style="align: right;"><small>Generated on Wed Dec 14 14:49:32 2005 for InspIRCd by&nbsp;
 138 <a href="http://www.doxygen.org/index.html">
 139 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 140 </body>
 141 </html>