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
|
<!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>scim: scim::HelperManager Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.0 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="a00157.html">scim</a>::<a class="el" href="a00045.html">HelperManager</a></div>
<h1>scim::HelperManager Class Reference<br>
<small>
[<a class="el" href="a00163.html">Helper</a>]</small>
</h1><!-- doxytag: class="scim::HelperManager" -->This class is used to manage all helper objects.
<a href="#_details">More...</a>
<p>
<code>#include <scim_helper_manager.h></code>
<p>
<a href="a00361.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#14f73d33ca3f6ba14b79645e6d96c98c">HelperManager</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a271817b7be5ae7a4d1a107e208cb3e9">~HelperManager</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#bf6a4a19ce71a5f41cd1330647a17331">number_of_helpers</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the total number of helpers supported by all helper modules. <a href="#bf6a4a19ce71a5f41cd1330647a17331"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#959c10b091bdc63e6687ff2ba783921f">get_helper_info</a> (unsigned int idx, <a class="el" href="a00044.html">HelperInfo</a> &info) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the information of a specific helper by its index. <a href="#959c10b091bdc63e6687ff2ba783921f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#c4c2ee097aed1d0357bc16bb40c5b55a">run_helper</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &config_name, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &display) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Run a specific helper. <a href="#c4c2ee097aed1d0357bc16bb40c5b55a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class is used to manage all helper objects.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="14f73d33ca3f6ba14b79645e6d96c98c"></a><!-- doxytag: member="scim::HelperManager::HelperManager" ref="14f73d33ca3f6ba14b79645e6d96c98c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::HelperManager::HelperManager </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a271817b7be5ae7a4d1a107e208cb3e9"></a><!-- doxytag: member="scim::HelperManager::~HelperManager" ref="a271817b7be5ae7a4d1a107e208cb3e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::HelperManager::~HelperManager </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="bf6a4a19ce71a5f41cd1330647a17331"></a><!-- doxytag: member="scim::HelperManager::number_of_helpers" ref="bf6a4a19ce71a5f41cd1330647a17331" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int scim::HelperManager::number_of_helpers </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the total number of helpers supported by all helper modules.
<p>
</div>
</div><p>
<a class="anchor" name="959c10b091bdc63e6687ff2ba783921f"></a><!-- doxytag: member="scim::HelperManager::get_helper_info" ref="959c10b091bdc63e6687ff2ba783921f" args="(unsigned int idx, HelperInfo &info) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::HelperManager::get_helper_info </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00044.html">HelperInfo</a> & </td>
<td class="paramname"> <em>info</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the information of a specific helper by its index.
<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>idx</em> </td><td>The index of the helper, must between 0 to number_of_helpers () - 1. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>info</em> </td><td>The <a class="el" href="a00044.html">HelperInfo</a> object to store the information. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if this helper is ok and the information is stored correctly. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c4c2ee097aed1d0357bc16bb40c5b55a"></a><!-- doxytag: member="scim::HelperManager::run_helper" ref="c4c2ee097aed1d0357bc16bb40c5b55a" args="(const String &uuid, const String &config_name, const String &display) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HelperManager::run_helper </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>config_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>display</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Run a specific helper.
<p>
The helper will run in a newly forked process, so this function will return as soon as the new process is launched.<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>config_name</em> </td><td>The name of the <a class="el" href="a00016.html">ConfigModule</a> to be used to read configurations. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>The UUID of the helper to be run. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>display</em> </td><td>The display in which the helper will be run. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00132.html">scim_helper_manager.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:39 2007 for scim by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>
|
