docs/module-doc/classModuleMessage.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: ModuleMessage 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>ModuleMessage Class Reference</h1><!-- doxytag: class="ModuleMessage" --><!-- doxytag: inherits="classbase" -->The ModuleMessage class is the base class of <a class="el" href="classRequest.html">Request</a> and <a class="el" href="classEvent.html">Event</a> This class is used to represent a basic data structure which is passed between modules for safe inter-module communications.
   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 ModuleMessage:<p><center><img src="classModuleMessage__inherit__graph.gif" border="0" usemap="#ModuleMessage__inherit__map" alt="Inheritance graph"></center>
  14 <map name="ModuleMessage__inherit__map">
  15 <area href="classEvent.html" shape="rect" coords="7,156,63,183" alt="">
  16 <area href="classRequest.html" shape="rect" coords="87,156,159,183" alt="">
  17 <area href="classclassbase.html" shape="rect" coords="39,7,119,33" alt="">
  18 </map>
  19 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ModuleMessage:<p><center><img src="classModuleMessage__coll__graph.gif" border="0" usemap="#ModuleMessage__coll__map" alt="Collaboration graph"></center>
  20 <map name="ModuleMessage__coll__map">
  21 <area href="classclassbase.html" shape="rect" coords="27,97,107,124" alt="">
  22 </map>
  23 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classModuleMessage-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  24 <tr><td></td></tr>
  25 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  26 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModuleMessage.html#Send_28_29_3D_30">Send</a> ()=0</td></tr>
  27
  28 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This class is pure virtual and must be inherited.  <a href="#Send_28_29_3D_30"></a><br></td></tr>
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classModuleMessage.html#_7EModuleMessage_28_29">~ModuleMessage</a> ()</td></tr>
  30
  31 </table>
  32 <hr><a name="_details"></a><h2>Detailed Description</h2>
  33 The ModuleMessage class is the base class of <a class="el" href="classRequest.html">Request</a> and <a class="el" href="classEvent.html">Event</a> This class is used to represent a basic data structure which is passed between modules for safe inter-module communications.
  34 <p>
  35
  36 <p>
  37 Definition at line <a class="el" href="modules_8h-source.html#l00142">142</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  38 <a class="anchor" name="_7EModuleMessage_28_29"></a><!-- doxytag: member="ModuleMessage::~ModuleMessage" ref="_7EModuleMessage_28_29" args="()" --><p>
  39 <table class="mdTable" cellpadding="2" cellspacing="0">
  40   <tr>
  41     <td class="mdRow">
  42       <table cellpadding="0" cellspacing="0" border="0">
  43         <tr>
  44           <td class="md" nowrap valign="top">virtual ModuleMessage::~ModuleMessage           </td>
  45           <td class="md" valign="top">(&nbsp;</td>
  46           <td class="mdname1" valign="top" nowrap>          </td>
  47           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  48           <td class="md" nowrap><code> [inline, virtual]</code></td>
  49         </tr>
  50       </table>
  51     </td>
  52   </tr>
  53 </table>
  54 <table cellspacing="5" cellpadding="0" border="0">
  55   <tr>
  56     <td>
  57       &nbsp;
  58     </td>
  59     <td>
  60
  61 <p>
  62
  63 <p>
  64 Definition at line <a class="el" href="modules_8h-source.html#l00148">148</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<div class="fragment"><pre class="fragment"><a name="l00148"></a>00148 {};
  65 </pre></div>
  66 <p>
  67     </td>
  68   </tr>
  69 </table>
  70 <hr><h2>Member Function Documentation</h2>
  71 <a class="anchor" name="Send_28_29_3D_30"></a><!-- doxytag: member="ModuleMessage::Send" ref="Send_28_29_3D_30" args="()=0" --><p>
  72 <table class="mdTable" cellpadding="2" cellspacing="0">
  73   <tr>
  74     <td class="mdRow">
  75       <table cellpadding="0" cellspacing="0" border="0">
  76         <tr>
  77           <td class="md" nowrap valign="top">virtual char* ModuleMessage::Send           </td>
  78           <td class="md" valign="top">(&nbsp;</td>
  79           <td class="mdname1" valign="top" nowrap>          </td>
  80           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  81           <td class="md" nowrap><code> [pure virtual]</code></td>
  82         </tr>
  83       </table>
  84     </td>
  85   </tr>
  86 </table>
  87 <table cellspacing="5" cellpadding="0" border="0">
  88   <tr>
  89     <td>
  90       &nbsp;
  91     </td>
  92     <td>
  93
  94 <p>
  95 This class is pure virtual and must be inherited.
  96 <p>
  97
  98 <p>
  99 Implemented in <a class="el" href="classRequest.html#Send_28_29">Request</a>, and <a class="el" href="classEvent.html#Send_28_29">Event</a>.    </td>
 100   </tr>
 101 </table>
 102 <hr>The documentation for this class was generated from the following file:<ul>
 103 <li><a class="el" href="modules_8h-source.html">modules.h</a></ul>
 104 <hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:26 2005 for InspIRCd by&nbsp;
 105 <a href="http://www.doxygen.org/index.html">
 106 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 107 </body>
 108 </html>