From 71bedf497cde8b0b38afbb366828b3df9c2803d6 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 19 Dec 2005 18:04:22 +0000 Subject: git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2578 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classcommand__t.html | 177 ++++++++++++++++++++++++++++------- 1 file changed, 144 insertions(+), 33 deletions(-) (limited to 'docs/module-doc/classcommand__t.html') diff --git a/docs/module-doc/classcommand__t.html b/docs/module-doc/classcommand__t.html index 1b665f081..11c891bda 100644 --- a/docs/module-doc/classcommand__t.html +++ b/docs/module-doc/classcommand__t.html @@ -5,30 +5,29 @@
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
-

command_t Class Reference

A structure that defines a command. +

command_t Class Reference

A structure that defines a command. More...

#include <ctables.h>

Inheritance diagram for command_t:

Inheritance graph
- - +
[legend]
Collaboration diagram for command_t:

Collaboration graph
- - - -
[legend]
List of all members. - - + + + + - - + + + + - + @@ -41,23 +40,43 @@ Inheritance diagram for command_t:

long 
- + - +

Public Attributes

char command [MAXBUF]

Public Member Functions

 command_t (std::string cmd, char flags, int minpara)
virtual void Handle (char **parameters, int pcnt, userrec *user)=0
 Command name.
handlerfunc * handler_function
virtual ~command_t ()

Public Attributes

std::string command
 Handler function as in typedef.
 Command name.
char flags_needed
 User flags needed to execute the command or 0.
total_bytes
 used by /stats m
char source [MAXBUF]
std::string source
 used for resource tracking between modules
 used for resource tracking between modules

Detailed Description

A structure that defines a command.

-Definition at line 26 of file ctables.h.

Member Data Documentation

-

+Definition at line 29 of file ctables.h.

Constructor & Destructor Documentation

+

@@ -71,20 +90,31 @@ Definition at line 26 of +Definition at line 51 of file ctables.h. +

+References source, total_bytes, and use_count.

00051                                                           : command(cmd), flags_needed(flags), min_params(minpara)
+00052         {
+00053                 use_count = total_bytes = 0;
+00054                 source = "<core>";
+00055         }
+
+

+

- + + + + + + + + + + + + + + + + + + + + +
char command_t::command[MAXBUF] command_t::command_t ( std::string  cmd,
char  flags,
int  minpara
)  [inline]

-Command name. -

-Definition at line 31 of file ctables.h.

-

+

@@ -98,20 +128,68 @@ Definition at line 31 of + +
- + + + + +
char command_t::flags_needed virtual command_t::~command_t (   )  [inline, virtual]

-User flags needed to execute the command or 0. + +

+Definition at line 59 of file ctables.h.

00059 {}
+
+

+

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
virtual void command_t::Handle ( char **  parameters,
int  pcnt,
userrec *  user
)  [pure virtual]
+
+ + + + +Implemented in cmd_mode.
+   + +

-Definition at line 37 of file ctables.h.

-

+

Member Data Documentation

+

@@ -125,13 +203,40 @@ Definition at line 37 of
- +
handlerfunc* command_t::handler_function std::string command_t::command

-Handler function as in typedef. +Command name.

Definition at line 34 of file ctables.h.

+

+ + + + +
+ + + + +
char command_t::flags_needed
+
+ + + + + +
+   + + +

+User flags needed to execute the command or 0. +

+ +

+Definition at line 37 of file ctables.h.

@@ -159,13 +264,13 @@ Minimum number of parameters command takes. Definition at line 40 of file ctables.h.
-

+

@@ -183,7 +288,9 @@ used for resource tracking between modules

-Definition at line 49 of file ctables.h. +Definition at line 49 of file ctables.h. +

+Referenced by command_t().

- +
char command_t::source[MAXBUF] std::string command_t::source

@@ -210,7 +317,9 @@ used by /stats m

-Definition at line 46 of file ctables.h. +Definition at line 46 of file ctables.h. +

+Referenced by command_t().

@@ -237,12 +346,14 @@ used by /stats m

-Definition at line 43 of file ctables.h. +Definition at line 43 of file ctables.h. +

+Referenced by command_t().

The documentation for this class was generated from the following file: -
Generated on Thu Dec 15 11:14:17 2005 for InspIRCd by  +
Generated on Mon Dec 19 18:02:15 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.3.1-10-gc9f91