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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ICINGA-API: IcingaApiCommandDispatcher Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<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>
<div class="contents">
<h1>IcingaApiCommandDispatcher Class Reference</h1><!-- doxytag: class="IcingaApiCommandDispatcher" --><!-- doxytag: inherits="IcingaApiCommand" -->
<p>Inherits <a class="el" href="classIcingaApiCommand.html">IcingaApiCommand</a>.</p>
<div class="dynheader">
Collaboration diagram for IcingaApiCommandDispatcher:</div>
<div class="dynsection">
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classIcingaApiCommandDispatcher-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiCommandDispatcher.html#ac89614c7a582f01d4b57efe70bb8e237">clearCommands</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiCommandDispatcher.html#ae00150d6e2e12bdd1fc641496c301c6d">setInterface</a> ($interface, array $config=array())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiCommandDispatcher.html#afcd6e54f3afeb57d9c2b690ee6a810c8">setCommand</a> ($command)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiCommandDispatcher.html#ad3946facebb0fdb198902dd32625b158">send</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIcingaApiCommandDispatcher.html#ad4cc54d14d2fd9a342bf9afedcee1708">getCallStack</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler <christian <a href="mailto:doebler@netways.de">doebler@netways.de</a>> </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac89614c7a582f01d4b57efe70bb8e237"></a><!-- doxytag: member="IcingaApiCommandDispatcher::clearCommands" ref="ac89614c7a582f01d4b57efe70bb8e237" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiCommandDispatcher::clearCommands </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>clears the command pool </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>void</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>void </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler <<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>> </dd></dl>
</div>
</div>
<a class="anchor" id="ad4cc54d14d2fd9a342bf9afedcee1708"></a><!-- doxytag: member="IcingaApiCommandDispatcher::getCallStack" ref="ad4cc54d14d2fd9a342bf9afedcee1708" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiCommandDispatcher::getCallStack </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the call stack for further processing </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>void</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>array call stack of sent commands; if <a class="el" href="classIcingaApiCommandDispatcher.html#ad3946facebb0fdb198902dd32625b158">send()</a> has not been called yet, return value will be boolean false </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler <<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>> </dd></dl>
</div>
</div>
<a class="anchor" id="ad3946facebb0fdb198902dd32625b158"></a><!-- doxytag: member="IcingaApiCommandDispatcher::send" ref="ad3946facebb0fdb198902dd32625b158" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiCommandDispatcher::send </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sends command(s) by using the defined interface </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>void</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>boolean true on success otherwise false </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler <<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>> </dd></dl>
</div>
</div>
<a class="anchor" id="afcd6e54f3afeb57d9c2b690ee6a810c8"></a><!-- doxytag: member="IcingaApiCommandDispatcher::setCommand" ref="afcd6e54f3afeb57d9c2b690ee6a810c8" args="($command)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiCommandDispatcher::setCommand </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>command</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sets the command(s) which should be sent </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$command icinga command(s) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classIcingaApiCommandDispatcher.html">IcingaApiCommandDispatcher</a> instance of <a class="el" href="classIcingaApiCommandDispatcher.html">IcingaApiCommandDispatcher</a> object </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler <<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>> </dd></dl>
<p>Reimplemented from <a class="el" href="classIcingaApiCommand.html#ab041ace70b9accd415e5c663af6dfd73">IcingaApiCommand</a>.</p>
</div>
</div>
<a class="anchor" id="ae00150d6e2e12bdd1fc641496c301c6d"></a><!-- doxytag: member="IcingaApiCommandDispatcher::setInterface" ref="ae00150d6e2e12bdd1fc641496c301c6d" args="($interface, array $config=array())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IcingaApiCommandDispatcher::setInterface </td>
<td>(</td>
<td class="paramtype">$ </td>
<td class="paramname"> <em>interface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">array $ </td>
<td class="paramname"> <em>config</em> = <code>array()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>sets the interface to be used for sending commands </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$interface command interface </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$config interface config </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classIcingaApiCommandDispatcher.html">IcingaApiCommandDispatcher</a> instance of <a class="el" href="classIcingaApiCommandDispatcher.html">IcingaApiCommandDispatcher</a> object </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler <<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/jefe/workspace_nw/icinga-api/objects/command/<a class="el" href="IcingaApiCommandDispatcher_8php.html">IcingaApiCommandDispatcher.php</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Jan 14 15:06:46 2010 for ICINGA-API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
