Queue/Adapter/PlatformJobQueue.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework
LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Queue  
Subpackage
Adapter  
Version
$Id$  

\Zend_Queue_Adapter_PlatformJobQueue

Package: Zend_Queue\Adapter
Zend Platform JobQueue adapter
Parent(s)
\Zend_Queue_Adapter_AdapterAbstract
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected\ZendApi_JobQueue $_zendQueue

Methods

methodpublic__construct(array | \Zend_Config $options, \Zend_Queue | null $queue = null) : void

Constructor

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
$queue\Zend_Queue | null
methodpublic__sleep() : array

Serialize

Returns
TypeDescription
array
methodpublic__wakeup() : void

Unserialize

methodpubliccount(\Zend_Queue | null $queue = null) : integer

Return the approximate number of messages in the queue

Parameters
NameTypeDescription
$queue\Zend_Queue | null
Returns
TypeDescription
integer
methodpubliccreate(string $name, integer $timeout = null) : void

Create a new queue

Parameters
NameTypeDescription
$namestring

queue name

$timeoutinteger

default visibility timeout

Throws
ExceptionDescription
\Zend_Queue_Exception
methodpublicdelete(string $name) : void

Delete a queue and all of its messages

Parameters
NameTypeDescription
$namestring

queue name

Throws
ExceptionDescription
\Zend_Queue_Exception
methodpublicdeleteMessage(\Zend_Queue_Message $message) : boolean

Delete a message from the queue

Returns true if the message is deleted, false if the deletion is unsuccessful.
Parameters
NameTypeDescription
$message\Zend_Queue_Message
Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Queue_Exception
methodpublicgetCapabilities() : array

Return a list of queue capabilities functions

$array['function name'] = true or false true is supported, false is not supported.
Returns
TypeDescription
array
methodpublicgetQueues() : void

Get an array of all available queues

Throws
ExceptionDescription
\Zend_Queue_Exception
methodpublicisExists(string $name) : boolean

Does a queue already exist?

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Queue_Exception(not supported)
methodpublicisJobIdExist( $id) : void

Parameters
NameTypeDescription
$id
methodpublicreceive(integer $maxMessages = null, integer $timeout = null, \Zend_Queue $queue = null) : \ArrayIterator

Get messages in the queue

Parameters
NameTypeDescription
$maxMessagesinteger

Maximum number of messages to return

$timeoutinteger

Ignored

$queue\Zend_Queue

Not supported

Returns
TypeDescription
\ArrayIterator
Throws
ExceptionDescription
\Zend_Queue_Exception
methodpublicsend( $message, \Zend_Queue $queue = null) : \Zend_Queue_Message

Send a message to the queue

Parameters
NameTypeDescription
$message
$queue\Zend_Queue

Not supported

Returns
TypeDescription
\Zend_Queue_Message
Throws
ExceptionDescription
\Zend_Queue_Exception
Documentation was generated by phpDocumentor 2.2.0 .