1. class
  2. Comodojo
  3. \
  4. Extender
  5. \
  6. Task
  7. \
  8. Request

Request

class Request (View source)

Traits

TasksRequestTrait

Properties

protected string $name from TasksRequestTrait
protected string $task from TasksRequestTrait
protected int $niceness from TasksRequestTrait
protected int $maxtime from TasksRequestTrait
protected int $uid
protected int $parent_uid
protected int $jid
protected int $start_timestamp
protected int $pid
protected Request $done
protected Request $fail
protected Request $pipe
protected TaskParameters $parameters

Methods

string
getName()

Get request name

from TasksRequestTrait
setName($name)

No description

from TasksRequestTrait
string
getTask()

Get request associated task

from TasksRequestTrait
setTask($task)

No description

from TasksRequestTrait
int
getNiceness()

Get requested niceness (-20/20)

from TasksRequestTrait
setNiceness($niceness)

No description

from TasksRequestTrait
int
getMaxtime()

Get max allowed execution time

from TasksRequestTrait
setMaxtime($maxtime)

No description

from TasksRequestTrait
__construct(string $name, string $task, TaskParameters $parameters = null)

Class constructor

int
getUid()

Get current unique id

setUid($uid)

No description

int
getParentUid()

Get parent unique id

setParentUid($uid)

No description

int
getJid()

Get current job id

setJid($jid)

No description

TaskParameters
getParameters()

Get parameters

setParameters(TaskParameters $parameters = null)

No description

float
getStartTimestamp()

Get start timestamp (microseconds)

setStartTimestamp($time)

No description

int
getPid()

Get pid

setPid($pid)

No description

hasOnDone()

No description

getOnDone()

No description

onDone(Request $request = null)

No description

hasOnFail()

No description

getOnFail()

No description

onFail(Request $request = null)

No description

hasPipe()

No description

getPipe()

No description

pipe(Request $request = null)

No description

isChain()

No description

convertToMessage()

No description

static 
create($name, $task, TaskParameters $parameters = null)

No description

static 
createFromMessage(Request $message)

No description

Details

in TasksRequestTrait at line 48
string getName()

Get request name

Return Value

string

in TasksRequestTrait at line 54
setName($name)

Parameters

$name

in TasksRequestTrait at line 67
string getTask()

Get request associated task

Return Value

string

in TasksRequestTrait at line 73
setTask($task)

Parameters

$task

in TasksRequestTrait at line 86
int getNiceness()

Get requested niceness (-20/20)

Return Value

int

in TasksRequestTrait at line 92
setNiceness($niceness)

Parameters

$niceness

in TasksRequestTrait at line 105
int getMaxtime()

Get max allowed execution time

Return Value

int

in TasksRequestTrait at line 111
setMaxtime($maxtime)

Parameters

$maxtime

at line 78
__construct(string $name, string $task, TaskParameters $parameters = null)

Class constructor

Parameters

string $name
string $task
TaskParameters $parameters

at line 93
int getUid()

Get current unique id

Return Value

int

at line 99
setUid($uid)

Parameters

$uid

at line 112
int getParentUid()

Get parent unique id

Return Value

int

at line 118
setParentUid($uid)

Parameters

$uid

at line 131
int getJid()

Get current job id

Return Value

int

at line 137
setJid($jid)

Parameters

$jid

at line 150
TaskParameters getParameters()

Get parameters

Return Value

TaskParameters

at line 156
setParameters(TaskParameters $parameters = null)

Parameters

TaskParameters $parameters

at line 169
float getStartTimestamp()

Get start timestamp (microseconds)

Return Value

float

at line 175
setStartTimestamp($time)

Parameters

$time

at line 188
int getPid()

Get pid

Return Value

int

at line 194
setPid($pid)

Parameters

$pid

at line 202
hasOnDone()

at line 208
getOnDone()

at line 214
onDone(Request $request = null)

Parameters

Request $request

at line 222
hasOnFail()

at line 228
getOnFail()

at line 234
onFail(Request $request = null)

Parameters

Request $request

at line 242
hasPipe()

at line 248
getPipe()

at line 254
pipe(Request $request = null)

Parameters

Request $request

at line 262
isChain()

at line 268
convertToMessage()

at line 286
static create($name, $task, TaskParameters $parameters = null)

Parameters

$name
$task
TaskParameters $parameters

at line 292
static createFromMessage(Request $message)

Parameters

Request $message