Queue/Stomp/Client.php

Show: PublicProtectedPrivateinherited
Table of Contents
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 [email protected] 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
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

>VPropertyprotectedarray $_connection
Array of $client Zend_Queue_Stomp_Client_Interface
Details
Type
array

Methods

methodpublic__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
NameTypeDescription
$scheme
$host
$port
$connectionClass
$frameClass
methodpublic__destruct() : void

Shutdown

methodpublicaddConnection(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.
Parameters
NameTypeDescription
$schemestring

['tcp', 'udp']

$host
$port
$class
Returns
TypeDescription
boolean
methodpubliccanRead() : boolean

canRead()

Returns
TypeDescription
boolean
methodpubliccreateFrame() : \Zend_Queue_Stomp_FrameInterface

creates a frame class

Returns
TypeDescription
\Zend_Queue_Stomp_FrameInterface
methodpublicgetConnection() : \Zend_Queue_Stomp_Client_ConnectionInterface | null

Get client connection

methodpublicreceive() : \Zend_Queue_Stomp_FrameInterface | boolean

Receive a frame

Returns a frame or false if none were to be read.
Returns
TypeDescription
\Zend_Queue_Stomp_FrameInterface | boolean
methodpublicsend(\Zend_Queue_Stomp_FrameInterface $frame) : boolean

Send a stomp frame

Returns true if the frame was successfully sent.
Parameters
NameTypeDescription
$frame\Zend_Queue_Stomp_FrameInterface
Returns
TypeDescription
boolean
methodpublicsetConnection(\Zend_Queue_Stomp_Client_ConnectionInterface $connection) : void

Set client connection

Parameters
NameTypeDescription
$connection\Zend_Queue_Stomp_Client_ConnectionInterface
Documentation was generated by phpDocumentor 2.2.0 .