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

tests the socket to see if there is data for us

canRead() 

close()

close(boolean $destructor = false) : void

Parameters

$destructor

boolean

create an empty frame

createFrame() : \Zend_Queue_Stomp_FrameInterface

Returns

\Zend_Queue_Stomp_FrameInterfaceclass

Get the frameClass

getFrameClass() : string

Returns

string

open()

open(string $scheme, $host, $port) : boolean

Parameters

$scheme

string

['tcp', 'udp']

$host

$port

Returns

boolean

Check whether we are connected to the server

ping() : true

Exceptions

\Zend_Queue_Exception

Returns

true

reads in a frame from the socket or returns false.

read() : \Zend_Queue_Stomp_Frame | false

Exceptions

\Zend_Queue_Exception

Returns

\Zend_Queue_Stomp_Framefalse

Set the frame class to be used

setFrameClass(string $class) : \Zend_Queue_Stomp_Client_ConnectionInterface;

This must be a Zend_Queue_Stomp_FrameInterface.

Parameters

$class

string

Returns

\Zend_Queue_Stomp_Client_ConnectionInterface;

write a frame to the stomp server

write(\Zend_Queue_Stomp_FrameInterface $frame) : \Zend_Queue_Stomp_Client_ConnectionInterface

example: $response = $client->write($frame)->read();

fluent This method is part of a fluent interface and will return the same instance

Parameters

$frame

\Zend_Queue_Stomp_FrameInterface

Returns

\Zend_Queue_Stomp_Client_ConnectionInterface