API Documentation

Zend/Queue/Adapter/PlatformJobQueue.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Queue  
Subpackage
Adapter  
Version
$Id: PlatformJobQueue.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Queue_Adapter_PlatformJobQueue

Package: Zend\Queue\Adapter

Zend Platform JobQueue adapter

Parent(s)
\Zend_Queue_Adapter_AdapterAbstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\ZendApi_JobQueue  $_zendQueue= ''

Details
Type
\ZendApi_JobQueue

Methods

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

Constructor

Parameters
Name Type Description
$options array|\Zend_Config
$queue \Zend_Queue|null
methodpublic__sleep( ) : array

Serialize

Returns
Type Description
array
methodpublic__wakeup( ) : void

Unserialize

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

Return the approximate number of messages in the queue

Parameters
Name Type Description
$queue \Zend_Queue|null
Returns
Type Description
integer
methodpubliccreate( string $name, integer $timeout = null ) : void

Create a new queue

Parameters
Name Type Description
$name string

queue name

$timeout integer

default visibility timeout

Throws
Exception Description
\Zend_Queue_Exception
methodpublicdelete( string $name ) : void

Delete a queue and all of its messages

Parameters
Name Type Description
$name string

queue name

Throws
Exception Description
\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
Name Type Description
$message \Zend_Queue_Message
Returns
Type Description
boolean
Throws
Exception Description
\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
Type Description
array
methodpublicgetQueues( ) : void

Get an array of all available queues

Throws
Exception Description
\Zend_Queue_Exception
methodpublicisExists( string $name ) : boolean

Does a queue already exist?

Parameters
Name Type Description
$name string
Returns
Type Description
boolean
Throws
Exception Description
\Zend_Queue_Exception (not supported)
methodpublicisJobIdExist(  $id ) : void

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

Get messages in the queue

Parameters
Name Type Description
$maxMessages integer

Maximum number of messages to return

$timeout integer

Ignored

$queue \Zend_Queue

Not supported

Returns
Type Description
\ArrayIterator
Throws
Exception Description
\Zend_Queue_Exception
methodpublicsend( array $message, \Zend_Queue $queue = null ) : \Zend_Queue_Message

Send a message to the queue

Parameters
Name Type Description
$message array

| ZendAPI_job $message Message to send to the active queue

$queue \Zend_Queue

Not supported

Returns
Type Description
\Zend_Queue_Message
Throws
Exception Description
\Zend_Queue_Exception
Documentation was generated by DocBlox 0.15.1.