API Documentation

Zend/Queue/Adapter/Activemq.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: Activemq.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Queue_Adapter_Activemq

Package: Zend\Queue\Adapter

Class for using Stomp to talk to an Stomp compliant server

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  

Constants

Constant  DEFAULT_SCHEME = 'tcp'
Constant  DEFAULT_HOST = '127.0.0.1'
Constant  DEFAULT_PORT = 61613

Properties

Propertyprivate\Zend_Queue_Adapter_Stomp_client  $_client= 'null'

Default valuenullDetails
Type
\Zend_Queue_Adapter_Stomp_client
Propertyprivatearray  $_subscribed= 'array()'

Default valuearray()Details
Type
array

Methods

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

Constructor

Parameters
Name Type Description
$options
$queue \Zend_Queue

The Zend_Queue object that created this class

methodpublic__destruct( ) : void

Close the socket explicitly when destructed

methodprotected_isSubscribed( \Zend_Queue $queue ) : boolean

Checks if the client is subscribed to the queue

Parameters
Name Type Description
$queue \Zend_Queue
Returns
Type Description
boolean
methodprotected_subscribe( \Zend_Queue $queue ) : void

Subscribes the client to the queue.

Parameters
Name Type Description
$queue \Zend_Queue
methodpubliccount( \Zend_Queue $queue = null ) : integer

Returns the length of the queue

Parameters
Name Type Description
$queue \Zend_Queue
Returns
Type Description
integer
Throws
Exception Description
\Zend_Queue_Exception (not supported)
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
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)
methodpublicreceive( integer $maxMessages = null, integer $timeout = null, \Zend_Queue $queue = null ) : \Zend_Queue_Message_Iterator

Return the first element in the queue

Parameters
Name Type Description
$maxMessages integer
$timeout integer
$queue \Zend_Queue
Returns
Type Description
\Zend_Queue_Message_Iterator
methodpublicsend( string $message, \Zend_Queue $queue = null ) : \Zend_Queue_Message

Push an element onto the end of the queue

Parameters
Name Type Description
$message string

message to send to the queue

$queue \Zend_Queue
Returns
Type Description
\Zend_Queue_Message
Documentation was generated by DocBlox 0.15.1.