Queue/Stomp/Client/ConnectionInterface.php
Show:
inherited
inheritedZend 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_ConnectionInterface
Package: Zend_Queue\Stomp
Returns
Returns
Details
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
Methods
canRead() : voidtests the socket to see if there is data for us
close(boolean $destructor = false) : voidParameters
| Name | Type | Description |
|---|---|---|
| $destructor | boolean |
createFrame() : \Zend_Queue_Stomp_FrameInterfacecreate an empty frame
Returns
| Type | Description |
|---|---|
| \Zend_Queue_Stomp_FrameInterface | class |
getFrameClass() : stringGet the frameClass
Returns
| Type | Description |
|---|---|
| string |
open(string $scheme, $host, $port) : booleanParameters
Returns
| Name | Type | Description |
|---|---|---|
| $scheme | string | ['tcp', 'udp'] |
| $host | ||
| $port |
| Type | Description |
|---|---|
| boolean |
ping() : trueCheck whether we are connected to the server
Returns
Throws
| Type | Description |
|---|---|
| true |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
read() : \Zend_Queue_Stomp_Frame | falsereads in a frame from the socket or returns false.
Returns
Throws
| Type | Description |
|---|---|
| \Zend_Queue_Stomp_Frame | false |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
setFrameClass(string $class) : \Zend_Queue_Stomp_Client_ConnectionInterface;Set the frame class to be used
This must be a Zend_Queue_Stomp_FrameInterface.
Parameters| Name | Type | Description |
|---|---|---|
| $class | string |
| Type | Description |
|---|---|
| \Zend_Queue_Stomp_Client_ConnectionInterface; |
write(\Zend_Queue_Stomp_FrameInterface $frame) : \Zend_Queue_Stomp_Client_ConnectionInterfacewrite a frame to the stomp server
example: $response = $client->write($frame)->read();
Parameters| Name | Type | Description |
|---|---|---|
| $frame | \Zend_Queue_Stomp_FrameInterface |
| Type | Description |
|---|---|
| \Zend_Queue_Stomp_Client_ConnectionInterface |
- Fluent
- This method is part of a fluent interface and will return the same instance