From f62de63955ff77e800360eb140f108b5d2c6c075 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 19 Dec 2005 18:32:09 +0000 Subject: Design flaw my ass. git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2580 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classRequest.html | 367 -------------------------------------- 1 file changed, 367 deletions(-) delete mode 100644 docs/module-doc/classRequest.html (limited to 'docs/module-doc/classRequest.html') diff --git a/docs/module-doc/classRequest.html b/docs/module-doc/classRequest.html deleted file mode 100644 index 019d5de24..000000000 --- a/docs/module-doc/classRequest.html +++ /dev/null @@ -1,367 +0,0 @@ - - -InspIRCd: Request Class Reference - - - -
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
-

Request Class Reference

The Request class is a unicast message directed at a given module. -More... -

-#include <modules.h> -

-Inheritance diagram for Request:

Inheritance graph
- - - - -
[legend]
Collaboration diagram for Request:

Collaboration graph
- - - - - -
[legend]
List of all members. - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Member Functions

 Request (char *anydata, Module *src, Module *dst)
 Create a new Request.
char * GetData ()
 Fetch the Request data.
Module * GetSource ()
 Fetch the request source.
Module * GetDest ()
 Fetch the request destination (should be 'this' in the receiving module).
char * Send ()
 Send the Request.

Protected Attributes

char * data
 This member holds a pointer to arbitary data set by the emitter of the message.
Module * source
 This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply.
Module * dest
 The single destination of the Request.
-

Detailed Description

-The Request class is a unicast message directed at a given module. -

-When this class is properly instantiated it may be sent to a module using the Send() method, which will call the given module's OnRequest method with this class as its parameter. -

- -

-Definition at line 175 of file modules.h.

Constructor & Destructor Documentation

-

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - -
Request::Request ( char *  anydata,
Module *  src,
Module *  dst
) 
-
- - - - - -
-   - - -

-Create a new Request. -

- -

-Definition at line 164 of file modules.cpp.

00164 : data(anydata), source(src), dest(dst) { };
-
-

-

-

Member Function Documentation

-

- - - - -
- - - - - - - - -
char * Request::GetData (   ) 
-
- - - - - -
-   - - -

-Fetch the Request data. -

- -

-Definition at line 166 of file modules.cpp. -

-References data.

00167 {
-00168         return this->data;
-00169 }
-
-

-

-

- - - - -
- - - - - - - - -
Module * Request::GetDest (   ) 
-
- - - - - -
-   - - -

-Fetch the request destination (should be 'this' in the receiving module). -

- -

-Definition at line 176 of file modules.cpp. -

-References dest.

00177 {
-00178         return this->dest;
-00179 }
-
-

-

-

- - - - -
- - - - - - - - -
Module * Request::GetSource (   ) 
-
- - - - - -
-   - - -

-Fetch the request source. -

- -

-Definition at line 171 of file modules.cpp. -

-References source.

00172 {
-00173         return this->source;
-00174 }
-
-

-

-

- - - - -
- - - - - - - - -
char * Request::Send (   )  [virtual]
-
- - - - - -
-   - - -

-Send the Request. -

-Upon returning the result will be arbitary data returned by the module you sent the request to. It is up to your module to know what this data is and how to deal with it. -

-Implements ModuleMessage. -

-Definition at line 181 of file modules.cpp. -

-References dest, and Module::OnRequest().

00182 {
-00183         if (this->dest)
-00184         {
-00185                 return dest->OnRequest(this);
-00186         }
-00187         else
-00188         {
-00189                 return NULL;
-00190         }
-00191 }
-
-

-

-

Member Data Documentation

-

- - - - -
- - - - -
char* Request::data [protected]
-
- - - - - -
-   - - -

-This member holds a pointer to arbitary data set by the emitter of the message. -

- -

-Definition at line 180 of file modules.h. -

-Referenced by GetData().

-

- - - - -
- - - - -
Module* Request::dest [protected]
-
- - - - - -
-   - - -

-The single destination of the Request. -

- -

-Definition at line 187 of file modules.h. -

-Referenced by GetDest(), and Send().

-

- - - - -
- - - - -
Module* Request::source [protected]
-
- - - - - -
-   - - -

-This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply. -

- -

-Definition at line 184 of file modules.h. -

-Referenced by GetSource().

-

The documentation for this class was generated from the following files: -
Generated on Mon Dec 19 18:05:22 2005 for InspIRCd by  - -doxygen 1.4.4-20050815
- - -- cgit v1.3.1-10-gc9f91