1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
<?php
/**
* PHP OpenCloud library.
*
* @copyright 2014 Rackspace Hosting, Inc. See LICENSE for information.
* @license https://www.apache.org/licenses/LICENSE-2.0
* @author Jamie Hannaford <jamie.hannaford@rackspace.com>
*/
namespace OpenCloud\Queues\Resource;
use OpenCloud\Common\PersistentObject;
/**
* A worker claims or checks out a message to perform a task. Doing so prevents
* other workers from attempting to process the same messages.
*/
class Claim extends PersistentObject
{
const LIMIT_DEFAULT = 10;
const GRACE_DEFAULT = 43200;
const TTL_DEFAULT = 43200;
/**
* @var string
*/
private $id;
/**
* @var int
*/
private $age;
/**
* @var array An array of messages.
*/
private $messages;
/**
* How long the server should wait before releasing the claim in seconds.
* The ttl value must be between 60 and 43200 seconds (12 hours is the
* default but is configurable).
*
* @var int
*/
private $ttl;
/**
* The message grace period in seconds. The value of grace must be between
* 60 and 43200 seconds (12 hours the default, but configurable). The server
* extends the lifetime of claimed messages to be at least as long as the
* lifetime of the claim itself, plus a specified grace period to deal with
* crashed workers (up to 1209600 or 14 days including claim lifetime). If a
* claimed message would normally live longer than the grace period, it's
* expiration will not be adjusted.
*
* @var int
*/
private $grace;
/**
* Link.
*
* @var string
*/
private $href;
protected static $url_resource = 'claims';
protected static $json_name = '';
/**
* Set the Href attribute and extrapolate the ID.
*
* @param $href
* @return $this
*/
public function setHref($href)
{
$paths = explode('/', $href);
$this->id = end($paths);
$this->href = $href;
return $this;
}
/**
* @return string
*/
public function getHref()
{
return $this->href;
}
/**
* @return string
*/
public function getId()
{
return $this->id;
}
public function create($params = array())
{
return $this->noCreate();
}
/**
* Updates the current Claim. It is recommended that you periodically renew
* claims during long-running batches of work to avoid loosing a claim in
* the middle of processing a message. This is done by setting a new TTL for
* the claim (which may be different from the original TTL). The server will
* then reset the age of the claim and apply the new TTL.
* {@inheritDoc}
*/
public function update($params = array())
{
$object = (object) array(
'grace' => $this->getGrace(),
'ttl' => $this->getTtl()
);
$json = json_encode($object);
$this->checkJsonError();
return $this->getClient()->patch($this->url(), self::getJsonHeader(), $json)->send();
}
}
|
