API Documentation

Queue/Adapter/Activemq.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Queue
subpackage
Adapter
version
$Id: Activemq.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Queue_Adapter_Activemq

Description

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.

Zend_Queue_Adapter_Activemq
jump to top

Extends from
Zend_Queue_Adapter_AdapterAbstract
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Queue
subpackage
Adapter
Constants
DEFAULT_SCHEME
DEFAULT_HOST
DEFAULT_PORT
Properties
$_client
Methods
__construct
__destruct
create
delete
deleteMessage
getQueues
receive
send
count
isExists
getCapabilities

Description

Class for using Stomp to talk to an Stomp compliant server

Constants

DEFAULT_SCHEME
jump to class

 DEFAULT_SCHEME = 'tcp'

Details

value
tcp

DEFAULT_HOST
jump to class

 DEFAULT_HOST = '127.0.0.1'

Details

value
127.0.0.1

DEFAULT_PORT
jump to class

 DEFAULT_PORT = '61613'

Details

value
61613

Properties

$_client
jump to class

Zend_Queue_Adapter_Stomp_client $_client = 'null'

Details

$_client
Zend_Queue_Adapter_Stomp_client
visibility
private
default
null
final
false
static
false

Methods

__construct
jump to class

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

Constructor

Arguments
$options
$queue
Zend_Queue
The Zend_Queue object that created this class
Details
visibility
public
final
false
static
false

__destruct
jump to class

__destruct( ) : void

Close the socket explicitly when destructed

Details
visibility
public
final
false
static
false

count
jump to class

count( Zend_Queue $queue = null ) : integer

Returns the length of the queue

Arguments
$queue
Zend_Queue
Output
integer
Details
visibility
public
final
false
static
false
throws
(not supported)

create
jump to class

create( string $name, integer $timeout = null ) : void

Create a new queue

Arguments
$name
string
queue name
$timeout
integer
default visibility timeout
Details
visibility
public
final
false
static
false
throws

delete
jump to class

delete( string $name ) : void

Delete a queue and all of its messages

Arguments
$name
string
queue name
Details
visibility
public
final
false
static
false
throws

deleteMessage
jump to class

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.

Arguments
$message
Zend_Queue_Message
Output
boolean
Details
visibility
public
final
false
static
false

getCapabilities
jump to class

getCapabilities( ) : array

Return a list of queue capabilities functions

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

Output
array
Details
visibility
public
final
false
static
false

getQueues
jump to class

getQueues( ) : void

Get an array of all available queues

Details
visibility
public
final
false
static
false
throws

isExists
jump to class

isExists( string $name ) : boolean

Does a queue already exist?

Arguments
$name
string
Output
boolean
Details
visibility
public
final
false
static
false
throws
(not supported)

receive
jump to class

receive( integer $maxMessages = null, integer $timeout = null, Zend_Queue $queue = null ) : Zend_Queue_Message_Iterator

Return the first element in the queue

Arguments
$maxMessages
integer
$timeout
integer
$queue
Zend_Queue
Output
Zend_Queue_Message_Iterator
Details
visibility
public
final
false
static
false

send
jump to class

send( string $message, Zend_Queue $queue = null ) : Zend_Queue_Message

Push an element onto the end of the queue

Arguments
$message
string
message to send to the queue
$queue
Zend_Queue
Output
Zend_Queue_Message
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.