From 52899de0ff2d62ca0542b243c41626010bf62083 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 25 Mar 2005 03:51:56 +0000 Subject: Documentation update git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@899 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classExtensible.html | 101 ++++++++++++++++------------------- 1 file changed, 47 insertions(+), 54 deletions(-) (limited to 'docs/module-doc/classExtensible.html') diff --git a/docs/module-doc/classExtensible.html b/docs/module-doc/classExtensible.html index bb81a4f98..f662fa5e3 100644 --- a/docs/module-doc/classExtensible.html +++ b/docs/module-doc/classExtensible.html @@ -1,67 +1,60 @@ -Extensible class Reference +InspIRCd: Extensible class Reference - -
-Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  
-

Extensible Class Reference

class Extensible is the parent class of many classes such as userrec and chanrec. + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+

Extensible Class Reference

class Extensible is the parent class of many classes such as userrec and chanrec. More...

#include <base.h>

-Inheritance diagram for Extensible:

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

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

+Inherited by chanrec, command_t, connection, and ircd_connector. +

+List of all members.

- - - - - - + + + + + + + + + - - + + +

Public Member Functions

bool Extend (std::string key, char *p)
 Extend an Extensible class.

bool Shrink (std::string key)
 Shrink an Extensible class.

char * GetExt (std::string key)
 Get an extension item.

bool Extend (std::string key, char *p)
 Extend an Extensible class.

bool Shrink (std::string key)
 Shrink an Extensible class.

char * GetExt (std::string key)
 Get an extension item.


Private Attributes

std::map< std::string, char * > Extension_Items
 Private data store.

std::map< std::string, char * > Extension_Items
 Private data store.

Detailed Description

-class Extensible is the parent class of many classes such as userrec and chanrec. +class Extensible is the parent class of many classes such as userrec and chanrec.

class Extensible implements a system which allows modules to 'extend' the class by attaching data within a map associated with the object. In this way modules can store their own custom information within user objects, channel objects and server objects, without breaking other modules (this is more sensible than using a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and supports arbitary data storage).

-Definition at line 38 of file base.h.

Member Function Documentation

+Definition at line 50 of file base.h.

Member Function Documentation

- +
-
+ - + - + @@ -81,22 +74,22 @@ Definition at line 38 of fil
bool Extensible::Extend (  std::string   key, key,
char *   p p

-Extend an Extensible class. +Extend an Extensible class.

You must provide a key to store the data as, and a void* to the data (typedef VoidPointer) The data will be inserted into the map. If the data already exists, you may not insert it twice, Extensible::Extend will return false in this case. On successful extension, Extend returns true.

- +
-
+ - - + + @@ -112,22 +105,22 @@ You must provide a key to store the data as, and a void* to the data (typedef Vo
char* Extensible::GetExt (  std::string   key )  key  ) 

-Get an extension item. +Get an extension item.

You must provide a key name, which is case sensitive. If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned.

- +
-
+ - - + + @@ -143,19 +136,19 @@ You must provide a key name, which is case sensitive. If you provide a non-exist
bool Extensible::Shrink (  std::string   key )  key  ) 

-Shrink an Extensible class. +Shrink an Extensible class.

You must provide a key name. The given key name will be removed from the classes data. If you provide a nonexistent key (case is important) then the function will return false. Returns true on success.

Member Data Documentation

-

- +

+

- @@ -168,18 +161,18 @@ You must provide a key name. The given key name will be removed from the classes +Definition at line 54 of file base.h.
+ -
std::map<std::string,char*> Extensible::Extension_Items [private] + std::map<std::string,char*> Extensible::Extension_Items [private]

-Private data store. +Private data store.

-Definition at line 42 of file base.h.

The documentation for this class was generated from the following file: -
Generated on Sun May 2 00:09:35 2004 for InspIRCd by +
Generated on Fri Mar 25 03:49:32 2005 for InspIRCd by -doxygen1.3-rc3
+doxygen +1.3.3
-- cgit v1.3.1-10-gc9f91