Beanstalk\Command\Kick Class Ref

class Beanstalk\Command\Kick
Extends:Beanstalk\Command
Description:Kick command
Author:Joshua Dechant <jdechant@shapeup.com>

The kick command applies only to the currently used tube. It moves jobs into the ready queue. If there are any buried jobs, it will only kick buried jobs. Otherwise it will kick delayed jobs

Class Methods

Beanstalk\Command\Kick::__construct($bound)
Description:

Constructor

Parameters:
  • $bound (integer) – Upper bound on the number of jobs to kick. The server will kick no more than $bound jobs.
Beanstalk\Command\Kick::getCommand()
Description:Get the delete command to send to the beanstalkd server
Returns:string
Beanstalk\Command\Kick::parseResponse($response[, $data = null, $conn = null])
Description:

Parse the response for success or failure.

Parameters:
  • $response (string) – Response line, i.e, first line in response
  • $data (string) – Data recieved with reponse, if any, else null
  • $conn (BeanstalkConnection) – BeanstalkConnection use to send the command
Returns:

integer The number of jobs actually kicked

Throws:

BeanstalkException When any error occurs