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/classEvent.html | 227 ++++++++++++++++++++-------------------- 1 file changed, 112 insertions(+), 115 deletions(-) (limited to 'docs/module-doc/classEvent.html') diff --git a/docs/module-doc/classEvent.html b/docs/module-doc/classEvent.html index f16ad64ed..6e0a14d33 100644 --- a/docs/module-doc/classEvent.html +++ b/docs/module-doc/classEvent.html @@ -1,97 +1,96 @@ - + -InspIRCd: Event class Reference +InspIRCd: Event Class Reference - -
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members
-

Event Class Reference

The Event class is a unicast message directed at all modules. + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
+

Event Class Reference

The Event class is a unicast message directed at all modules. More...

#include <modules.h>

Inheritance diagram for Event:

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

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

Public Member Functions

 Event (char *anydata, Module *src, std::string eventid)

Public Member Functions

 Event (char *anydata, Module *src, std::string eventid)
 Create a new Event.

char * GetData ()
 Create a new Event.
char * GetData ()
 Get the Event data.

Module * GetSource ()
 Get the Event data.
Module * GetSource ()
 Get the event Source.

std::string GetEventID ()
 Get the event Source.
std::string GetEventID ()
 Get the event ID.

char * Send ()
 Get the event ID.
char * Send ()
 Send the Event.


Protected Attributes

char * data
 Send the Event.

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.

std::string id
 This is a pointer to the sender of the message, which can be used to directly trigger events, or to create a reply.
std::string id
 The event identifier.

 The event identifier.

Detailed Description

The Event class is a unicast message directed at all modules.

-When the class is properly instantiated it may be sent to all modules using the Send() method, which will trigger the OnEvent method in all modules passing the object as its parameter. +When the class is properly instantiated it may be sent to all modules using the Send() method, which will trigger the OnEvent method in all modules passing the object as its parameter.

-Definition at line 194 of file modules.h.

Constructor & Destructor Documentation

-

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

Constructor & Destructor Documentation

+

+

- + - - + + - - - + + + - + -
Event::Event Event::Event (  char *  anydata,
Module *  src,
std::string std::string  eventid
) 
- +
+
  @@ -103,31 +102,30 @@ Create a new Event.

-Definition at line 280 of file modules.cpp. +Definition at line 281 of file modules.cpp.

00281 : data(anydata), source(src), id(eventid) { };
+

-

00280 : data(anydata), source(src), id(eventid) { };
-

Member Function Documentation

-

- +

+

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

-Definition at line 282 of file modules.cpp. +Definition at line 283 of file modules.cpp.

-References data. +References data.

00284 {
+00285         return this->data;
+00286 }
+

-

00283 {
-00284         return this->data;
-00285 }
-
-

- +

+

- + -
std::string Event::GetEventID std::string Event::GetEventID (   ) 
- +
+
  @@ -176,36 +173,35 @@ References data.

Get the event ID.

-Use this to determine the event type for safe casting of the data +Use this to determine the event type for safe casting of the data

-Definition at line 298 of file modules.cpp. +Definition at line 299 of file modules.cpp.

-References id. +References id.

00300 {
+00301         return this->id;
+00302 }
+

-

00299 {
-00300         return this->id;
-00301 }
-
-

- +

+

- + -
Module * Event::GetSource Module * Event::GetSource (   ) 
- +
+
  @@ -217,34 +213,33 @@ Get the event Source.

-Definition at line 287 of file modules.cpp. +Definition at line 288 of file modules.cpp.

-References source. +References source.

00289 {
+00290         return this->source;
+00291 }
+

-

00288 {
-00289         return this->source;
-00290 }
-
-

- +

+

- + -
char * Event::Send char * Event::Send (   )  [virtual]
- +
+
  @@ -254,34 +249,35 @@ References source.

Send the Event.

-The return result of an Event::Send() will always be NULL as no replies are expected. +The return result of an Event::Send() will always be NULL as no replies are expected.

-Implements ModuleMessage. +Implements ModuleMessage.

-Definition at line 292 of file modules.cpp. +Definition at line 293 of file modules.cpp.

-References FOREACH_MOD. +References FOREACH_MOD.

00294 {
+00295         FOREACH_MOD OnEvent(this);
+00296         return NULL;
+00297 }
+

-

00293 {
-00294         FOREACH_MOD OnEvent(this);
-00295         return NULL;
-00296 }
-

Member Data Documentation

-

- +

+

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

-Definition at line 199 of file modules.h. +Definition at line 201 of file modules.h.

-Referenced by GetData().

-

- +

+

- +
std::string Event::id [protected] + std::string Event::id [protected]
- +
+Referenced by GetEventID().
  @@ -319,25 +316,26 @@ Referenced by GetData()

The event identifier.

-This is arbitary text which should be used to distinguish one type of event from another. +This is arbitary text which should be used to distinguish one type of event from another.

-Definition at line 208 of file modules.h. +Definition at line 210 of file modules.h.

-Referenced by GetEventID().

-

- +

+

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

-Definition at line 203 of file modules.h. +Definition at line 205 of file modules.h.

-Referenced by GetSource().

The documentation for this class was generated from the following files: -
Generated on Mon May 30 05:16:52 2005 for InspIRCd by +
Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by  -doxygen -1.3.3
+doxygen 1.4.4-20050815
-- cgit v1.2.3