Files
predis/lib/Predis/CommunicationException.php
T
Daniele Alessandri 4e6ed3f26d [phpdoc] Add API documentation.
This is a starting point to add a documentation of the whole set of APIs and
classes of Predis. The next step will be to actually improve and extend it.
2011-10-21 12:54:24 +02:00

59 lines
1.4 KiB
PHP

<?php
/*
* This file is part of the Predis package.
*
* (c) Daniele Alessandri <suppakilla@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Predis;
use Predis\Network\IConnectionSingle;
/**
* Base exception class for network-related errors.
*
* @author Daniele Alessandri <suppakilla@gmail.com>
*/
abstract class CommunicationException extends PredisException
{
private $_connection;
/**
* @param IConnectionSingle $connection Connection that generated the exception.
* @param string $message Error message.
* @param int $code Error code.
* @param \Exception $innerException Inner exception for wrapping the original error.
*/
public function __construct(IConnectionSingle $connection,
$message = null, $code = null, \Exception $innerException = null)
{
parent::__construct($message, $code, $innerException);
$this->_connection = $connection;
}
/**
* Gets the connection that generated the exception.
*
* @return IConnectionSingle
*/
public function getConnection()
{
return $this->_connection;
}
/**
* Indicates if the receiver should reset the underlying connection.
*
* @return Boolean
*/
public function shouldResetConnection()
{
return true;
}
}