Zend_Queue_Stomp_Client_ConnectionInterface Interface Reference

Public Member Functions
	open ($scheme, $host, $port)
	close ($destructor=false)
	ping ()
	Check whether we are connected to the server.
	write (Zend_Queue_Stomp_FrameInterface $frame)
	write a frame to the stomp server
	canRead ()
	tests the socket to see if there is data for us
	read ()
	reads in a frame from the socket or returns false.
	setFrameClass ($class)
	Set the frame class to be used.
	getFrameClass ()
	Get the frameClass.
	createFrame ()
	create an empty frame

Member Function Documentation

canRead

(

)

tests the socket to see if there is data for us

Implemented in Zend_Queue_Stomp_Client_Connection.

close

(

$destructor = false

)

Parameters

boolean

$destructor

Returns

void

Implemented in Zend_Queue_Stomp_Client_Connection.

createFrame

(

)

create an empty frame

Returns

Zend_Queue_Stomp_FrameInterface class

Implemented in Zend_Queue_Stomp_Client_Connection.

getFrameClass

(

)

Get the frameClass.

Returns

string

Implemented in Zend_Queue_Stomp_Client_Connection.

open	(		$scheme,
			$host,
			$port
	)

Parameters

string	$scheme	['tcp', 'udp']
	string	host
	integer	port
	string	class - create a connection with this class; class must support Zend_Queue_Stomp_Client_Connection_Interface

Returns

boolean

ping

(

)

Check whether we are connected to the server.

Returns

true

Exceptions

Zend_Queue_Exception

Implemented in Zend_Queue_Stomp_Client_Connection.

read

(

)

reads in a frame from the socket or returns false.

Returns

Zend_Queue_Stomp_Frame|false

Exceptions

Zend_Queue_Exception

Implemented in Zend_Queue_Stomp_Client_Connection.

setFrameClass

(

$class

)

Set the frame class to be used.

This must be a Zend_Queue_Stomp_FrameInterface.

Parameters

string

$class

Returns

Zend_Queue_Stomp_Client_ConnectionInterface;

Implemented in Zend_Queue_Stomp_Client_Connection.

write

(

Zend_Queue_Stomp_FrameInterface

$frame

)

write a frame to the stomp server

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

Parameters

Zend_Queue_Stomp_FrameInterface

$frame

Returns

$this

Implemented in Zend_Queue_Stomp_Client_Connection.