PHP Class Predis\Connection\PhpiredisSocketConnection

This class is intended to provide an optional low-overhead alternative for processing responses from Redis compared to the standard pure-PHP classes. Differences in speed when dealing with short inline responses are practically nonexistent, the actual speed boost is for big multibulk responses when this protocol processor can parse and return responses very fast. For instructions on how to build and install the phpiredis extension, please consult the repository of the project. The connection parameters supported by this class are: - scheme: it can be either 'tcp' or 'unix'. - host: hostname or IP address of the server. - port: TCP port of the server. - path: path of a UNIX domain socket when scheme is 'unix'. - timeout: timeout to perform the connection. - read_write_timeout: timeout of read / write operations.
Author: Daniele Alessandri ([email protected])
Inheritance: extends AbstractConnection
Datei anzeigen Open project: tillkruss/redis-object-cache

Public Methods

Method Description
__construct ( Predis\Connection\ParametersInterface $parameters )
__destruct ( ) Disconnects from the server and destroys the underlying resource and the protocol reader resource when PHP's garbage collector kicks in.
__wakeup ( )
connect ( )
disconnect ( )
read ( )
writeRequest ( Predis\Command\CommandInterface $command )

Protected Methods

Method Description
assertExtensions ( ) Checks if the socket and phpiredis extensions are loaded in PHP.
assertParameters ( Predis\Connection\ParametersInterface $parameters )
createResource ( )
getAddress ( Predis\Connection\ParametersInterface $parameters ) : string Gets the address of an host from connection parameters.
getErrorHandler ( ) : Closure Returns the handler used by the protocol reader for error responses.
getReader ( ) : resource Returns the underlying protocol reader resource.
getStatusHandler ( ) : Closure Returns the handler used by the protocol reader for inline responses.
write ( $buffer )

Private Methods

Method Description
connectWithTimeout ( resource $socket, string $address, Predis\Connection\ParametersInterface $parameters ) : string Opens the actual connection to the server with a timeout.
createReader ( ) : resource Creates a new instance of the protocol reader resource.
emitSocketError ( ) Helper method used to throw exceptions on socket errors.
setSocketOptions ( resource $socket, Predis\Connection\ParametersInterface $parameters ) Sets options on the socket resource from the connection parameters.

Method Details

__construct() public method

public __construct ( Predis\Connection\ParametersInterface $parameters )
$parameters Predis\Connection\ParametersInterface

__destruct() public method

Disconnects from the server and destroys the underlying resource and the protocol reader resource when PHP's garbage collector kicks in.
public __destruct ( )

__wakeup() public method

public __wakeup ( )

assertExtensions() protected method

Checks if the socket and phpiredis extensions are loaded in PHP.
protected assertExtensions ( )

assertParameters() protected method

protected assertParameters ( Predis\Connection\ParametersInterface $parameters )
$parameters Predis\Connection\ParametersInterface

connect() public method

public connect ( )

createResource() protected method

protected createResource ( )

disconnect() public method

public disconnect ( )

getAddress() protected static method

Gets the address of an host from connection parameters.
protected static getAddress ( Predis\Connection\ParametersInterface $parameters ) : string
$parameters Predis\Connection\ParametersInterface Parameters used to initialize the connection.
return string

getErrorHandler() protected method

Returns the handler used by the protocol reader for error responses.
protected getErrorHandler ( ) : Closure
return Closure

getReader() protected method

Returns the underlying protocol reader resource.
protected getReader ( ) : resource
return resource

getStatusHandler() protected method

Returns the handler used by the protocol reader for inline responses.
protected getStatusHandler ( ) : Closure
return Closure

read() public method

public read ( )

write() protected method

protected write ( $buffer )

writeRequest() public method

public writeRequest ( Predis\Command\CommandInterface $command )
$command Predis\Command\CommandInterface