From 2db0df5813e46fe5e077e014003acbd10698b913 Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 20 Apr 2005 15:48:27 +0000 Subject: Added module message passing architecture git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1136 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classRequest.html | 361 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 361 insertions(+) create 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 new file mode 100644 index 000000000..8af50c2b9 --- /dev/null +++ b/docs/module-doc/classRequest.html @@ -0,0 +1,361 @@ + + +InspIRCd: Request class Reference + + + +

Request Class Reference

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

+#include <modules.h> +

+Inherits ModuleMessage. +

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

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Request::Request ( char * anydata,
Module * src,
Module * dst
)
+
+ + + + + +
+ + + +
+Create a new Request. +
+ +
+Definition at line 308 of file modules.cpp. +
+
00308 : data(anydata), source(src), dest(dst) { }; +

+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
char * Request::GetData ( )
+
+ + + + + +
+ + + +
+Fetch the Request data. +
+ +
+Definition at line 310 of file modules.cpp. +
+References data. +
+
00311 { +00312 return this->data; +00313 } +

+

+ + + + +
+ + + + + + + + + +
Module * Request::GetDest ( )
+
+ + + + + +
+ + + +
+Fetch the request destination (should be 'this' in the receiving module). +
+ +
+Definition at line 320 of file modules.cpp. +
+References dest. +
+
00321 { +00322 return this->dest; +00323 } +

+

+ + + + +
+ + + + + + + + + +
Module * Request::GetSource ( )
+
+ + + + + +
+ + + +
+Fetch the request source. +
+ +
+Definition at line 315 of file modules.cpp. +
+References source. +
+
00316 { +00317 return this->source; +00318 } +

+

+ + + + +
+ + + + + + + + + +
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 325 of file modules.cpp. +
+References dest, and Module::OnRequest(). +
+
00326 { +00327 if (this->dest) +00328 { +00329 return dest->OnRequest(this); +00330 } +00331 else +00332 { +00333 return NULL; +00334 } +00335 } +

+

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 156 of file modules.h. +
+Referenced by GetData().
+

+ + + + +
+ + +
Module* Request::dest [protected] +
+
+ + + + + +
+ + + +
+The single destination of the Request. +
+ +
+Definition at line 163 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 160 of file modules.h. +
+Referenced by GetSource().
+

The documentation for this class was generated from the following files:

Generated on Wed Apr 20 15:47:07 2005 for InspIRCd by + +

+1.3.3

+ + -- cgit v1.3.1-10-gc9f91


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.