1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>InspIRCd: Extensible Class Reference</title>
<link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4-20050815 -->
<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
<h1>Extensible Class Reference</h1><!-- doxytag: class="Extensible" --><!-- doxytag: inherits="classbase" -->class Extensible is the parent class of many classes such as userrec and chanrec.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="base_8h-source.html">base.h</a>></code>
<p>
Inheritance diagram for Extensible:<p><center><img src="classExtensible__inherit__graph.gif" border="0" usemap="#Extensible__inherit__map" alt="Inheritance graph"></center>
<map name="Extensible__inherit__map">
<area href="classchanrec.html" shape="rect" coords="7,156,76,183" alt="">
<area href="classcommand__t.html" shape="rect" coords="100,156,191,183" alt="">
<area href="classconnection.html" shape="rect" coords="215,156,300,183" alt="">
<area href="classclassbase.html" shape="rect" coords="106,7,186,33" alt="">
<area href="classuserrec.html" shape="rect" coords="224,231,291,257" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Extensible:<p><center><img src="classExtensible__coll__graph.gif" border="0" usemap="#Extensible__coll__map" alt="Collaboration graph"></center>
<map name="Extensible__coll__map">
<area href="classclassbase.html" shape="rect" coords="7,97,87,124" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classExtensible-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExtensible.html#Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29">Extend</a> (<a class="el" href="namespaceirc.html#string">std::string</a> key, char *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extend an Extensible class. <a href="#Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classExtensible.html#Shrink_28std_3A_3Astring_20key_29">Shrink</a> (<a class="el" href="namespaceirc.html#string">std::string</a> key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shrink an Extensible class. <a href="#Shrink_28std_3A_3Astring_20key_29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classExtensible.html#GetExt_28std_3A_3Astring_20key_29">GetExt</a> (<a class="el" href="namespaceirc.html#string">std::string</a> key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an extension item. <a href="#GetExt_28std_3A_3Astring_20key_29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classExtensible.html#GetExtList_28std_3A_3Adeque_3C_20std_3A_3Astring_20_3E_20_26list_29">GetExtList</a> (std::deque< <a class="el" href="namespaceirc.html#string">std::string</a> > &list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of all extension items names. <a href="#GetExtList_28std_3A_3Adeque_3C_20std_3A_3Astring_20_3E_20_26list_29"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::map< <a class="el" href="namespaceirc.html#string">std::string</a>, char * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classExtensible.html#Extension_5FItems">Extension_Items</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Private data store. <a href="#Extension_5FItems"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
class Extensible is the parent class of many classes such as userrec and chanrec.
<p>
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).
<p>
<p>
Definition at line <a class="el" href="base_8h-source.html#l00051">51</a> of file <a class="el" href="base_8h-source.html">base.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29"></a><!-- doxytag: member="Extensible::Extend" ref="Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29" args="(std::string key, char *p)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool Extensible::Extend </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td>
<td class="mdname" nowrap> <em>key</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>char * </td>
<td class="mdname" nowrap> <em>p</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Extend an Extensible class.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>This parameter is a pointer to any data you wish to associate with the object</td></tr>
</table>
</dl>
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#Extend_28std_3A_3Astring_20key_2C_20char_20_2Ap_29">Extensible::Extend</a> will return false in this case.<p>
<dl compact><dt><b>Returns:</b></dt><dd>Returns true on success, false if otherwise</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="GetExt_28std_3A_3Astring_20key_29"></a><!-- doxytag: member="Extensible::GetExt" ref="GetExt_28std_3A_3Astring_20key_29" args="(std::string key)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">char* Extensible::GetExt </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td>
<td class="mdname1" valign="top" nowrap> <em>key</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get an extension item.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>If you provide a non-existent key name, the function returns NULL, otherwise a pointer to the item referenced by the key is returned.</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="GetExtList_28std_3A_3Adeque_3C_20std_3A_3Astring_20_3E_20_26list_29"></a><!-- doxytag: member="Extensible::GetExtList" ref="GetExtList_28std_3A_3Adeque_3C_20std_3A_3Astring_20_3E_20_26list_29" args="(std::deque< std::string > &list)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void Extensible::GetExtList </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::deque< <a class="el" href="namespaceirc.html#string">std::string</a> > & </td>
<td class="mdname1" valign="top" nowrap> <em>list</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get a list of all extension items names.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>A deque of strings to receive the list</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>This function writes a list of all extension items stored in this object by name into the given deque and returns void.</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="Shrink_28std_3A_3Astring_20key_29"></a><!-- doxytag: member="Extensible::Shrink" ref="Shrink_28std_3A_3Astring_20key_29" args="(std::string key)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool Extensible::Shrink </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td>
<td class="mdname1" valign="top" nowrap> <em>key</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Shrink an Extensible class.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key parameter is an arbitary string which identifies the extension data</td></tr>
</table>
</dl>
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.<p>
<dl compact><dt><b>Returns:</b></dt><dd>Returns true on success.</dd></dl>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="Extension_5FItems"></a><!-- doxytag: member="Extensible::Extension_Items" ref="Extension_5FItems" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">std::map<<a class="el" href="namespaceirc.html#string">std::string</a>,char*> <a class="el" href="classExtensible.html#Extension_5FItems">Extensible::Extension_Items</a><code> [private]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Private data store.
<p>
<p>
Definition at line <a class="el" href="base_8h-source.html#l00055">55</a> of file <a class="el" href="base_8h-source.html">base.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="base_8h-source.html">base.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Dec 15 11:14:18 2005 for InspIRCd by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>
</html>
|
