docs/man/man3/ModuleMessage.3

   1 .TH "ModuleMessage" 3 "15 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 ModuleMessage \- The ModuleMessage class is the base class of \fBRequest\fP and \fBEvent\fP This class is used to represent a basic data structure which is passed between modules for safe inter-module communications.
   6
   7 .PP
   8 .SH SYNOPSIS
   9 .br
  10 .PP
  11 \fC#include <modules.h>\fP
  12 .PP
  13 Inherits \fBclassbase\fP.
  14 .PP
  15 Inherited by \fBEvent\fP, and \fBRequest\fP.
  16 .PP
  17 .SS "Public Member Functions"
  18
  19 .in +1c
  20 .ti -1c
  21 .RI "virtual char * \fBSend\fP ()=0"
  22 .br
  23 .RI "\fIThis class is pure virtual and must be inherited. \fP"
  24 .ti -1c
  25 .RI "virtual \fB~ModuleMessage\fP ()"
  26 .br
  27 .in -1c
  28 .SH "Detailed Description"
  29 .PP
  30 The ModuleMessage class is the base class of \fBRequest\fP and \fBEvent\fP This class is used to represent a basic data structure which is passed between modules for safe inter-module communications.
  31 .PP
  32 Definition at line 143 of file modules.h.
  33 .SH "Constructor & Destructor Documentation"
  34 .PP
  35 .SS "virtual ModuleMessage::~ModuleMessage ()\fC [inline, virtual]\fP"
  36 .PP
  37 Definition at line 149 of file modules.h.
  38 .PP
  39 .nf
  40 149 {};
  41 .fi
  42 .PP
  43 .SH "Member Function Documentation"
  44 .PP
  45 .SS "virtual char* ModuleMessage::Send ()\fC [pure virtual]\fP"
  46 .PP
  47 This class is pure virtual and must be inherited.
  48 .PP
  49 Implemented in \fBRequest\fP, and \fBEvent\fP.
  50
  51 .SH "Author"
  52 .PP
  53 Generated automatically by Doxygen for InspIRCd from the source code.