API Documentation

Queue/Stomp/Client.php

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
Stomp
version
$Id: Client.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Queue_Stomp_Client

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_Stomp_Client
jump to top

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
Stomp
Properties
$_connection
Methods
__construct
__destruct
addConnection
setConnection
getConnection
send
receive
canRead
createFrame

Description

The Stomp client interacts with a Stomp server.

Properties

$_connection
jump to class

array $_connection = ''

Array of $client Zend_Queue_Stomp_Client_Interface

Details

$_connection
array
visibility
protected
default
final
false
static
false

Methods

__construct
jump to class

__construct( string $scheme = null, string $host = null, integer $port = null,  $connectionClass = Zend_Queue_Stomp_Client_Connection,  $frameClass = Zend_Queue_Stomp_Frame ) :

Add a server to connections

Arguments
$scheme
string
scheme
$host
string
host
$port
integer
port
$connectionClass
$frameClass
Details
visibility
public
final
false
static
false

__destruct
jump to class

__destruct( ) : void

Shutdown

Details
visibility
public
final
false
static
false

addConnection
jump to class

addConnection( string $scheme, string $host, integer $port, string $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.

Arguments
$scheme
string
['tcp', 'udp']
$host
string
host
$port
integer
port
$class
string
class - create a connection with this class; class must support Zend_Queue_Stomp_Client_ConnectionInterface
Output
boolean
Details
visibility
public
final
false
static
false

canRead
jump to class

canRead( ) : boolean

canRead()

Output
boolean
Details
visibility
public
final
false
static
false

createFrame
jump to class

createFrame( ) : Zend_Queue_Stomp_FrameInterface

creates a frame class

Output
Zend_Queue_Stomp_FrameInterface
Details
visibility
public
final
false
static
false

getConnection
jump to class

getConnection( ) : Zend_Queue_Stomp_Client_ConnectionInterface|null

Get client connection

Output
Zend_Queue_Stomp_Client_ConnectionInterface|null
Details
visibility
public
final
false
static
false

receive
jump to class

receive( ) : Zend_Queue_Stomp_FrameInterface|boolean

Receive a frame

Returns a frame or false if none were to be read.

Output
Zend_Queue_Stomp_FrameInterface|boolean
Details
visibility
public
final
false
static
false

send
jump to class

send( Zend_Queue_Stomp_FrameInterface $frame ) : boolean

Send a stomp frame

Returns true if the frame was successfully sent.

Arguments
$frame
Zend_Queue_Stomp_FrameInterface
Output
boolean
Details
visibility
public
final
false
static
false

setConnection
jump to class

setConnection( Zend_Queue_Stomp_Client_ConnectionInterface $connection ) : void

Set client connection

Arguments
$connection
Zend_Queue_Stomp_Client_ConnectionInterface
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.