Queue/Stomp/Client.php
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
- Stomp
- Version
- $Id$
\Zend_Queue_Stomp_Client
Package: Zend_Queue\Stomp
Returns
Returns
The Stomp client interacts with a Stomp server.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct( $scheme = null, $host = null, $port = null, $connectionClass = 'Zend_Queue_Stomp_Client_Connection', $frameClass = 'Zend_Queue_Stomp_Frame') : void
Add a server to connections
Parameters
Name | Type | Description |
---|---|---|
$scheme | ||
$host | ||
$port | ||
$connectionClass | ||
$frameClass |
addConnection(string $scheme, $host, $port, $class = 'Zend_Queue_Stomp_Client_Connection') : boolean
Add a connection to this client.
Attempts to add this class to the client. Returns a boolean value
indicating success of operation.
You cannot add more than 1 connection to the client at this time.
ParametersName | Type | Description |
---|---|---|
$scheme | string | ['tcp', 'udp'] |
$host | ||
$port | ||
$class |
Type | Description |
---|---|
boolean |
createFrame() : \Zend_Queue_Stomp_FrameInterface
creates a frame class
Returns
Type | Description |
---|---|
\Zend_Queue_Stomp_FrameInterface |
getConnection() : \Zend_Queue_Stomp_Client_ConnectionInterface | null
Get client connection
Returns
Type | Description |
---|---|
\Zend_Queue_Stomp_Client_ConnectionInterface | null |
receive() : \Zend_Queue_Stomp_FrameInterface | boolean
Receive a frame
Returns a frame or false if none were to be read.
ReturnsType | Description |
---|---|
\Zend_Queue_Stomp_FrameInterface | boolean |
send(\Zend_Queue_Stomp_FrameInterface $frame) : boolean
Send a stomp frame
Returns true if the frame was successfully sent.
ParametersName | Type | Description |
---|---|---|
$frame | \Zend_Queue_Stomp_FrameInterface |
Type | Description |
---|---|
boolean |
setConnection(\Zend_Queue_Stomp_Client_ConnectionInterface $connection) : void
Set client connection
Parameters
Name | Type | Description |
---|---|---|
$connection | \Zend_Queue_Stomp_Client_ConnectionInterface |