Files
predis/lib/Predis/CommunicationException.php
T
Daniele Alessandri abd284c972 Complete reorganization of the Predis\Connection namespace.
* Renamed SingleConnectionInterface to NodeConnectionInterface since
  this name is better and makes even more sense in the context of
  cluster and replication scenarios.

* Moved specialized aggregate connections (the ones implementing both
  predis and redis cluster and master/slave replication) in a newly
  created Predis\Connection\Aggregate sub-namespace.

* Removed the "Connection" part from names of aggregate connection
  interfaces in the Predis\Connection\Aggregate sub-namespace.

* Changed "Composable" to "Composite" in the name of interfaces and
  classes that can use pluggable protocol processors.
2014-06-03 15:19:32 +02:00

80 lines
2.0 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 Exception;
use Predis\Connection\NodeConnectionInterface;
/**
* Base exception class for network-related errors.
*
* @author Daniele Alessandri <suppakilla@gmail.com>
*/
abstract class CommunicationException extends PredisException
{
private $connection;
/**
* @param NodeConnectionInterface $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(
NodeConnectionInterface $connection,
$message = null,
$code = null,
Exception $innerException = null
) {
parent::__construct($message, $code, $innerException);
$this->connection = $connection;
}
/**
* Gets the connection that generated the exception.
*
* @return NodeConnectionInterface
*/
public function getConnection()
{
return $this->connection;
}
/**
* Indicates if the receiver should reset the underlying connection.
*
* @return bool
*/
public function shouldResetConnection()
{
return true;
}
/**
* Helper method to handle exceptions generated by a connection object.
*
* @param CommunicationException $exception Exception.
*/
public static function handle(CommunicationException $exception)
{
if ($exception->shouldResetConnection()) {
$connection = $exception->getConnection();
if ($connection->isConnected()) {
$connection->disconnect();
}
}
throw $exception;
}
}