mirror of
https://github.com/predis/predis.git
synced 2026-08-24 17:49:34 +00:00
Daniele Alessandri
4e6ed3f26d
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.
60 lines
1.4 KiB
PHP
60 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\Network;
|
|
|
|
use Predis\Commands\ICommand;
|
|
|
|
/**
|
|
* Defines a connection object used to communicate with a single Redis server.
|
|
*
|
|
* @author Daniele Alessandri <suppakilla@gmail.com>
|
|
*/
|
|
interface IConnectionSingle extends IConnection
|
|
{
|
|
/**
|
|
* Returns a string representation of the connection.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function __toString();
|
|
|
|
/**
|
|
* Returns the underlying resource used to communicate with a Redis server.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function getResource();
|
|
|
|
/**
|
|
* Gets the parameters used to initialize the connection object.
|
|
*
|
|
* @return IConnectionParameters
|
|
*/
|
|
public function getParameters();
|
|
|
|
/**
|
|
* Pushes the instance of a Redis command to the queue of commands executed
|
|
* when the actual connection to a server is estabilished.
|
|
*
|
|
* @param ICommand $command Instance of a Redis command.
|
|
* @return IConnectionParameters
|
|
*/
|
|
public function pushInitCommand(ICommand $command);
|
|
|
|
/**
|
|
* Reads a reply from the server.
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function read();
|
|
}
|