Class php_http_connection

Description

An HTTP Connection class

Located in /includes/domit/php_http_client_generic.php (line 480)


	
			
Variable Summary
object A $connection
string $errorString
string $host
string $path
int $port
int $timeout
Method Summary
php_http_connection php_http_connection ([string $host = ''], [string $path = '/'], [int $port = 80], int $timeout)
boolean connect ()
boolean disconnect ()
string formatHost (string $hostString)
string formatPath (string $pathString)
boolean isOpen ()
Variables
object A $connection = null (line 482)
  • var: reference to the current connection
int $errorNumber = 0 (line 492)
  • var: The error number of the connection
string $errorString = '' (line 494)
  • var: The error string of the connection
string $host (line 484)
  • var: The host of the connection
string $path (line 486)
  • var: The path of the connection
int $port (line 488)
  • var: The port of the connection
int $timeout (line 490)
  • var: The timeout value for the connection
Methods
Constructor php_http_connection (line 503)

HTTP Connection constructor

php_http_connection php_http_connection ([string $host = ''], [string $path = '/'], [int $port = 80], int $timeout)
  • string $host: The connection host name, with or without its protocol prefix
  • string $path: The connection path, not including the host name
  • int $port: The port to establish the client connection on
  • int $timeout: The timeout value for the client connection
connect (line 542)

Establishes a socket connection

  • return: True if the connection was successful
boolean connect ()
disconnect (line 568)

Disconnects the current connection

  • return: True if the connection has been disconnected
boolean disconnect ()
formatHost (line 515)

Formats a host string by stripping off the http:// prefix

  • return: The formatted host name
string formatHost (string $hostString)
  • string $hostString: The host name
formatPath (line 530)

Formats a path string

  • return: The formatted path
string formatPath (string $pathString)
  • string $pathString: The path
isOpen (line 560)

Determines whether the connection is still open

  • return: True if the connection is still open
boolean isOpen ()

Documentation generated on Fri, 4 Mar 2005 13:57:04 +1000 by phpDocumentor 1.3.0RC3