Zend Framework  1.12
Public Member Functions | List of all members
Zend_Queue_Stomp_FrameInterface Interface Reference

Public Member Functions

 getAutoContentLength ()
 Get the status of the auto content length.
 
 setAutoContentLength ($auto)
 setAutoContentLength()
 
 getHeaders ()
 Get the headers.
 
 setHeaders (array $headers)
 Set the headers.
 
 getHeader ($header)
 Returns a value for a header returns false if the header does not exist.
 
 setHeader ($header, $value)
 Returns a value for a header returns false if the header does not exist.
 
 getBody ()
 Return the body for this frame returns false if the body does not exist.
 
 setBody ($body)
 Set the body for this frame returns false if the body does not exist.
 
 getCommand ()
 Return the command for this frame return false if the command does not exist.
 
 setCommand ($command)
 Set the body for this frame returns false if the body does not exist.
 
 toFrame ()
 Takes the current parameters and returns a Stomp Frame.
 
 __toString ()
 
 fromFrame ($frame)
 Accepts a frame and deconstructs the frame into its' component parts.
 

Member Function Documentation

__toString ( )
See Also
toFrame()

Implemented in Zend_Queue_Stomp_Frame.

fromFrame (   $frame)

Accepts a frame and deconstructs the frame into its' component parts.

Parameters
string$frame- a stomp frame
Returns
$this

Implemented in Zend_Queue_Stomp_Frame.

getAutoContentLength ( )

Get the status of the auto content length.

If AutoContentLength is true this code will automatically put the content-length header in, even if it is already set by the user.

This is done to make the message sending more reliable.

Returns
boolean

Implemented in Zend_Queue_Stomp_Frame.

getBody ( )

Return the body for this frame returns false if the body does not exist.

Returns
$this

Implemented in Zend_Queue_Stomp_Frame.

getCommand ( )

Return the command for this frame return false if the command does not exist.

Returns
$this

Implemented in Zend_Queue_Stomp_Frame.

getHeader (   $header)

Returns a value for a header returns false if the header does not exist.

Parameters
string$header
Returns
$string
Exceptions
Zend_Queue_Exception

Implemented in Zend_Queue_Stomp_Frame.

getHeaders ( )

Get the headers.

Returns
array

Implemented in Zend_Queue_Stomp_Frame.

setAutoContentLength (   $auto)

setAutoContentLength()

Set the value on or off.

Parameters
boolean$auto
Returns
$this;
Exceptions
Zend_Queue_Exception

Implemented in Zend_Queue_Stomp_Frame.

setBody (   $body)

Set the body for this frame returns false if the body does not exist.

Set to null for no body.

Parameters
string | null$body
Returns
$this
Exceptions
Zend_Queue_Exception

Implemented in Zend_Queue_Stomp_Frame.

setCommand (   $command)

Set the body for this frame returns false if the body does not exist.

Returns
$this
Exceptions
Zend_Queue_Exception

Implemented in Zend_Queue_Stomp_Frame.

setHeader (   $header,
  $value 
)

Returns a value for a header returns false if the header does not exist.

Parameters
string$header
string$value
Returns
$this
Exceptions
Zend_Queue_Exception

Implemented in Zend_Queue_Stomp_Frame.

setHeaders ( array  $headers)

Set the headers.

Throws an exception if the array values are not strings.

Parameters
array$headers
Returns
$this
Exceptions
Zend_Queue_Exception

Implemented in Zend_Queue_Stomp_Frame.

toFrame ( )

Takes the current parameters and returns a Stomp Frame.

Exceptions
Zend_Queue_Exception
Returns
string

Implemented in Zend_Queue_Stomp_Frame.