docs/man/man3/ModuleFactory.3

   1 .TH "ModuleFactory" 3 "26 Apr 2005" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 ModuleFactory \- Instantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new.
   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 .SS "Public Member Functions"
  16
  17 .in +1c
  18 .ti -1c
  19 .RI "\fBModuleFactory\fP ()"
  20 .br
  21 .ti -1c
  22 .RI "virtual \fB~ModuleFactory\fP ()"
  23 .br
  24 .ti -1c
  25 .RI "virtual \fBModule\fP * \fBCreateModule\fP ()=0"
  26 .br
  27 .RI "\fICreates a new module. \fP"
  28 .in -1c
  29 .SH "Detailed Description"
  30 .PP
  31 Instantiates classes inherited from \fBModule\fP This class creates a class inherited from type \fBModule\fP, using new.
  32
  33 This is to allow for modules to create many different variants of \fBModule\fP, dependent on architecture, configuration, etc. In most cases, the simple class shown in the example module m_foobar.so will suffice for most modules.
  34 .PP
  35 Definition at line 1241 of file modules.h.
  36 .SH "Constructor & Destructor Documentation"
  37 .PP
  38 .SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP"
  39 .PP
  40 Definition at line 1244 of file modules.h.
  41 .PP
  42 .nf
  43 1244 { }
  44 .fi
  45 .SS "virtual ModuleFactory::~\fBModuleFactory\fP ()\fC [inline, virtual]\fP"
  46 .PP
  47 Definition at line 1245 of file modules.h.
  48 .PP
  49 .nf
  50 1245 { }
  51 .fi
  52 .SH "Member Function Documentation"
  53 .PP
  54 .SS "virtual \fBModule\fP* ModuleFactory::CreateModule ()\fC [pure virtual]\fP"
  55 .PP
  56 Creates a new module. Your inherited class of ModuleFactory must return a pointer to your \fBModule\fP class using this method.
  57
  58 .SH "Author"
  59 .PP
  60 Generated automatically by Doxygen for InspIRCd from the source code.