Class SimpleSocket

Description

Wrapper for TCP/IP socket.

Located in /libraries/pear/simpletest/socket.php (line 74)

StickyError
   |
   --SimpleSocket
Direct descendents
Class Description
 class SimpleSecureSocket Wrapper for TCP/IP socket over TLS.
Variable Summary
 mixed $_handle
 mixed $_is_open
 mixed $_sent
Method Summary
 SimpleSocket SimpleSocket (string $host, integer $port, integer $timeout)
 boolean close ()
 string getSent ()
 boolean isOpen ()
 integer read ([integer $block_size = 255])
 boolean write (string $message)
 void _openSocket (string $host, integer $port, integer &$error_number, string &$error, integer $timeout)
Variables
mixed $_handle (line 75)
mixed $_is_open (line 76)
mixed $_sent (line 77)

Inherited Variables

Inherited from StickyError

StickyError::$_error
Methods
Constructor SimpleSocket (line 86)

Opens a socket for reading and writing.

  • access: public
SimpleSocket SimpleSocket (string $host, integer $port, integer $timeout)
  • string $host: Hostname to send request to.
  • integer $port: Port on remote machine to open.
  • integer $timeout: Connection timeout in seconds.
close (line 155)

Closes the socket preventing further reads.

Cannot be reopened once closed.

  • return: True if successful.
  • access: public
boolean close ()
getSent (line 165)

Accessor for content so far.

  • return: Bytes sent only.
  • access: public
string getSent ()
isOpen (line 145)

Accessor for socket open state.

  • return: True if open.
  • access: public
boolean isOpen ()
read (line 128)

Reads data from the socket.

  • return: Incoming bytes. False on error.
  • access: public
integer read ([integer $block_size = 255])
  • integer $block_size: Size of chunk to read.
write (line 104)

Writes some data to the socket and saves alocal copy.

  • return: True if successful.
  • access: public
boolean write (string $message)
  • string $message: String to send to socket.
_openSocket (line 178)

Actually opens the low level socket.

  • access: protected
void _openSocket (string $host, integer $port, integer &$error_number, string &$error, integer $timeout)
  • string $host: Host to connect to.
  • integer $port: Port on host.
  • integer $error_number: Recipient of error code.
  • string $error: Recipoent of error message.
  • integer $timeout: Maximum time to wait for connection.

Redefined in descendants as:

Inherited Methods

Inherited From StickyError

 StickyError::StickyError()
 StickyError::getError()
 StickyError::isError()
 StickyError::_clearError()
 StickyError::_setError()

Documentation generated on Fri, 11 Feb 2005 18:14:06 +0000 by phpDocumentor 1.3.0RC3