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
Public Member Functions | Protected Attributes | List of all members
HCE\admin\Node Class Reference

Public Member Functions

 setHost ($hostName)
 getHost ()
 setPort ($port)
 getPort ()
 setTimeout ($timeout)
 getTimeout ()
 setErrorCode ($errorCode)
 getErrorCode ()
 __construct ($host=null, $port=null, $timeout=null)
 __destruct ()

Protected Attributes

 $host = \HCE\transport\PROTOCOL_HOST_DEFAULT
 $port = \HCE\transport\PROTOCOL_PORT_ADMIN_DEFAULT
 $timeout = NODE_TIMEOUT
 $error = 0

Detailed Description

HCE Node class Implements basic properties of node

Definition at line 20 of file Node.inc.php.

Constructor & Destructor Documentation

HCE\admin\Node::__construct (   $host = null,
  $port = null,
  $timeout = null 
)

Create instance of node object

Parameters
$host- host name
$port- port
$timeout- timeout

Definition at line 134 of file Node.inc.php.

HCE\admin\Node::__destruct ( )

delete node object

Definition at line 152 of file Node.inc.php.

Member Function Documentation

HCE\admin\Node::getErrorCode ( )

Returns erro code of last executed request

Returns
error code

Definition at line 117 of file Node.inc.php.

HCE\admin\Node::getHost ( )

Returns host name

Returns
host name

Definition at line 57 of file Node.inc.php.

HCE\admin\Node::getPort ( )

Returns port

Returns
port

Definition at line 77 of file Node.inc.php.

HCE\admin\Node::getTimeout ( )

Returns request timeout

Returns
timeout

Definition at line 97 of file Node.inc.php.

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

Set error code

Parameters
$errorCode- error code

Definition at line 108 of file Node.inc.php.

HCE\admin\Node::setHost (   $hostName)

Set host name

Parameters
$hostName- host name

Definition at line 48 of file Node.inc.php.

HCE\admin\Node::setPort (   $port)

Set port

Parameters
$port- port

Definition at line 68 of file Node.inc.php.

HCE\admin\Node::setTimeout (   $timeout)

Set timeout

Parameters
$timeout- request timeout

Definition at line 88 of file Node.inc.php.

Member Data Documentation

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

Node error code of last operation result

Definition at line 39 of file Node.inc.php.

HCE\admin\Node::$host = \HCE\transport\PROTOCOL_HOST_DEFAULT
protected

Node host name

Definition at line 24 of file Node.inc.php.

HCE\admin\Node::$port = \HCE\transport\PROTOCOL_PORT_ADMIN_DEFAULT
protected

Node port

Definition at line 29 of file Node.inc.php.

HCE\admin\Node::$timeout = NODE_TIMEOUT
protected

Timeout

Definition at line 34 of file Node.inc.php.

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