HCE Project PHP language client API bindings OOP style  1.1.1
Hierarchical Cluster Engine PHP Client Interface API OOP style
 All Classes Namespaces Files Functions Variables Pages
HCE\admin\NodeCommand Class Reference

Public Member Functions

 setHandlerName ($handlerName)
 getHandlerName ()
 setCommandName ($commandName)
 getCommandName ()
 setCommandParameters ($commandParameters)
 getCommandParameters ()
 getParametersData ($delimiter=CMD_PARAMETERS_DELIMITER)
 getMessageBody ($delimiter=CMD_PARAMETERS_DELIMITER)
 setErrorCode ($errorCode)
 getErrorCode ()
 __construct ($commandName=null, $commandParameters=null, $handlerName=null)
 __destruct ()

Protected Attributes

 $handlerName = \HCE\transport\HANDLER_ADMIN
 $commandName = CMD_ECHO
 $commandParameters = array ()
 $error = 0

Detailed Description

HCE Node command class Implements basic comands for low level node management

Definition at line 21 of file NodeCommand.inc.php.

Constructor & Destructor Documentation

HCE\admin\NodeCommand::__construct (   $commandName = null,
  $commandParameters = null,
  $handlerName = null 
)

Create instance of node command object

Parameters
$commandName- command name
$commandParameters- command parameters

Definition at line 156 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::__destruct ( )

delete node command object

Definition at line 173 of file NodeCommand.inc.php.

Member Function Documentation

HCE\admin\NodeCommand::getCommandName ( )

Returns command name

Returns
command name

Definition at line 78 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::getCommandParameters ( )

Returns command parameters array

Returns
command parameters

Definition at line 104 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::getErrorCode ( )

Returns erro code of last executed request

Returns
error code

Definition at line 142 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::getHandlerName ( )

Returns handler name

Returns
handler name

Definition at line 58 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::getMessageBody (   $delimiter = CMD_PARAMETERS_DELIMITER)

Get command message body string buffer

Returns
admin command body ready to sent by transport

Definition at line 122 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::getParametersData (   $delimiter = CMD_PARAMETERS_DELIMITER)

Get command parameters string buffer

Returns
admin command parameters string buffer

Definition at line 113 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::setCommandName (   $commandName)

Set command name

Parameters
$commandName- command name

Definition at line 69 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::setCommandParameters (   $commandParameters)

Set command parameters array

Parameters
$commandParameters- command parameters array
Returns
true if set or false if not.

Definition at line 90 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::setErrorCode (   $errorCode)

Set error code

Parameters
$errorCode- error code

Definition at line 133 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::setHandlerName (   $handlerName)

Set handler name

Parameters
$handlerName- handler name

Definition at line 49 of file NodeCommand.inc.php.

Member Data Documentation

HCE\admin\NodeCommand::$commandName = CMD_ECHO
protected

Admin node management command name

Definition at line 30 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::$commandParameters = array ()
protected

Admin node management command parameters

Definition at line 35 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::$error = 0
protected

Request error code of last operation result

Definition at line 40 of file NodeCommand.inc.php.

HCE\admin\NodeCommand::$handlerName = \HCE\transport\HANDLER_ADMIN
protected

Admin node management handler name

Definition at line 25 of file NodeCommand.inc.php.


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