Zend_Queue_Adapter_Activemq Class Reference

Public Member Functions
	__construct ($options, Zend_Queue $queue=null)
	Constructor.
	__destruct ()
	Close the socket explicitly when destructed.
	create ($name, $timeout=null)
	Create a new queue.
	delete ($name)
	Delete a queue and all of its messages.
	deleteMessage (Zend_Queue_Message $message)
	Delete a message from the queue.
	getQueues ()
	Get an array of all available queues.
	receive ($maxMessages=null, $timeout=null, Zend_Queue $queue=null)
	Return the first element in the queue.
	send ($message, Zend_Queue $queue=null)
	Push an element onto the end of the queue.
	count (Zend_Queue $queue=null)
	Returns the length of the queue.
	isExists ($name)
	Does a queue already exist?
	getCapabilities ()
	Return a list of queue capabilities functions.
Public Member Functions inherited from Zend_Queue_Adapter_AdapterAbstract
	__construct ($options, Zend_Queue $queue=null)
	Constructor.
	getQueue ()
	get the Zend_Queue class that is attached to this object
	setQueue (Zend_Queue $queue)
	set the Zend_Queue class for this object
	getOptions ()
	Returns the configuration options in this adapter.
	isSupported ($name)
	Indicates if a function is supported or not.

Public Attributes
const	DEFAULT_SCHEME = 'tcp'
const	DEFAULT_HOST = '127.0.0.1'
const	DEFAULT_PORT = 61613
Public Attributes inherited from Zend_Queue_Adapter_AdapterAbstract
const	CREATE_TIMEOUT_DEFAULT = 30
	Default timeout for createQueue() function.
const	RECEIVE_TIMEOUT_DEFAULT = 30
	Default timeout for recieve() function.

Protected Member Functions
	_isSubscribed (Zend_Queue $queue)
	Checks if the client is subscribed to the queue.
	_subscribe (Zend_Queue $queue)
	Subscribes the client to the queue.

Additional Inherited Members
Protected Attributes inherited from Zend_Queue_Adapter_AdapterAbstract
	$_options = array()
	$_queues = array()
	$_queue = null

Constructor & Destructor Documentation

__construct	(		$options,
		Zend_Queue	$queue = null
	)

Constructor.

Parameters

array | Zend_Config	$config	An array having configuration data
	Zend_Queue	The Zend_Queue object that created this class

Returns

void

Implements Zend_Queue_Adapter_AdapterInterface.

__destruct

(

)

Close the socket explicitly when destructed.

Returns

void

Member Function Documentation

_isSubscribed ( Zend_Queue  $queue )

protected

Checks if the client is subscribed to the queue.

Parameters

Zend_Queue

$queue

Returns

boolean

_subscribe ( Zend_Queue  $queue )

protected

Subscribes the client to the queue.

Parameters

Zend_Queue

$queue

Returns

void

count

(

Zend_Queue

$queue = null

)

Returns the length of the queue.

Parameters

Zend_Queue

$queue

Returns

integer

Exceptions

Zend_Queue_Exception

(not supported)

Implements Zend_Queue_Adapter_AdapterInterface.

create	(		$name,
			$timeout = null
	)

Create a new queue.

Parameters

string	$name	queue name
integer	$timeout	default visibility timeout

Returns

void

Exceptions

Zend_Queue_Exception

Implements Zend_Queue_Adapter_AdapterInterface.

delete

(

$name

)

Delete a queue and all of its messages.

Parameters

string

$name

queue name

Returns

void

Exceptions

Zend_Queue_Exception

Implements Zend_Queue_Adapter_AdapterInterface.

deleteMessage

(

Zend_Queue_Message

$message

)

Delete a message from the queue.

Returns true if the message is deleted, false if the deletion is unsuccessful.

Parameters

Zend_Queue_Message

$message

Returns

boolean

Implements Zend_Queue_Adapter_AdapterInterface.

getCapabilities

(

)

Return a list of queue capabilities functions.

$array['function name'] = true or false true is supported, false is not supported.

Parameters

string

$name

Returns

array

Implements Zend_Queue_Adapter_AdapterInterface.

getQueues

(

)

Get an array of all available queues.

Returns

void

Exceptions

Zend_Queue_Exception

Implements Zend_Queue_Adapter_AdapterInterface.

isExists

(

$name

)

Does a queue already exist?

Parameters

string

$name

Returns

boolean

Exceptions

Zend_Queue_Exception

(not supported)

Implements Zend_Queue_Adapter_AdapterInterface.

receive	(		$maxMessages = null,
			$timeout = null,
		Zend_Queue	$queue = null
	)

Return the first element in the queue.

Parameters

integer	$maxMessages
integer	$timeout
Zend_Queue	$queue

Returns

Zend_Queue_Message_Iterator

Implements Zend_Queue_Adapter_AdapterInterface.

send	(		$message,
		Zend_Queue	$queue = null
	)

Push an element onto the end of the queue.

Parameters

string	$message	message to send to the queue
Zend_Queue	$queue

Returns

Zend_Queue_Message

Implements Zend_Queue_Adapter_AdapterInterface.

Member Data Documentation

const DEFAULT_HOST = '127.0.0.1'

const DEFAULT_PORT = 61613

const DEFAULT_SCHEME = 'tcp'