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

Constructor & Destructor Documentation

Request::Request ( char * anydata,

Module * src,

Module * dst

)

Create a new Request.

Definition at line 306 of file modules.cpp.

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

Member Function Documentation

char * Request::GetData ( )

Fetch the Request data.

Definition at line 308 of file modules.cpp.
References data.

00309 { 00310 return this->data; 00311 }

Module * Request::GetDest ( )

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

Definition at line 318 of file modules.cpp.
References dest.

00319 { 00320 return this->dest; 00321 }

Module * Request::GetSource ( )

Fetch the request source.

Definition at line 313 of file modules.cpp.
References source.

00314 { 00315 return this->source; 00316 }

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 323 of file modules.cpp.
References dest, and Module::OnRequest().

00324 { 00325 if (this->dest) 00326 { 00327 return dest->OnRequest(this); 00328 } 00329 else 00330 { 00331 return NULL; 00332 } 00333 }

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

Module* Request::dest [protected]

The single destination of the Request.

Definition at line 166 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 163 of file modules.h.
Referenced by GetSource().

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

Generated on Sat May 7 15:34:27 2005 for InspIRCd by

1.3.3


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.