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.
Class for using Stomp to talk to an Stomp compliant server

\Zend_Queue_Adapter_Stomp_client
$_client= 'null'
null
Details
__construct(
$options, \Zend_Queue $queue
=
null
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$options | ||
$queue | \Zend_Queue | The Zend_Queue object that created this class |

_subscribe(
\Zend_Queue $queue
)
:
void
Subscribes the client to the queue.
Name | Type | Description |
---|---|---|
$queue | \Zend_Queue |

count(
\Zend_Queue $queue
=
null
)
:
integer
Returns the length of the queue
Name | Type | Description |
---|---|---|
$queue | \Zend_Queue |
Type | Description |
---|---|
integer |
Exception | Description |
---|---|
\Zend_Queue_Exception | (not supported) |

create(
string $name, integer $timeout
=
null
)
:
void
Create a new queue
Name | Type | Description |
---|---|---|
$name | string | queue name |
$timeout | integer | default visibility timeout |
Exception | Description |
---|---|
\Zend_Queue_Exception |

delete(
string $name
)
:
void
Delete a queue and all of its messages
Name | Type | Description |
---|---|---|
$name | string | queue name |
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.
Name | Type | Description |
---|---|---|
$message | \Zend_Queue_Message |
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.
Type | Description |
---|---|
array |

getQueues(
)
:
void
Get an array of all available queues
Exception | Description |
---|---|
\Zend_Queue_Exception |

isExists(
string $name
)
:
boolean
Does a queue already exist?
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
boolean |
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
Name | Type | Description |
---|---|---|
$maxMessages | integer | |
$timeout | integer | |
$queue | \Zend_Queue |
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
Name | Type | Description |
---|---|---|
$message | string | message to send to the queue |
$queue | \Zend_Queue |
Type | Description |
---|---|
\Zend_Queue_Message |