Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
This class represents a Stomp Frame

fromFrame(
string $frame
)
:
\Zend_Queue_Stomp_Frame
Accepts a frame and deconstructs the frame into its component parts
Name | Type | Description |
---|---|---|
$frame | string |
|
Type | Description |
---|---|
\Zend_Queue_Stomp_Frame |

getAutoContentLength(
)
:
boolean
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.
Type | Description |
---|---|
boolean |

getBody(
)
:
false|string
Return the body for this frame
Returns false if the body does not exist
Type | Description |
---|---|
false|string |

getCommand(
)
:
string|false
Return the command for this frame
Return false if the command does not exist
Type | Description |
---|---|
string|false |

getHeader(
string $header
)
:
string|false
Returns a value for a header
Returns false if the header does not exist.
Name | Type | Description |
---|---|---|
$header | string |
Type | Description |
---|---|
string|false |
Exception | Description |
---|---|
\Zend_Queue_Exception |

setAutoContentLength(
boolean $auto
)
:
\$this;
setAutoContentLength()
Set the value on or off.
Name | Type | Description |
---|---|---|
$auto | boolean |
Type | Description |
---|---|
\$this; |
Exception | Description |
---|---|
\Zend_Queue_Exception |

setBody(
string|null $body
)
:
\Zend_Queue_Stomp_Frame
Set the body for this frame
Set to null for no body.
Name | Type | Description |
---|---|---|
$body | string|null |
Type | Description |
---|---|
\Zend_Queue_Stomp_Frame |
Exception | Description |
---|---|
\Zend_Queue_Exception |

setCommand(
$command
)
:
\Zend_Queue_Stomp_Frame
Set the body for this frame
Name | Type | Description |
---|---|---|
$command | string|null |
Type | Description |
---|---|
\Zend_Queue_Stomp_Frame |
Exception | Description |
---|---|
\Zend_Queue_Exception |

setHeader(
string $header, string $value
)
:
\Zend_Queue_Stomp_Frame
Sets a value for a header
Name | Type | Description |
---|---|---|
$header | string | |
$value | string |
Type | Description |
---|---|
\Zend_Queue_Stomp_Frame |
Exception | Description |
---|---|
\Zend_Queue_Exception |

setHeaders(
array $headers
)
:
\Zend_Queue_Stomp_Frame
Set the headers
Throws an exception if the array values are not strings.
Name | Type | Description |
---|---|---|
$headers | array |
Type | Description |
---|---|
\Zend_Queue_Stomp_Frame |
Exception | Description |
---|---|
\Zend_Queue_Exception |