PHP Class Disque\Connection\Manager

Inheritance: implements Disque\Connection\ManagerInterface
Afficher le fichier Open project: mariano/disque-php Class Usage Examples

Protected Properties

Свойство Type Description
$credentials Disque\Connection\Credentials[] After connecting to one, the server returns a list of other nodes in the cluster so we can connect to them automatically, unless the discovered nodes are secured with a password. 'serverAddress' => Credentials
$nodeId string The ID of the node we are currently connected to
$nodePrefixes array Node prefix consists of the first 8 bytes from the node ID. Because job IDs contain the node prefix, it can be used to identify on which node a job lives. 'nodePrefix' => 'nodeId'
$nodes Disque\Connection\Node\Node[] 'nodeId' => Node
$priorityStrategy Disque\Connection\Node\NodePrioritizerInterface The default strategy is the ConservativeJobCountPrioritizer. It prioritizes nodes by their job count, but prefers the current node in order to avoid switching until there is a clearly better node.

Méthodes publiques

Méthode Description
__construct ( )
addServer ( Disque\Connection\Credentials $credentials )
connect ( )
execute ( Disque\Command\CommandInterface $command )
getConnectionFactory ( )
getCredentials ( )
getCurrentNode ( )
getPriorityStrategy ( )
isConnected ( )
setConnectionFactory ( Disque\Connection\Factory\ConnectionFactoryInterface $connectionFactory )
setPriorityStrategy ( Disque\Connection\Node\NodePrioritizerInterface $priorityStrategy )

Méthodes protégées

Méthode Description
findAvailableConnection ( ) : Node Get a functional connection to any known node
getNodeConnection ( Disque\Connection\Credentials $server ) : Node Connect to the node given in the credentials
postprocessExecution ( Disque\Command\CommandInterface $command, mixed $response ) : mixed Postprocess the command execution, eg. update node stats
preprocessExecution ( Disque\Command\CommandInterface $command ) : Disque\Command\CommandInterface Hook into the command execution and do anything before it's executed
resetNodeCounters ( ) Reset node counters that should be reset upon node switch
updateNodeStats ( array $jobs ) Update node counters indicating how many jobs the node has produced

Private Methods

Méthode Description
copyNodeStats ( Node $oldNode, Node $newNode ) Copy node stats from the old to the new node
createNode ( Disque\Connection\Credentials $credentials ) : Node Create a new Node object
getNodeIdFromJobId ( string $jobId ) : string | null Get a node ID based off a Job ID
getNodePrefixFromJobId ( string $jobId ) : string Get the node prefix from the job ID
revealClusterFromHello ( Node $node ) Reveal the whole Disque cluster from a node HELLO response
revealNodeFromHello ( string $nodeId, array $node ) : Node Reveal a single node from a HELLO response, or use an existing node
shouldBeConnected ( ) : void We should be connected
switchNodeIfNeeded ( ) Decide if we should switch to a better node
switchToNode ( Node $node ) Switch to the given node and map the cluster from its HELLO
wasAlreadyConnected ( ) : boolean Check if the manager held a connection to Disque already

Method Details

__construct() public méthode

public __construct ( )

addServer() public méthode

public addServer ( Disque\Connection\Credentials $credentials )
$credentials Disque\Connection\Credentials

connect() public méthode

public connect ( )

execute() public méthode

public execute ( Disque\Command\CommandInterface $command )
$command Disque\Command\CommandInterface

findAvailableConnection() protected méthode

Disque suggests the first connection should be chosen randomly We go through the user-supplied credentials randomly and try to connect.
protected findAvailableConnection ( ) : Node
Résultat Disque\Connection\Node\Node A connected node

getConnectionFactory() public méthode

public getConnectionFactory ( )

getCredentials() public méthode

public getCredentials ( )

getCurrentNode() public méthode

public getCurrentNode ( )

getNodeConnection() protected méthode

Connect to the node given in the credentials
protected getNodeConnection ( Disque\Connection\Credentials $server ) : Node
$server Disque\Connection\Credentials
Résultat Disque\Connection\Node\Node A connected node

getPriorityStrategy() public méthode

public getPriorityStrategy ( )

isConnected() public méthode

public isConnected ( )

postprocessExecution() protected méthode

Postprocess the command execution, eg. update node stats
protected postprocessExecution ( Disque\Command\CommandInterface $command, mixed $response ) : mixed
$command Disque\Command\CommandInterface
$response mixed
Résultat mixed

preprocessExecution() protected méthode

Eg. start measuring node latency etc.
protected preprocessExecution ( Disque\Command\CommandInterface $command ) : Disque\Command\CommandInterface
$command Disque\Command\CommandInterface
Résultat Disque\Command\CommandInterface $command

resetNodeCounters() protected méthode

Reset node counters that should be reset upon node switch
protected resetNodeCounters ( )

setConnectionFactory() public méthode

public setConnectionFactory ( Disque\Connection\Factory\ConnectionFactoryInterface $connectionFactory )
$connectionFactory Disque\Connection\Factory\ConnectionFactoryInterface

setPriorityStrategy() public méthode

public setPriorityStrategy ( Disque\Connection\Node\NodePrioritizerInterface $priorityStrategy )
$priorityStrategy Disque\Connection\Node\NodePrioritizerInterface

updateNodeStats() protected méthode

Update node counters indicating how many jobs the node has produced
protected updateNodeStats ( array $jobs )
$jobs array Jobs

Property Details

$credentials protected_oe property

After connecting to one, the server returns a list of other nodes in the cluster so we can connect to them automatically, unless the discovered nodes are secured with a password. 'serverAddress' => Credentials
protected Credentials[],Disque\Connection $credentials
Résultat Disque\Connection\Credentials[]

$nodeId protected_oe property

The ID of the node we are currently connected to
protected string $nodeId
Résultat string

$nodePrefixes protected_oe property

Node prefix consists of the first 8 bytes from the node ID. Because job IDs contain the node prefix, it can be used to identify on which node a job lives. 'nodePrefix' => 'nodeId'
protected array $nodePrefixes
Résultat array

$nodes protected_oe property

'nodeId' => Node
protected Node[],Disque\Connection\Node $nodes
Résultat Disque\Connection\Node\Node[]

$priorityStrategy protected_oe property

The default strategy is the ConservativeJobCountPrioritizer. It prioritizes nodes by their job count, but prefers the current node in order to avoid switching until there is a clearly better node.
protected NodePrioritizerInterface,Disque\Connection\Node $priorityStrategy
Résultat Disque\Connection\Node\NodePrioritizerInterface