Documentation

Command

A command to be sent to the beanstalkd server, and response processing logic.

Tags
author

Paul Annesley

license

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

Table of Contents

COMMAND_BURY  = 'bury'
COMMAND_DELETE  = 'delete'
COMMAND_IGNORE  = 'ignore'
COMMAND_KICK  = 'kick'
COMMAND_LIST_TUBE_USED  = 'list-tube-used'
COMMAND_LIST_TUBES  = 'list-tubes'
COMMAND_LIST_TUBES_WATCHED  = 'list-tubes-watched'
COMMAND_PEEK  = 'peek'
COMMAND_PUT  = 'put'
COMMAND_RELEASE  = 'release'
COMMAND_RESERVE  = 'reserve'
COMMAND_STATS  = 'stats'
COMMAND_STATS_JOB  = 'stats-job'
COMMAND_USE  = 'use'
COMMAND_WATCH  = 'watch'
getCommandLine()  : string
The command line, without trailing CRLF.
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.

Constants

COMMAND_BURY

public mixed COMMAND_BURY = 'bury'

COMMAND_DELETE

public mixed COMMAND_DELETE = 'delete'

COMMAND_IGNORE

public mixed COMMAND_IGNORE = 'ignore'

COMMAND_KICK

public mixed COMMAND_KICK = 'kick'

COMMAND_LIST_TUBE_USED

public mixed COMMAND_LIST_TUBE_USED = 'list-tube-used'

COMMAND_LIST_TUBES

public mixed COMMAND_LIST_TUBES = 'list-tubes'

COMMAND_LIST_TUBES_WATCHED

public mixed COMMAND_LIST_TUBES_WATCHED = 'list-tubes-watched'

COMMAND_PEEK

public mixed COMMAND_PEEK = 'peek'

COMMAND_PUT

public mixed COMMAND_PUT = 'put'

COMMAND_RELEASE

public mixed COMMAND_RELEASE = 'release'

COMMAND_RESERVE

public mixed COMMAND_RESERVE = 'reserve'

COMMAND_STATS

public mixed COMMAND_STATS = 'stats'

COMMAND_STATS_JOB

public mixed COMMAND_STATS_JOB = 'stats-job'

COMMAND_USE

public mixed COMMAND_USE = 'use'

COMMAND_WATCH

public mixed COMMAND_WATCH = 'watch'

Methods

getCommandLine()

The command line, without trailing CRLF.

public getCommandLine() : string
Return values
string

getData()

The binary data to follow the command.

public getData() : string
Tags
throws
CommandException

If command has no data

Return values
string

getDataLength()

The length of the binary data in bytes.

public getDataLength() : int
Tags
throws
CommandException

If command has no data

Return values
int

hasData()

Whether the command is followed by data.

public hasData() : bool
Return values
bool

Search results