docs/module-doc/classExtensible.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>InspIRCd: Extensible class Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>Extensible Class Reference</h1>class Extensible is the parent class of many classes such as userrec and chanrec.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="base_8h-source.html">base.h</a>&gt;</code>
  12 <p>
  13 Inherits <a class="el" href="classclassbase.html">classbase</a>.
  14 <p>
  15 Inherited by <a class="el" href="classchanrec.html">chanrec</a>, <a class="el" href="classcommand__t.html">command_t</a>, <a class="el" href="classconnection.html">connection</a>, and <a class="el" href="classircd__connector.html">ircd_connector</a>.
  16 <p>
  17 <a href="classExtensible-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  18 <tr><td></td></tr>
  19 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  20 <tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classExtensible.html#a0">Extend</a> (std::string key, char *p)</td></tr>
  21
  22 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extend an Extensible class. </em> <a href="#a0"></a><em><br><br></td></tr>
  23 <tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classExtensible.html#a1">Shrink</a> (std::string key)</td></tr>
  24
  25 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shrink an Extensible class. </em> <a href="#a1"></a><em><br><br></td></tr>
  26 <tr><td class="memItemLeft" nowrap align=right valign=top>char *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classExtensible.html#a2">GetExt</a> (std::string key)</td></tr>
  27
  28 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get an extension item. </em> <a href="#a2"></a><em><br><br></td></tr>
  29 <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
  30 <tr><td class="memItemLeft" nowrap align=right valign=top>std::map&lt; std::string, char * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classExtensible.html#r0">Extension_Items</a></td></tr>
  31
  32 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Private data store. </em> <a href="#r0"></a><em><br><br></td></tr>
  33 </table>
  34 <hr><a name="_details"></a><h2>Detailed Description</h2>
  35 class Extensible is the parent class of many classes such as userrec and chanrec.
  36 <p>
  37 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).
  38 <p>
  39
  40 <p>
  41 Definition at line <a class="el" href="base_8h-source.html#l00050">50</a> of file <a class="el" href="base_8h-source.html">base.h</a>.<hr><h2>Member Function Documentation</h2>
  42 <a name="a0" doxytag="Extensible::Extend"></a><p>
  43 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  44   <tr>
  45     <td class="mdRow">
  46       <table cellpadding="0" cellspacing="0" border="0">
  47         <tr>
  48           <td class="md" nowrap valign="top"> bool Extensible::Extend </td>
  49           <td class="md" valign="top">(&nbsp;</td>
  50           <td class="md" nowrap valign="top">std::string&nbsp;</td>
  51           <td class="mdname" nowrap> <em>key</em>, </td>
  52         </tr>
  53         <tr>
  54           <td></td>
  55           <td></td>
  56           <td class="md" nowrap>char *&nbsp;</td>
  57           <td class="mdname" nowrap> <em>p</em></td>
  58         </tr>
  59         <tr>
  60           <td></td>
  61           <td class="md">)&nbsp;</td>
  62           <td class="md" colspan="2"></td>
  63         </tr>
  64
  65       </table>
  66     </td>
  67   </tr>
  68 </table>
  69 <table cellspacing=5 cellpadding=0 border=0>
  70   <tr>
  71     <td>
  72       &nbsp;
  73     </td>
  74     <td>
  75
  76 <p>
  77 Extend an Extensible class.
  78 <p>
  79 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, <a class="el" href="classExtensible.html#a0">Extensible::Extend</a> will return false in this case. On successful extension, Extend returns true.    </td>
  80   </tr>
  81 </table>
  82 <a name="a2" doxytag="Extensible::GetExt"></a><p>
  83 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  84   <tr>
  85     <td class="mdRow">
  86       <table cellpadding="0" cellspacing="0" border="0">
  87         <tr>
  88           <td class="md" nowrap valign="top"> char* Extensible::GetExt </td>
  89           <td class="md" valign="top">(&nbsp;</td>
  90           <td class="md" nowrap valign="top">std::string&nbsp;</td>
  91           <td class="mdname1" valign="top" nowrap> <em>key</em>          </td>
  92           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  93           <td class="md" nowrap></td>
  94         </tr>
  95
  96       </table>
  97     </td>
  98   </tr>
  99 </table>
 100 <table cellspacing=5 cellpadding=0 border=0>
 101   <tr>
 102     <td>
 103       &nbsp;
 104     </td>
 105     <td>
 106
 107 <p>
 108 Get an extension item.
 109 <p>
 110 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.    </td>
 111   </tr>
 112 </table>
 113 <a name="a1" doxytag="Extensible::Shrink"></a><p>
 114 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 115   <tr>
 116     <td class="mdRow">
 117       <table cellpadding="0" cellspacing="0" border="0">
 118         <tr>
 119           <td class="md" nowrap valign="top"> bool Extensible::Shrink </td>
 120           <td class="md" valign="top">(&nbsp;</td>
 121           <td class="md" nowrap valign="top">std::string&nbsp;</td>
 122           <td class="mdname1" valign="top" nowrap> <em>key</em>          </td>
 123           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 124           <td class="md" nowrap></td>
 125         </tr>
 126
 127       </table>
 128     </td>
 129   </tr>
 130 </table>
 131 <table cellspacing=5 cellpadding=0 border=0>
 132   <tr>
 133     <td>
 134       &nbsp;
 135     </td>
 136     <td>
 137
 138 <p>
 139 Shrink an Extensible class.
 140 <p>
 141 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.    </td>
 142   </tr>
 143 </table>
 144 <hr><h2>Member Data Documentation</h2>
 145 <a name="r0" doxytag="Extensible::Extension_Items"></a><p>
 146 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 147   <tr>
 148     <td class="mdRow">
 149       <table cellpadding="0" cellspacing="0" border="0">
 150         <tr>
 151           <td class="md" nowrap valign="top"> std::map&lt;std::string,char*&gt; <a class="el" href="classExtensible.html#r0">Extensible::Extension_Items</a><code> [private]</code>
 152       </table>
 153     </td>
 154   </tr>
 155 </table>
 156 <table cellspacing=5 cellpadding=0 border=0>
 157   <tr>
 158     <td>
 159       &nbsp;
 160     </td>
 161     <td>
 162
 163 <p>
 164 Private data store.
 165 <p>
 166
 167 <p>
 168 Definition at line <a class="el" href="base_8h-source.html#l00054">54</a> of file <a class="el" href="base_8h-source.html">base.h</a>.    </td>
 169   </tr>
 170 </table>
 171 <hr>The documentation for this class was generated from the following file:<ul>
 172 <li><a class="el" href="base_8h-source.html">base.h</a></ul>
 173 <hr size="1"><address style="align: right;"><small>Generated on Tue Apr 26 17:11:48 2005 for InspIRCd by
 174 <a href="http://www.doxygen.org/index.html">
 175 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 176 </a>1.3.3 </small></address>
 177 </body>
 178 </html>