docs/module-doc/classModuleMessage.html

   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>InspIRCd: ModuleMessage class Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   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">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>ModuleMessage Class Reference</h1>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="8,157,64,184" alt="">
  16 <area href="classRequest.html" shape="rect" coords="88,157,160,184" alt="">
  17 <area href="classclassbase.html" shape="rect" coords="40,8,120,34" 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="28,98,108,125" 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#a0">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. </em> <a href="#a0"></a><em><br><br></td></tr>
  29 </table>
  30 <hr><a name="_details"></a><h2>Detailed Description</h2>
  31 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.
  32 <p>
  33
  34 <p>
  35 Definition at line <a class="el" href="modules_8h-source.html#l00141">141</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Member Function Documentation</h2>
  36 <a name="a0" doxytag="ModuleMessage::Send"></a><p>
  37 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  38   <tr>
  39     <td class="mdRow">
  40       <table cellpadding="0" cellspacing="0" border="0">
  41         <tr>
  42           <td class="md" nowrap valign="top"> virtual char* ModuleMessage::Send </td>
  43           <td class="md" valign="top">(&nbsp;</td>
  44           <td class="mdname1" valign="top" nowrap>          </td>
  45           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  46           <td class="md" nowrap><code> [pure virtual]</code></td>
  47         </tr>
  48
  49       </table>
  50     </td>
  51   </tr>
  52 </table>
  53 <table cellspacing=5 cellpadding=0 border=0>
  54   <tr>
  55     <td>
  56       &nbsp;
  57     </td>
  58     <td>
  59
  60 <p>
  61 This class is pure virtual and must be inherited.
  62 <p>
  63
  64 <p>
  65 Implemented in <a class="el" href="classRequest.html#a4">Request</a>, and <a class="el" href="classEvent.html#a4">Event</a>.    </td>
  66   </tr>
  67 </table>
  68 <hr>The documentation for this class was generated from the following file:<ul>
  69 <li><a class="el" href="modules_8h-source.html">modules.h</a></ul>
  70 <hr size="1"><address style="align: right;"><small>Generated on Fri May 13 01:59:55 2005 for InspIRCd by
  71 <a href="http://www.doxygen.org/index.html">
  72 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
  73 </a>1.3.3 </small></address>
  74 </body>
  75 </html>