The Stomp client interacts with a Stomp server.

category Zend
package Zend_Queue
subpackage Stomp
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Add a server to connections

__construct($scheme = null, $host = null, $port = null, $connectionClass = 'Zend_Queue_Stomp_Client_Connection', $frameClass = 'Zend_Queue_Stomp_Frame'

Parameters

$scheme

$host

$port

$connectionClass

$frameClass

Shutdown

__destruct() : void

Add a connection to this client.

addConnection(string $scheme, $host, $port, $class = 'Zend_Queue_Stomp_Client_Connection') : boolean

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

$scheme

string

['tcp', 'udp']

$host

$port

$class

Returns

boolean

canRead()

canRead() : boolean

Returns

boolean

creates a frame class

createFrame() : \Zend_Queue_Stomp_FrameInterface

Returns

\Zend_Queue_Stomp_FrameInterface

Get client connection

getConnection() : \Zend_Queue_Stomp_Client_ConnectionInterface | null

Returns

\Zend_Queue_Stomp_Client_ConnectionInterfacenull

Receive a frame

receive() : \Zend_Queue_Stomp_FrameInterface | boolean

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

Returns

\Zend_Queue_Stomp_FrameInterfaceboolean

Send a stomp frame

send(\Zend_Queue_Stomp_FrameInterface $frame) : boolean

Returns true if the frame was successfully sent.

Parameters

$frame

\Zend_Queue_Stomp_FrameInterface

Returns

boolean

Set client connection

setConnection(\Zend_Queue_Stomp_Client_ConnectionInterface $connection) : void

Parameters

$connection

\Zend_Queue_Stomp_Client_ConnectionInterface

 Properties

 

Array of $client Zend_Queue_Stomp_Client_Interface

$_connection : array

Default