File: interfaceIcingaApiCommandInterface.html

package info (click to toggle)
icinga 1.0.2-2%2Bsqueeze2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze-lts
  • size: 33,964 kB
  • ctags: 13,294
  • sloc: xml: 154,821; ansic: 99,198; sh: 14,761; sql: 5,852; php: 5,126; perl: 2,838; makefile: 1,268
file content (193 lines) | stat: -rw-r--r-- 10,297 bytes parent folder | download | duplicates (2) 
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
 
<!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: IcingaApiCommandInterface Interface 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>IcingaApiCommandInterface Interface Reference</h1><!-- doxytag: class="IcingaApiCommandInterface" -->
<p>Inherited by <a class="el" href="classIcingaApiCommandSendPipe.html">IcingaApiCommandSendPipe</a>, and <a class="el" href="classIcingaApiCommandSendSsh.html">IcingaApiCommandSendSsh</a>.</p>

<p><a href="interfaceIcingaApiCommandInterface-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIcingaApiCommandInterface.html#abead368d10d6c6e6dfc69c42221e2414">checkConfig</a> (array $config)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIcingaApiCommandInterface.html#a8574f1607f5cde707e2100d9cb90e46a">setConfig</a> (array $config)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIcingaApiCommandInterface.html#a85c85f56d07d7d995084e616327b517d">setCommand</a> (array $command)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIcingaApiCommandInterface.html#a3538f1c7d8b429a643bc1859611e8292">send</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIcingaApiCommandInterface.html#a03076d1044631dcbb79f21d28c4477cf">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 &lt;christian <a href="mailto:doebler@netways.de">doebler@netways.de</a>&gt; </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abead368d10d6c6e6dfc69c42221e2414"></a><!-- doxytag: member="IcingaApiCommandInterface::checkConfig" ref="abead368d10d6c6e6dfc69c42221e2414" args="(array $config)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiCommandInterface::checkConfig </td>
          <td>(</td>
          <td class="paramtype">array $&nbsp;</td>
          <td class="paramname"> <em>config</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>checks the configuration values for the current 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>array</em>&nbsp;</td><td>$config interface configuration </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>boolean true if configuration data is valid otherwise false </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

<p>Implemented in <a class="el" href="classIcingaApiCommandSendPipe.html#a60f8bd5e8102b5c267b7282a4e4202a7">IcingaApiCommandSendPipe</a>, and <a class="el" href="classIcingaApiCommandSendSsh.html#a5a6a6200b7466171e34b000050f8ae73">IcingaApiCommandSendSsh</a>.</p>

</div>
</div>
<a class="anchor" id="a03076d1044631dcbb79f21d28c4477cf"></a><!-- doxytag: member="IcingaApiCommandInterface::getCallStack" ref="a03076d1044631dcbb79f21d28c4477cf" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiCommandInterface::getCallStack </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>returns the call stack </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>&nbsp;</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>array call stack </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

<p>Implemented in <a class="el" href="classIcingaApiCommandSendPipe.html#a7dcc2b547c43b6e6db79debe60bf9f4a">IcingaApiCommandSendPipe</a>, and <a class="el" href="classIcingaApiCommandSendSsh.html#a009d4a0ba616e0ccee3ca9eacade7083">IcingaApiCommandSendSsh</a>.</p>

</div>
</div>
<a class="anchor" id="a3538f1c7d8b429a643bc1859611e8292"></a><!-- doxytag: member="IcingaApiCommandInterface::send" ref="a3538f1c7d8b429a643bc1859611e8292" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiCommandInterface::send </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>sends the commands by using the current 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>&nbsp;</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 &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

<p>Implemented in <a class="el" href="classIcingaApiCommandSendPipe.html#ac8f51b6fa5d8979d5fb789ec058d5db6">IcingaApiCommandSendPipe</a>, and <a class="el" href="classIcingaApiCommandSendSsh.html#a3e6b4d7262b1ff51de3a6f53f7532f0b">IcingaApiCommandSendSsh</a>.</p>

</div>
</div>
<a class="anchor" id="a85c85f56d07d7d995084e616327b517d"></a><!-- doxytag: member="IcingaApiCommandInterface::setCommand" ref="a85c85f56d07d7d995084e616327b517d" args="(array $command)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiCommandInterface::setCommand </td>
          <td>(</td>
          <td class="paramtype">array $&nbsp;</td>
          <td class="paramname"> <em>command</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>sets the command(s) to send </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>&nbsp;</td><td>$command commands to send </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classIcingaApiCommandSend.html">IcingaApiCommandSend</a> Object current interface object </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

</div>
</div>
<a class="anchor" id="a8574f1607f5cde707e2100d9cb90e46a"></a><!-- doxytag: member="IcingaApiCommandInterface::setConfig" ref="a8574f1607f5cde707e2100d9cb90e46a" args="(array $config)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IcingaApiCommandInterface::setConfig </td>
          <td>(</td>
          <td class="paramtype">array $&nbsp;</td>
          <td class="paramname"> <em>config</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>sets the configuration values for the current 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>array</em>&nbsp;</td><td>$config interface configuration </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classIcingaApiCommandSend.html">IcingaApiCommandSend</a> Object current interface object </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Christian Doebler &lt;<a href="mailto:christian.doebler@netways.de">christian.doebler@netways.de</a>&gt; </dd></dl>

<p>Implemented in <a class="el" href="classIcingaApiCommandSendPipe.html#a9259aaa79c8aabe555ce26574c5c651a">IcingaApiCommandSendPipe</a>, and <a class="el" href="classIcingaApiCommandSendSsh.html#abeda64cb96d3f3eed1aad69543ad3a89">IcingaApiCommandSendSsh</a>.</p>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>/home/jefe/workspace_nw/icinga-api/objects/command/<a class="el" href="IcingaApiCommandInterface_8php.html">IcingaApiCommandInterface.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&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>