Statistics
Legends
Deprecated
Todos
Classes
Methods
Class fields
Class constants
Inheritances
Files
Overview
FRAMES
NO FRAMES

Interface Zend_Queue_Stomp_FrameInterface
Zend_Queue
|-Zend_Queue_Stomp
|- interface Zend_Queue_Stomp_FrameInterface
Implementing classes : Zend_Queue_Stomp_Frame
This class represents a Stomp Frame Interface
CategoryZend
PackageZend_Queue
SubpackageStomp
CopyrightCopyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
Licensehttp://framework.zend.com/license/new-bsd New BSD License

Summary
Instance methods
+ __toString()
+ fromFrame() Accepts a frame and deconstructs the frame into its' component parts
+ getAutoContentLength() Get the status of the auto content length
+ getBody() Return the body for this frame
+ getCommand() Return the command for this frame
+ getHeader() Returns a value for a header
+ getHeaders() Get the headers
+ setAutoContentLength() setAutoContentLength()
+ setBody() Set the body for this frame
+ setCommand() Set the body for this frame
+ setHeader() Returns a value for a header
+ setHeaders() Set the headers
+ toFrame() Takes the current parameters and returns a Stomp Frame

Details

Instance methods

__toString()
public function __toString( )
See also toFrame()
Defined in Queue/Stomp/FrameInterface.php, line 145
fromFrame()
public function fromFrame( $frame)
Accepts a frame and deconstructs the frame into its' component parts
Parameters
string $frame - a stomp frame
Returns $this
Defined in Queue/Stomp/FrameInterface.php, line 153
getAutoContentLength()
public function 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
Defined in Queue/Stomp/FrameInterface.php, line 44
getBody()
public function getBody( )
Return the body for this frame
returns false if the body does not exist
Returns $this
Defined in Queue/Stomp/FrameInterface.php, line 102
getCommand()
public function getCommand( )
Return the command for this frame
return false if the command does not exist
Returns $this
Defined in Queue/Stomp/FrameInterface.php, line 122
getHeader()
public function getHeader( $header)
Returns a value for a header
returns false if the header does not exist
Parameters
string $header
Returns $string
Defined in Queue/Stomp/FrameInterface.php, line 83
getHeaders()
public function getHeaders( )
Get the headers
Returns array
Defined in Queue/Stomp/FrameInterface.php, line 62
setAutoContentLength()
public function setAutoContentLength( $auto)
setAutoContentLength()

Set the value on or off.
Parameters
boolean $auto
Returns $this;
Defined in Queue/Stomp/FrameInterface.php, line 55
setBody()
public function 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
Defined in Queue/Stomp/FrameInterface.php, line 114
setCommand()
public function setCommand( $command)
Set the body for this frame
returns false if the body does not exist
Parameters
$command
Returns $this
Defined in Queue/Stomp/FrameInterface.php, line 131
setHeader()
public function setHeader( $header
$value)
Returns a value for a header
returns false if the header does not exist
Parameters
string $header
string $value
Returns $this
Defined in Queue/Stomp/FrameInterface.php, line 94
setHeaders()
public function setHeaders( array $headers)
Set the headers

Throws an exception if the array values are not strings.
Parameters
array $headers
Returns $this
Defined in Queue/Stomp/FrameInterface.php, line 73
toFrame()
public function toFrame( )
Takes the current parameters and returns a Stomp Frame
Returns string
Defined in Queue/Stomp/FrameInterface.php, line 140