From cd9f9a8add02597a2998ba74b803ed3fbf81314c Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 27 Nov 2005 01:44:46 +0000 Subject: Added new documentation git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1966 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classRequest.html | 233 +++++++++++++++++++------------------- 1 file changed, 115 insertions(+), 118 deletions(-) (limited to 'docs/module-doc/classRequest.html') diff --git a/docs/module-doc/classRequest.html b/docs/module-doc/classRequest.html index be396252c..a65615678 100644 --- a/docs/module-doc/classRequest.html +++ b/docs/module-doc/classRequest.html @@ -1,97 +1,96 @@ - + -InspIRCd: Request class Reference +InspIRCd: Request Class Reference - -
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members
-

Request Class Reference

The Request class is a unicast message directed at a given module. + +
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. +
[legend]
List of all members.
- - + + - - + + - - + + - - + + - - + + - - - + + + - - + + - - + + - +

Public Member Functions

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

Public Member Functions

 Request (char *anydata, Module *src, Module *dst)
 Create a new Request.

char * GetData ()
 Create a new Request.
char * GetData ()
 Fetch the Request data.

Module * GetSource ()
 Fetch the Request data.
Module * GetSource ()
 Fetch the request source.

Module * GetDest ()
 Fetch the request source.
Module * GetDest ()
 Fetch the request destination (should be 'this' in the receiving module).

char * Send ()
 Fetch the request destination (should be 'this' in the receiving module).
char * Send ()
 Send the Request.


Protected Attributes

char * data
 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 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
 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.

 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. +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 154 of file modules.h.

Constructor & Destructor Documentation

-

- +Definition at line 156 of file modules.h.

Constructor & Destructor Documentation

+

+

- + - - + + - - + + - + -
Request::Request Request::Request (  char *  anydata,
Module *  src,
Module *  dst
) 
- +
+
  @@ -103,31 +102,30 @@ Create a new Request.

-Definition at line 251 of file modules.cpp. +Definition at line 252 of file modules.cpp.

00252 : data(anydata), source(src), dest(dst) { };
+

-

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

Member Function Documentation

-

- +

+

- + -
char * Request::GetData char * Request::GetData (   ) 
- +
+
  @@ -139,34 +137,33 @@ Fetch the Request data.

-Definition at line 253 of file modules.cpp. +Definition at line 254 of file modules.cpp.

-References data. +References data.

00255 {
+00256         return this->data;
+00257 }
+

-

00254 {
-00255         return this->data;
-00256 }
-
-

- +

+

- + -
Module * Request::GetDest Module * Request::GetDest (   ) 
- +
+
  @@ -178,34 +175,33 @@ Fetch the request destination (should be 'this' in the receiving module).

-Definition at line 263 of file modules.cpp. +Definition at line 264 of file modules.cpp.

-References dest. +References dest.

00265 {
+00266         return this->dest;
+00267 }
+

-

00264 {
-00265         return this->dest;
-00266 }
-
-

- +

+

- + -
Module * Request::GetSource Module * Request::GetSource (   ) 
- +
+
  @@ -217,34 +213,33 @@ Fetch the request source.

-Definition at line 258 of file modules.cpp. +Definition at line 259 of file modules.cpp.

-References source. +References source.

00260 {
+00261         return this->source;
+00262 }
+

-

00259 {
-00260         return this->source;
-00261 }
-
-

- +

+

- + -
char * Request::Send char * Request::Send (   )  [virtual]
- +
+
  @@ -254,40 +249,41 @@ References source.

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. +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. +Implements ModuleMessage.

-Definition at line 268 of file modules.cpp. +Definition at line 269 of file modules.cpp.

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

00270 {
+00271         if (this->dest)
+00272         {
+00273                 return dest->OnRequest(this);
+00274         }
+00275         else
+00276         {
+00277                 return NULL;
+00278         }
+00279 }
+

-

00269 {
-00270         if (this->dest)
-00271         {
-00272                 return dest->OnRequest(this);
-00273         }
-00274         else
-00275         {
-00276                 return NULL;
-00277         }
-00278 }
-

Member Data Documentation

-

- +

+

- +
char* Request::data [protected] + char* Request::data [protected]
- +
+Referenced by GetData().
  @@ -299,23 +295,24 @@ This member holds a pointer to arbitary data set by the emitter of the message.

-Definition at line 159 of file modules.h. +Definition at line 161 of file modules.h.

-Referenced by GetData().

-

- +

+

- +
Module* Request::dest [protected] + Module* Request::dest [protected]
- +
+Referenced by GetDest(), and Send().
  @@ -327,23 +324,24 @@ The single destination of the Request.

-Definition at line 166 of file modules.h. +Definition at line 168 of file modules.h.

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

-

- +

+

- +
Module* Request::source [protected] + Module* Request::source [protected]
- +
+Referenced by GetSource().
  @@ -355,16 +353,15 @@ This is a pointer to the sender of the message, which can be used to directly tr

-Definition at line 163 of file modules.h. +Definition at line 165 of file modules.h.

-Referenced by GetSource().

The documentation for this class was generated from the following files: -
Generated on Mon May 30 05:17:30 2005 for InspIRCd by +
Generated on Sun Nov 27 01:43:26 2005 for InspIRCd by  -doxygen -1.3.3
+doxygen 1.4.4-20050815
-- cgit v1.3.1-10-gc9f91