Packageorg.igniterealtime.xiff.data.stream
Classpublic class IBBOpenExtension
InheritanceIBBOpenExtension Inheritance IBBExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements IExtension

XEP-0047: In-Band Bytestreams, Version 2.0 (2012-06-22)

Open the communication

It is RECOMMENDED to send IBB data using IQ stanzas instead of message stanzas because IQ stanzas provide feedback to the sender regarding delivery to the recipient).

See also

http://xmpp.org/extensions/xep-0047.html


Public Properties
 PropertyDefined By
  blockSize : uint
The REQUIRED 'block-size' attribute defines the maximum size in bytes of each data chunk (which MUST NOT be greater than 65535).
IBBOpenExtension
 Inheritedsid : String
The REQUIRED 'sid' attribute defines a unique session ID for this IBB session (which MUST match the NMTOKEN datatype).
IBBExtension
  stanza : String
The OPTIONAL 'stanza' attribute defines whether the data will be sent using IQ stanzas or Message stanzas.
IBBOpenExtension
 Inheritedxml : XML
[override] Override in order to take care of setting the Namespace and checking for containing extensions.
Extension
Public Methods
 MethodDefined By
  
IBBOpenExtension(parent:XML = null)
The recommended values for blockSize (4096) and stanza ("iq") are set by default.
IBBOpenExtension
 Inherited
Add extension to the list of the given namespace and insert to the XML element as a child.
ExtensionContainer
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(nameSpace:String):Array
ExtensionContainer
 Inherited
getAttribute(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
 Inherited
getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML.
XMLStanza
 Inherited
getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML.
XMLStanza
  
IBBOpenExtension
 Inherited
getExtension(elementName:String):IExtension
Get the extension having the given element name.
ExtensionContainer
 Inherited
getField(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
 Inherited
getNS():String
IBBExtension
 Inherited
remove():void
Removes the extension from its parent.
Extension
 Inherited
removeAllExtensions(nameSpace:String):void
ExtensionContainer
 Inherited
removeExtension(extension:IExtension):Boolean
ExtensionContainer
 Inherited
removeFields(name:String):void
Helper method for removing all child elements that have the given name.
XMLStanza
 Inherited
setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML.
XMLStanza
 Inherited
setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML.
XMLStanza
 Inherited
setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
toString():String
Converts the base stanza XML to a string.
XMLStanza
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NS : Namespace
[static] Default XML namespace.
XMLStanza
  ELEMENT_NAME : String = open
[static]
IBBOpenExtension
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
 InheritedNS : String = http://jabber.org/protocol/ibb
[static]
IBBExtension
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
blockSizeproperty
blockSize:uint

The REQUIRED 'block-size' attribute defines the maximum size in bytes of each data chunk (which MUST NOT be greater than 65535).

The default value is 4096.


Implementation
    public function get blockSize():uint
    public function set blockSize(value:uint):void
stanzaproperty 
stanza:String

The OPTIONAL 'stanza' attribute defines whether the data will be sent using IQ stanzas or Message stanzas.

The default value is iq.


Implementation
    public function get stanza():String
    public function set stanza(value:String):void
Constructor Detail
IBBOpenExtension()Constructor
public function IBBOpenExtension(parent:XML = null)

The recommended values for blockSize (4096) and stanza ("iq") are set by default.

Parameters
parent:XML (default = null)
Method Detail
getElementName()method
public function getElementName():String

Returns
String
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = open