Queue/Adapter/Activemq.php

Show:

inherited

Classes
- \Zend_Queue_Adapter_Activemq

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_Activemq
jump to top

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                DEFAULT_SCHEME
                = 'tcp'

 
                DEFAULT_HOST
                = '127.0.0.1'

 
                DEFAULT_PORT
                = 61613

Properties

\Zend_Queue_Adapter_Stomp_client $_client = null

Default valuenullDetails

Type: \Zend_Queue_Adapter_Stomp_client

array $_subscribed = array()

Default valuearray()Details

Type: array

Methods

__construct( $options, $queue = null) : void

Constructor

Parameters

Name	Type	Description
$options
$queue

__destruct() : void

Close the socket explicitly when destructed

_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

_subscribe(\Zend_Queue $queue) : void

Subscribes the client to the queue.

Parameters

Name	Type	Description
$queue	\Zend_Queue

count(\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)

create(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

delete(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

deleteMessage(\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

getCapabilities() : 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

getQueues() : void

Get an array of all available queues

Throws

Exception	Description
\Zend_Queue_Exception

isExists(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)

receive(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

send(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

Queue/Adapter/Activemq.php

\Zend_Queue_Adapter_Activemqjump to top

Constants

Properties

Methods

\Zend_Queue_Adapter_Activemq
jump to top