Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Queue_Stomp_Client Class Reference

Public Member Functions

 __construct ($scheme=null, $host=null, $port=null, $connectionClass= 'Zend_Queue_Stomp_Client_Connection', $frameClass= 'Zend_Queue_Stomp_Frame')
 Add a server to connections.
 
 __destruct ()
 Shutdown.
 
 addConnection ($scheme, $host, $port, $class= 'Zend_Queue_Stomp_Client_Connection')
 Add a connection to this client.
 
 setConnection (Zend_Queue_Stomp_Client_ConnectionInterface $connection)
 Set client connection.
 
 getConnection ()
 Get client connection.
 
 send (Zend_Queue_Stomp_FrameInterface $frame)
 Send a stomp frame.
 
 receive ()
 Receive a frame.
 
 canRead ()
 canRead()
 
 createFrame ()
 creates a frame class
 

Protected Attributes

 $_connection
 

Constructor & Destructor Documentation

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

Add a server to connections.

Parameters
stringscheme
stringhost
integerport
__destruct ( )

Shutdown.

Returns
void

Member Function Documentation

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

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
string$scheme['tcp', 'udp']
stringhost
integerport
stringclass - create a connection with this class; class must support Zend_Queue_Stomp_Client_ConnectionInterface
Returns
boolean
canRead ( )

canRead()

Returns
boolean
createFrame ( )

creates a frame class

Returns
Zend_Queue_Stomp_FrameInterface
getConnection ( )

Get client connection.

Returns
Zend_Queue_Stomp_Client_ConnectionInterface|null
receive ( )

Receive a frame.

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

Returns
Zend_Queue_Stomp_FrameInterface|boolean

Send a stomp frame.

Returns true if the frame was successfully sent.

Parameters
Zend_Queue_Stomp_FrameInterface$frame
Returns
boolean
setConnection ( Zend_Queue_Stomp_Client_ConnectionInterface  $connection)

Set client connection.

Parameters
Zend_Queue_Stomp_Client_ConnectionInterface$connection
Returns
void

Member Data Documentation

$_connection
protected