IcingaApiCommandInterface Interface Reference

Inherited by IcingaApiCommandSendPipe, and IcingaApiCommandSendSsh.

List of all members.

Public Member Functions

 checkConfig (array $config)
 setConfig (array $config)
 setCommand (array $command)
 send ()
 getCallStack ()

Detailed Description

Author:
Christian Doebler <christian doebler@netways.de>

Member Function Documentation

IcingaApiCommandInterface::checkConfig ( array $  config  ) 

checks the configuration values for the current interface

Parameters:
array $config interface configuration
Returns:
boolean true if configuration data is valid otherwise false
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiCommandSendPipe, and IcingaApiCommandSendSsh.

IcingaApiCommandInterface::getCallStack (  ) 

returns the call stack

Parameters:
void 
Returns:
array call stack
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiCommandSendPipe, and IcingaApiCommandSendSsh.

IcingaApiCommandInterface::send (  ) 

sends the commands by using the current interface

Parameters:
void 
Returns:
boolean true on success otherwise false
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiCommandSendPipe, and IcingaApiCommandSendSsh.

IcingaApiCommandInterface::setCommand ( array $  command  ) 

sets the command(s) to send

Parameters:
array $command commands to send
Returns:
IcingaApiCommandSend Object current interface object
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApiCommandInterface::setConfig ( array $  config  ) 

sets the configuration values for the current interface

Parameters:
array $config interface configuration
Returns:
IcingaApiCommandSend Object current interface object
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiCommandSendPipe, and IcingaApiCommandSendSsh.


The documentation for this interface was generated from the following file:

Generated on Thu Jan 14 15:06:46 2010 for ICINGA-API by  doxygen 1.6.1