zSocketClient Class Reference
[Socket Operations]

SocketClient Class. More...

Inheritance diagram for zSocketClient:

[legend]

Collaboration diagram for zSocketClient:

[legend]

Public Member Functions
	zSocketClient ($host=null, $port=null, $timeout=null)
	__construct ($host=null, $port=null, $timeout=null)
	setHost ($hostName)
	Sets the Host Name.
	getHost ()
	Get the Host Name.
	setPort ($port)
	set the Connection Port
	getPort ()
	Get the Conection Port.
	setTimeOut ($timeOut)
	Set the Connection Timeout.
	getTimeOut ()
	Returns the Timeout.
	setSeparator ($sep)
	Set the separatotor or .
	useUDP ($flag=true)
	Sets Wheather to use UDP Connection or not.
	isUDP ()
	Returns Wheather teh Connection is UDP or not.
	useTCP ($flag=true)
	Wheather to use TCP or not.
	isTCP ()
	Returns boolean vlue wheather or not The Connection is TCP.
	useSSL ($flag=true)
	Use SSL in the Connection.
	isSSL ()
	Returns Boolean value wheather the Connection is a SSL Connection.
	useTLS ($flag=true)
	Use TLS Connection.
	isTLS ()
	Checks wheather or not it is a TLS Connection.
	connect ()
	Connect the Socket with the Server.
	isConnected ()
	Returns Boolean value wheather socket is Connected or not.
	isConnectable ()
	Checks Wheathers its Connectable or not.
	send ($data)
	Send the Data to the Server.
	receive ($maxLen=0)
	Reacieve Data from the server.
	disconnect ()
	Disconnect from the Server.
	__destruct ()
	Automatically Disconnect upon destruct.
Data Fields
	$host
	$port
	$timeout
	$sep
	$connected
	$map
	$protocol
	$handle
	$cnv
	$conversation

---

Detailed Description

SocketClient Class.

all kinds of sockets can inherits from this Class. it provides abstraction all native socket level operations

Definition at line 30 of file socket.php.

---

Constructor & Destructor Documentation

zSocketClient::__construct( unknown $host = null, unknown $port = null, unknown $timeout = null )

Definition at line 45 of file socket.php.

References $host, $port, and $timeout.

Show Source

                                                             {
    $this->host = $host;
    $this->port = $port;
    $this->timeout = $timeout;
    $this->sep = "\r\n";
    $this->protocol = 'tcp';
    $this->conversation = new stdClass();
    $this->conversation->client = array();
    $this->conversation->server = array();
  }

Top 

zSocketClient::__destruct( ) 

Automatically Disconnect upon destruct.

Reimplemented from zCore.

Definition at line 272 of file socket.php.

References disconnect().

Show Source

                       {
    $this->disconnect();
  }

Here is the call graph for this function:

Top 

---

Member Function Documentation

zSocketClient::zSocketClient( unknown $host = null, unknown $port = null, unknown $timeout = null )

Definition at line 42 of file socket.php.

References $host, $port, $timeout, and zCore::__construct().

Show Source

                                                               {
    $this->__construct($host, $port, $timeout);
  }

Here is the call graph for this function:

Top 

zSocketClient::setHost( string $hostName ) 

Sets the Host Name.

Parameters:

$hostName

Definition at line 60 of file socket.php.

Show Source

                             {
    $this->host = $hostName;
  }

Top 

zSocketClient::getHost( ) 

Get the Host Name.

Definition at line 67 of file socket.php.

Show Source

                    {
    return $this->host;
  }

Top 

zSocketClient::setPort( int $port ) 

set the Connection Port

Parameters:

$port

Definition at line 75 of file socket.php.

References $port.

Show Source

                         {
    $this->port = $port;
  }

Top 

zSocketClient::getPort( ) 

Get the Conection Port.

Definition at line 82 of file socket.php.

Show Source

                    {
    return $this->port;
  }

Top 

zSocketClient::setTimeOut( int $timeOut ) 

Set the Connection Timeout.

Parameters:

$timeOut

Definition at line 90 of file socket.php.

Show Source

                               {
    $this->timeout = $timeOut;
  }

Top 

zSocketClient::getTimeOut( ) 

Returns the Timeout.

Returns:

int

Definition at line 98 of file socket.php.

Show Source

                       {
    return $this->timeout;
  }

Top 

zSocketClient::setSeparator( string $sep ) 

Set the separatotor
or
.

Parameters:

$sep

Definition at line 106 of file socket.php.

References $sep.

Show Source

                             {
    $this->sep = $sep;
  }

Top 

zSocketClient::useUDP( boolean $flag = true ) 

Sets Wheather to use UDP Connection or not.

Parameters:

$flag

Definition at line 114 of file socket.php.

Show Source

                               {
    $this->protocol = $flag ? 'udp' : 'tcp';
  }

Top 

zSocketClient::isUDP( ) 

Returns Wheather teh Connection is UDP or not.

Returns:

booleans

Definition at line 122 of file socket.php.

Show Source

                  {
    return ($this->protocol == 'udp');
  }

Top 

zSocketClient::useTCP( booleans $flag = true ) 

Wheather to use TCP or not.

Parameters:

$flag

Definition at line 130 of file socket.php.

Show Source

                             {
    $this->protocol = $flag ? 'tcp' : $this->protocol;
  }

Top 

zSocketClient::isTCP( ) 

Returns boolean vlue wheather or not The Connection is TCP.

Returns:

boolean

Definition at line 138 of file socket.php.

Show Source

                  {
    return ($this->protocol == 'tcp');
  }

Top 

zSocketClient::useSSL( booleans $flag = true ) 

Use SSL in the Connection.

Definition at line 145 of file socket.php.

Show Source

                               {
    $this->protocol = $flag ? 'ssl' : '';
  }

Top 

zSocketClient::isSSL( ) 

Returns Boolean value wheather the Connection is a SSL Connection.

Returns:

boolean

Definition at line 153 of file socket.php.

Show Source

                  {
    return ($this->protocol == 'ssl');
  }

Top 

zSocketClient::useTLS( unknown_type $flag = true ) 

Use TLS Connection.

Parameters:

$flag

Definition at line 161 of file socket.php.

Show Source

                             {
    $this->protocol = $flag ? 'tls' : '';
  }

Top 

zSocketClient::isTLS( ) 

Checks wheather or not it is a TLS Connection.

Returns:

boolean

Definition at line 169 of file socket.php.

Show Source

                  {
    return ($this->protocol == 'tls');
  }

Top 

zSocketClient::connect( ) 

Connect the Socket with the Server.

Definition at line 176 of file socket.php.

References zLogger::debug(), zLogger::error(), isConnectable(), isConnected(), and perror().

Referenced by zLogClient::__construct().

Show Source

                    {
    if(!$this->isConnectable()){
      perror("<code>zigmoyd.socket.connect</code><br />Sorry Server not Connectable");
      exit;
    }
    if(!$this->isConnected()){
      if(!$this->handle = @pfsockopen($this->host, $this->port, $errNo, $errStr, $this->timeout)){
        perror("<code>zigmoyd.socket.connect</code><br />Failed to Connect with $this->host on Port $this->port<br />Error No: $errNo<br />Error Text: $errStr");
        if(class_exists('zLogger'))zLogger::error("Failed to Connect with Host $this->host on Port $this->port Error: ($errNo) $errStr", 'socket.connect');
        $this->connected = false;
      }else{
        if(class_exists('zLogger'))zLogger::debug("Successfully Connected to Host $this->host on Port $this->port<br />Error No: $errNo<br />Error Text: $errStr", 'socket.connect');
        $this->connected = true;
      }
    }
    return $this->connected;
  }

Here is the call graph for this function:

Top 

zSocketClient::isConnected( ) 

Returns Boolean value wheather socket is Connected or not.

Returns:

boolean

Definition at line 198 of file socket.php.

Referenced by connect().

Show Source

                        {
    return $this->connected;
  }

Top 

zSocketClient::isConnectable( ) 

Checks Wheathers its Connectable or not.

Returns:

boolean

Definition at line 206 of file socket.php.

References zLogger::error(), and perror().

Referenced by connect().

Show Source

                          {
    if(strlen($this->protocol) <= 1){
      perror('<code>zigmoyd.socket.isConnectable</code><br />Invalid Protocol');
      if(class_exists('zLogger'))zLogger::error('Invalid Protocol', 'zigmoyd.socket');
      return false;
    }
    if(strlen($this->host) <= 1){
      perror('<code>zigmoyd.socket.isConnectable</code><br />Invalid Host');
      if(class_exists('zLogger'))zLogger::error('Invalid Host', 'zigmoyd.socket');
      return false;
    }
    if(strlen($this->port) <= 1){
      perror('<code>zigmoyd.socket.isConnectable</code><br />Invalid Port');
      if(class_exists('zLogger'))zLogger::error('Invalid Port', 'zigmoyd.socket');
      return false;
    }
    if(!$this->timeout){
      $this->timeout = 30;
    }
    return true;
  }

Here is the call graph for this function:

Top 

zSocketClient::send( string $data ) 

Send the Data to the Server.

returns Success value in Boolean

Parameters:

$data

Returns:

boolean

Definition at line 233 of file socket.php.

References perror().

Referenced by zLogClient::write().

Show Source

                      {
    $this->conversation->client[] = $data;
    fflush($this->handle);
    $ret = fwrite($this->handle, $data.$this->sep);
    if(!$ret)perror('<code>zigmoyd.socket.send</code><br />Failed to Write on Sicket');
    return $ret;
  }

Here is the call graph for this function:

Top 

zSocketClient::receive( int $maxLen = 0 ) 

Reacieve Data from the server.

Parameters:

$maxLen

Definition at line 245 of file socket.php.

Show Source

                             {
    $return = '';
    while(is_string(($ch = fgetc($this->handle)))){
      if($maxLen != 1){
        $return .= $ch;
        --$maxLen;
      }
    }
    $this->conversation->server[] = $return;
    return $return;
  }

Top 

zSocketClient::disconnect( ) 

Disconnect from the Server.

Definition at line 260 of file socket.php.

References zLogger::debug().

Referenced by __destruct().

Show Source

                       {
    if(is_resource($this->handle)){
      if(class_exists('zLogger'))zLogger::debug("Closing Socket Connection as not yet Closed", "socket.disconnect");
      fclose($this->handle);
    }else{
      if(class_exists('zLogger'))zLogger::debug("NOT Closing Socket Connection as already Closed", "socket.disconnect");
    }
  }

Here is the call graph for this function:

Top 

---

Field Documentation

zSocketClient::$host

Definition at line 31 of file socket.php.

Referenced by __construct(), and zSocketClient().

Top 

zSocketClient::$port

Definition at line 32 of file socket.php.

Referenced by __construct(), setPort(), and zSocketClient().

Top 

zSocketClient::$timeout

Definition at line 33 of file socket.php.

Referenced by __construct(), and zSocketClient().

Top 

zSocketClient::$sep

Definition at line 34 of file socket.php.

Referenced by setSeparator().

Top 

zSocketClient::$connected

Definition at line 35 of file socket.php.

Top 

zSocketClient::$map

Definition at line 36 of file socket.php.

Top 

zSocketClient::$protocol

Definition at line 37 of file socket.php.

Top 

zSocketClient::$handle

Definition at line 38 of file socket.php.

Top 

zSocketClient::$cnv

Definition at line 39 of file socket.php.

Top 

zSocketClient::$conversation

Definition at line 40 of file socket.php.

Top 

---

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

• socket.php