Documentation

StreamConnection extends AbstractConnection
in package

Standard connection to Redis servers implemented on top of PHP's streams.

The connection parameters supported by this class are:.

  • scheme: it can be either 'redis', 'tcp', 'rediss', 'tls' 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 (default is 5 seconds).
  • read_write_timeout: timeout of read / write operations.
  • async_connect: performs the connection asynchronously.
  • tcp_nodelay: enables or disables Nagle's algorithm for coalescing.
  • persistent: the connection is left intact after a GC collection.
  • ssl: context options array (see http://php.net/manual/en/context.ssl.php)
Tags
author

Daniele Alessandri suppakilla@gmail.com

Table of Contents

$initCommands  : mixed
$parameters  : mixed
$cachedId  : mixed
$resource  : mixed
__construct()  : mixed
__destruct()  : mixed
Disconnects from the server and destroys the underlying resource when the garbage collector kicks in only if the connection has not been marked as persistent.
__sleep()  : mixed
{@inheritdoc}
__toString()  : string
Returns a string representation of the connection.
addConnectCommand()  : mixed
Pushes the given command into a queue of commands executed when establishing the actual connection to Redis.
connect()  : mixed
{@inheritdoc}
disconnect()  : mixed
{@inheritdoc}
executeCommand()  : mixed
{@inheritdoc}
getParameters()  : ParametersInterface
Returns the parameters used to initialize the connection.
getResource()  : mixed
Returns the underlying resource used to communicate with Redis.
isConnected()  : mixed
{@inheritdoc}
read()  : mixed
{@inheritdoc}
readResponse()  : mixed
{@inheritdoc}
writeRequest()  : mixed
{@inheritdoc}
assertParameters()  : ParametersInterface
Checks some of the parameters used to initialize the connection.
assertSslSupport()  : mixed
Checks needed conditions for SSL-encrypted connections.
createResource()  : mixed
Creates the underlying resource used to communicate with Redis.
createStreamSocket()  : resource
Creates a connected stream socket resource.
getIdentifier()  : string
Gets an identifier for the connection.
onConnectionError()  : mixed
Helper method to handle connection errors.
onProtocolError()  : mixed
Helper method to handle protocol errors.
tcpStreamInitializer()  : resource
Initializes a TCP stream resource.
tlsStreamInitializer()  : resource
Initializes a SSL-encrypted TCP stream resource.
unixStreamInitializer()  : resource
Initializes a UNIX stream resource.
write()  : mixed
Performs a write operation over the stream of the buffer containing a command serialized with the Redis wire protocol.
createExceptionMessage()  : string
Helper method that returns an exception message augmented with useful details from the connection parameters.

Properties

Methods

__destruct()

Disconnects from the server and destroys the underlying resource when the garbage collector kicks in only if the connection has not been marked as persistent.

public __destruct() : mixed
Return values
mixed —

__toString()

Returns a string representation of the connection.

public __toString() : string
Return values
string —

addConnectCommand()

Pushes the given command into a queue of commands executed when establishing the actual connection to Redis.

public addConnectCommand(CommandInterface $command) : mixed
Parameters
$command : CommandInterface

Instance of a Redis command.

Return values
mixed —

connect()

{@inheritdoc}

public connect() : mixed
Return values
mixed —

disconnect()

{@inheritdoc}

public disconnect() : mixed
Return values
mixed —

getResource()

Returns the underlying resource used to communicate with Redis.

public getResource() : mixed
Return values
mixed —

isConnected()

{@inheritdoc}

public isConnected() : mixed
Return values
mixed —

assertSslSupport()

Checks needed conditions for SSL-encrypted connections.

protected assertSslSupport(ParametersInterface $parameters) : mixed
Parameters
$parameters : ParametersInterface

Initialization parameters for the connection.

Tags
throws
InvalidArgumentException
Return values
mixed —

createResource()

Creates the underlying resource used to communicate with Redis.

protected createResource() : mixed
Return values
mixed —

createStreamSocket()

Creates a connected stream socket resource.

protected createStreamSocket(ParametersInterface $parameters, string $address, int $flags) : resource
Parameters
$parameters : ParametersInterface

Connection parameters.

$address : string

Address for stream_socket_client().

$flags : int

Flags for stream_socket_client().

Return values
resource —

getIdentifier()

Gets an identifier for the connection.

protected getIdentifier() : string
Return values
string —

onConnectionError()

Helper method to handle connection errors.

protected onConnectionError(string $message[, int $code = null ]) : mixed
Parameters
$message : string

Error message.

$code : int = null

Error code.

Return values
mixed —

onProtocolError()

Helper method to handle protocol errors.

protected onProtocolError(string $message) : mixed
Parameters
$message : string

Error message.

Return values
mixed —

tlsStreamInitializer()

Initializes a SSL-encrypted TCP stream resource.

protected tlsStreamInitializer(ParametersInterface $parameters) : resource
Parameters
$parameters : ParametersInterface

Initialization parameters for the connection.

Return values
resource —

write()

Performs a write operation over the stream of the buffer containing a command serialized with the Redis wire protocol.

protected write(string $buffer) : mixed
Parameters
$buffer : string

Representation of a command in the Redis wire protocol.

Return values
mixed —

createExceptionMessage()

Helper method that returns an exception message augmented with useful details from the connection parameters.

private createExceptionMessage(string $message) : string
Parameters
$message : string

Error message.

Return values
string —

Search results