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\transport\Connection Class Reference

Public Member Functions

 setConnectionArray ($connectionArray=NULL)
 getConnectionArray ()
 __get ($name)
 __construct ($connectionArray=NULL)
 open ()
 close ()
 reset ()
 getDSN ($protocol=PROTOCOL_ADMIN_DEFAULT)
 __destruct ()

Protected Attributes

 $connectionArray = array ()

Detailed Description

HCE Connection class, implements basic functionality of client-side API for HCE node application interaction

Definition at line 23 of file Connection.inc.php.

Constructor & Destructor Documentation

HCE\transport\Connection::__construct (   $connectionArray = NULL)

create instance and set the HCE connection array property (new zmq context, zmq socket and connect using specified or default options)

Parameters
$connectionArray- array of connection configuration options: host, port, type {HCE, HCE}, identity - string of unique client Id in cluster

Definition at line 67 of file Connection.inc.php.

Here is the call graph for this function:

HCE\transport\Connection::__destruct ( )

Delete HCE Connection object (disconnect zmq socket, free zmq socket and context)

Definition at line 169 of file Connection.inc.php.

Member Function Documentation

HCE\transport\Connection::__get (   $name)

returns connection array fields by name as class members fields values

Parameters
$name- field name
Returns
field value

Definition at line 55 of file Connection.inc.php.

HCE\transport\Connection::close ( )

Close connection, disconnect ZMQ socket

Returns
ZMQ socket disconnect

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

HCE\transport\Connection::getConnectionArray ( )

returns connection array fields by name as class members fields values

Returns
field value

Definition at line 44 of file Connection.inc.php.

HCE\transport\Connection::getDSN (   $protocol = PROTOCOL_ADMIN_DEFAULT)

Get ZMQ socket't dsn string

Returns
ZMQ socket dsn string

Definition at line 161 of file Connection.inc.php.

HCE\transport\Connection::open ( )

Open connection, connect ZMQ socket

Returns
ZMQ socket connect

Definition at line 132 of file Connection.inc.php.

HCE\transport\Connection::reset ( )

Reset connection, disconnect ZMQ socket

Returns
ZMQ socket connect

Definition at line 151 of file Connection.inc.php.

HCE\transport\Connection::setConnectionArray (   $connectionArray = NULL)

Set connection array

Parameters
$connectionArray- connection array

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

Member Data Documentation

HCE\transport\Connection::$connectionArray = array ()
protected

Connection array fields container

Definition at line 27 of file Connection.inc.php.

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