Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

170 lines (151 sloc) 4.487 kb
<?php
/**
* Lithium: the most rad php framework
*
* @copyright Copyright 2012, Union of RAD (http://union-of-rad.org)
* @license http://opensource.org/licenses/bsd-license.php The BSD License
*/
namespace lithium\net;
/**
* Abstract class for connecting to sockets with various adapters.
*
* Currently, Curl, Stream and Context adapters are available.
*/
abstract class Socket extends \lithium\core\Object {
/**
* The resource for the current connection.
*
* @var resource
*/
protected $_resource = null;
/**
* The classes for the socket.
*
* @var array
*/
protected $_classes = array(
'request' => 'lithium\net\Message',
'response' => 'lithium\net\Message'
);
/**
* Auto config.
*
* @var array
*/
protected $_autoConfig = array('classes' => 'merge');
/**
* Constructor.
*
* @param array $config Available configuration options are:
* - `'persistent'`: Use a persistent connection (defaults to `false`).
* - `'protocol'`: Transfer protocol to use (defaults to `'tcp'`).
* - `'host'`: Host name or address (defaults to `'localhost'`).
* - `'login'`: Username for a login (defaults to `'root'`).
* - `'password'`: Password for a login (defaults to `''`).
* - `'port'`: Host port (defaults to `80`).
* - `'timeout'`: Seconds after opening the socket times out (defaults to `30`).
*/
public function __construct(array $config = array()) {
$defaults = array(
'persistent' => false,
'scheme' => 'tcp',
'host' => 'localhost',
'port' => 80,
'timeout' => 30
);
parent::__construct($config + $defaults);
}
/**
* Opens the socket and sets `Socket::$_resource`.
*
* @param array $options Update the config settings.
* @return mixed The open resource on success, `false` otherwise.
*/
public function open(array $options = array()) {
parent::__construct($options + $this->_config);
return false;
}
/**
* Closes the socket and unsets `Socket::$_resource`.
*
* @return boolean `true` on success, `false` otherwise.
*/
abstract public function close();
/**
* Test for the end-of-file on the socket.
*
* @return boolean `true` if end has been reached, `false` otherwise.
*/
abstract public function eof();
/**
* Reads from the socket.
*
* @return object `lithium\net\Message`
*/
abstract public function read();
/**
* Writes data to the socket.
*
* @param mixed $data
* @return boolean `true` if data has been successfully written, `false` otherwise.
*/
abstract public function write($data);
/**
* Sets the timeout on the socket *connection*.
*
* @param integer $time Seconds after the connection times out.
* @return Boolean `true` if timeout has been set, `false` otherwise.
*/
abstract public function timeout($time);
/**
* Sets the encoding of the socket connection.
*
* @param string $charset The character set to use.
* @return boolean `true` if encoding has been set, `false` otherwise.
*/
abstract public function encoding($charset);
/**
* Sets the options to be used in subsequent requests.
*
* @param array $flags If $values is an array, $flags will be used as the
* keys to an associative array of curl options. If $values is not set,
* then $flags will be used as the associative array.
* @param array $value If set, this array becomes the values for the
* associative array of curl options.
* @return void
*/
public function set($flags, $value = null) {}
/**
* Aggregates read and write methods into a coherent request response
*
* @param mixed $message a request object based on `\lithium\net\Message`
* @param array $options
* - '`response`': a fully-namespaced string for the response object
* @return object a response object based on `\lithium\net\Message`
*/
public function send($message = null, array $options = array()) {
$defaults = array('response' => $this->_classes['response']);
$options += $defaults;
if ($this->write($message)) {
$config = array('message' => $this->read()) + $this->_config;
return $this->_instance($options['response'], $config);
}
}
/**
* Destructor.
*
* @return void
*/
public function __destruct() {
$this->close();
}
/**
* Returns the resource.
*
* @return resource
*/
public function resource() {
return $this->_resource;
}
}
?>
Jump to Line
Something went wrong with that request. Please try again.