Comments: on this page. Click to read or post your own.

Class SimpleSocket

Description
Description | Descendents | Vars (details) | Methods (details)

Wrapper for TCP/IP socket.

Located in /sapphire/dev/simpletest/socket.php (line 74) 

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

Inherited Variables

Inherited from SimpleStickyError

SimpleStickyError::$_error
Methods
Description | Descendents | Vars (details) Methods (details)
Constructor SimpleSocket (line 88)

Opens a socket for reading and writing.

  • access: public
SimpleSocket SimpleSocket (string $host, integer $port, integer $timeout, [integer $block_size = 255])
  • string $host: Hostname to send request to.
  • integer $port: Port on remote machine to open.
  • integer $timeout: Connection timeout in seconds.
  • integer $block_size: Size of chunk to read.
close (line 157)

Closes the socket preventing further reads.

Cannot be reopened once closed.

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

Accessor for content so far.

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

Accessor for socket open state.

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

Reads data from the socket. The error suppresion is a workaround for PHP4 always throwing a warning with a secure socket.

  • return: Incoming bytes. False on error.
  • access: public
integer/boolean read ()
write (line 105)

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 180)

Actually opens the low level socket.

  • access: protected
void _openSocket (string $host, integer $port,  &$error_number,  &$error, integer $timeout, integer $error_number, string $error)
  • 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.
  • &$error_number
  • &$error
Redefined in descendants as:

Inherited Methods

Inherited From SimpleStickyError

SimpleStickyError::SimpleStickyError()
SimpleStickyError::getError()
SimpleStickyError::isError()
SimpleStickyError::_clearError()
SimpleStickyError::_setError()
blog comments powered by Disqus

Documentation generated on Sun, 19 Oct 2008 06:46:17 +1300 by phpDocumentor 1.3.2