Encodes messages into the Wildfire JSON Stream Communication Protocol.
category | Zend |
---|---|
package | Zend_Wildfire |
subpackage | Protocol |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
clearMessages(\Zend_Wildfire_Plugin_Interface $plugin) : boolean
\Zend_Wildfire_Plugin_Interface
The plugin for which to clear messages
boolean
Returns TRUE if messages were presentgetMessages() : mixed
mixed
Returns qued messages or FALSE if no messages are quedgetPayload(\Zend_Wildfire_Channel_Interface $channel) : mixed
\Zend_Wildfire_Channel_Interface
The instance of the channel that will be transmitting the data
\Zend_Wildfire_Exception |
---|
mixed
Returns the data to be sent by the channel.recordMessage(\Zend_Wildfire_Plugin_Interface $plugin, string $structure, array $data) : boolean
\Zend_Wildfire_Plugin_Interface
The plugin recording the message
string
The structure to be used for the data
array
The data to be recorded
boolean
Returns TRUE if message was recordedregisterPlugin(\Zend_Wildfire_Plugin_Interface $plugin) : boolean
\Zend_Wildfire_Plugin_Interface
The plugin to be registered
boolean
Returns TRUE if plugin was registered, false if it was already registered_encode(mixed $value) : string
mixed
The value to be encoded
string
The encoded value$_plugins : array
array()
PROTOCOL_URI = 'http://meta.wildfirehq.org/Protocol/JsonStream/0.2'