Move @property-read tags for parameters and options to interfaces.

This actually makes sense since whatever the actual implementation is,
classes implementing these interfaces should provide at least those
properties that are actively used through the library.
This commit is contained in:
Daniele Alessandri
2013-12-22 14:54:08 +01:00
parent cfa456fdd1
commit 9a38d2caec
4 changed files with 25 additions and 26 deletions
@@ -14,6 +14,23 @@ namespace Predis\Connection;
/**
* Interface for classes providing their own logic for connection parameters.
*
* The actual list of connection parameters depends on the features supported by
* each connection backend class (please refer to their specific documentation),
* but the most common parameters used through the library are:
*
* @property-read string scheme Connection scheme, such as 'tcp' or 'unix'.
* @property-read string host IP address or hostname of Redis.
* @property-read int port TCP port on which Redis is listening to.
* @property-read string path Path of a UNIX domain socket file.
* @property-read string alias Alias for the connection.
* @property-read float timeout Timeout for the connect() operation.
* @property-read float read_write_timeout Timeout for read() and write() operations.
* @property-read bool async_connect Performs the connect() operation asynchronously.
* @property-read bool tcp_nodelay Toggles the Nagle's algorithm for coalescing.
* @property-read bool persistent Leaves the connection open after a GC collection.
* @property-read string password Password to access Redis (see the AUTH command).
* @property-read string database Database index (see the SELECT command).
*
* @author Daniele Alessandri <suppakilla@gmail.com>
*/
interface ParametersInterface