Class Queue
A queue holds messages. Ideally, a queue is created per work type. For example, if you want to compress files, you would create a queue dedicated to this job. Any application that reads from this queue would only compress files.
- OpenCloud\Common\Base
-
OpenCloud\Common\Resource\BaseResource
-
OpenCloud\Common\Resource\PersistentResource
-
OpenCloud\Queues\Resource\Queue
Methods summary
public
|
|
public
string
|
|
public
mixed
|
|
public
|
|
public
Guzzle\Http\Message\Response
|
|
public
object
|
|
public
string
|
|
public
Guzzle\Http\Message\Response
|
|
public
object
|
|
public
|
#
getMessage( string|null $id = null )
Gets a message either by a specific ID, or, if no ID is specified, just an empty Message object. |
public
boolean
|
|
public
boolean
|
|
public
|
#
listMessages( array $options = array() )
Lists messages according to certain filter options. Results are ordered by age, oldest message first. All of the parameters are optional. |
public
boolean
|
#
deleteMessages( array $ids )
This operation immediately deletes the specified messages, providing a means for bulk deletes. |
public
|
#
claimMessages( array $options = array() )
This operation claims a set of messages, up to limit, from oldest to newest, skipping any that are already claimed. If no unclaimed messages are available, FALSE is returned. |
public
|
Methods inherited from OpenCloud\Common\Resource\PersistentResource
checkExtension()
,
createUrl()
,
delete()
,
id()
,
name()
,
refresh()
,
refreshFromLocationUrl()
,
region()
,
status()
,
waitFor()
Methods inherited from OpenCloud\Common\Resource\BaseResource
__construct()
,
findLink()
,
getClient()
,
getMetadata()
,
getParent()
,
getService()
,
getUrl()
,
jsonCollectionElement()
,
jsonCollectionName()
,
jsonName()
,
parseResponse()
,
resourceName()
,
setMetadata()
,
setParent()
,
setService()
,
url()
Methods inherited from OpenCloud\Common\Base
__call()
,
checkJsonError()
,
generateUuid()
,
getInstance()
,
getLogger()
,
hasLogger()
,
makeResourceIteratorOptions()
,
populate()
,
setLogger()
,
stripNamespace()
,
toCamel()
,
toUnderscores()
Constants summary
integer |
MAX_POST_MESSAGES
Maximum number of messages that can be posted at once. |
#
10
|
Constants inherited from OpenCloud\Common\Base
Properties summary
public
array
|
$createKeys
|
#
array('name')
|