Package | org.igniterealtime.xiff.data.stream |
Class | public class IBBDataExtension |
Inheritance | IBBDataExtension ![]() ![]() ![]() ![]() ![]() |
Implements | IExtension |
Each chunk of data is contained in a data element qualified by the 'http://jabber.org/protocol/ibb' namespace. The data element SHOULD be sent in an IQ stanza to enable proper tracking and throttling, but instead MAY be sent in a message stanza. The data to be sent, prior to base64-encoding and prior to any wrapping in XML, MUST NOT be larger than the 'block-size' determined in the bytestream negotiation.
See also
Property | Defined By | ||
---|---|---|---|
data : String
Base64 encoded data
| IBBDataExtension | ||
seq : uint
Required property 'seq'. | IBBDataExtension | ||
![]() | sid : String
The REQUIRED 'sid' attribute defines a unique session
ID for this IBB session (which MUST match the NMTOKEN
datatype). | IBBExtension | |
![]() | xml : XML [override]
Override in order to take care of setting the Namespace and
checking for containing extensions. | Extension |
Method | Defined By | ||
---|---|---|---|
IBBDataExtension(parent:XML = null) | IBBDataExtension | ||
![]() |
Add extension to the list of the given namespace and insert to the XML element as a child. | ExtensionContainer | |
![]() | getAllExtensions():Array | ExtensionContainer | |
![]() | getAllExtensionsByNS(nameSpace:String):Array | ExtensionContainer | |
![]() | getAttribute(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
![]() | getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML. | XMLStanza | |
![]() | getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML. | XMLStanza | |
getElementName():String | IBBDataExtension | ||
![]() | getExtension(elementName:String):IExtension
Get the extension having the given element name. | ExtensionContainer | |
![]() | getField(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
![]() | getNS():String | IBBExtension | |
![]() | remove():void
Removes the extension from its parent. | Extension | |
![]() | removeAllExtensions(nameSpace:String):void | ExtensionContainer | |
![]() | removeExtension(extension:IExtension):Boolean | ExtensionContainer | |
![]() | removeFields(name:String):void
Helper method for removing all child elements that have the given name. | XMLStanza | |
![]() | setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML. | XMLStanza | |
![]() | setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML. | XMLStanza | |
![]() | setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | toString():String
Converts the base stanza XML to a string. | XMLStanza |
Constant | Defined By | ||
---|---|---|---|
![]() | DEFAULT_NS : Namespace [static]
Default XML namespace. | XMLStanza | |
ELEMENT_NAME : String = data [static] | IBBDataExtension | ||
![]() | FLASH_NS : Namespace [static]
| XMLStanza | |
![]() | NS : String = http://jabber.org/protocol/ibb [static] | IBBExtension | |
![]() | STREAM_NS : Namespace [static]
| XMLStanza |
data | property |
data:String
Base64 encoded data
public function get data():String
public function set data(value:String):void
seq | property |
seq:uint
Required property 'seq'.
This is a 16-bit unsigned integer that acts as a counter for data chunks sent in a particular direction within this session. The 'seq' value starts at 0 (zero) for each sender and MUST be incremented for each packet sent by that entity. Thus, the second chunk sent has a 'seq' value of 1, the third chunk has a 'seq' value of 2, and so on. The counter loops at maximum, so that after value 65535 (215 - 1) the 'seq' MUST start again at 0.
This value can be safely incremented, limit checking and resetting is imlemented within the setter.
public function get seq():uint
public function set seq(value:uint):void
IBBDataExtension | () | Constructor |
public function IBBDataExtension(parent:XML = null)
Parameters
parent:XML (default = null )
|
getElementName | () | method |
public function getElementName():String
ReturnsString |
ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = data