Documentation

TouchCommand extends AbstractCommand
in package
implements ResponseParser

The 'touch' command.

The "touch" command allows a worker to request more time to work on a job. This is useful for jobs that potentially take a long time, but you still want the benefits of a TTR pulling a job away from an unresponsive worker. A worker may periodically tell the server that it's still alive and processing a job (e.g. it may do this on DEADLINE_SOON).

Tags
author

Paul Annesley

license

http://www.opensource.org/licenses/mit-license.php

Interfaces, Classes and Traits

ResponseParser
A parser for response data sent from the beanstalkd server.

Table of Contents

$_job  : mixed
__construct()  : mixed
__toString()  : string
The string representation of the object.
getCommandLine()  : mixed
getData()  : string
The binary data to follow the command.
getDataLength()  : int
The length of the binary data in bytes.
getResponseParser()  : ResponseParser
The response parser for the command.
hasData()  : bool
Whether the command is followed by data.
parseResponse()  : object
Parses raw response data into a Response object.
_createResponse()  : object
Creates a Response for the given data.

Properties

Methods

__construct()

public __construct(Job $job) : mixed
Parameters
$job : Job
Return values
mixed

__toString()

The string representation of the object.

public __toString() : string
Return values
string

getCommandLine()

public getCommandLine() : mixed
Return values
mixed

getData()

The binary data to follow the command.

public getData() : string
Return values
string

getDataLength()

The length of the binary data in bytes.

public getDataLength() : int
Return values
int

hasData()

Whether the command is followed by data.

public hasData() : bool
Return values
bool

parseResponse()

Parses raw response data into a Response object.

public parseResponse(mixed $responseLine, mixed $responseData) : object
Parameters
$responseLine : mixed

Without trailing CRLF

$responseData : mixed

(null if no data)

Return values
object

Response

_createResponse()

Creates a Response for the given data.

protected _createResponse(mixed $name[, mixed $data = array() ]) : object
Parameters
$name : mixed
$data : mixed = array()
Return values
object

Response

Search results