org.jivesoftware.smackx.bytestreams.ibb.packet

Class Open

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.bytestreams.ibb.packet.Open

public class Open
extends IQ

Represents a request to open an In-Band Bytestream.

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.Type

Field Summary

Fields inherited from class org.jivesoftware.smack.packet.Packet

DEFAULT_LANGUAGE, ID_NOT_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
Open(String sessionID, int blockSize) Creates a new In-Band Bytestream open request packet.
Open(String sessionID, int blockSize, InBandBytestreamManager.StanzaType stanza) Creates a new In-Band Bytestream open request packet.

Method Summary

Methods

Modifier and Type	Method and Description
int	getBlockSize() Returns the block size in which the data will be fragmented.
String	getChildElementXML() Returns the sub-element XML section of the IQ packet, or null if there isn't one.
String	getSessionID() Returns the unique session ID identifying this In-Band Bytestream.
InBandBytestreamManager.StanzaType	getStanza() Returns the stanza type used to encapsulate the data.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createResultIQ, getType, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Packet

addCommonAttributes, addExtension, addExtensions, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setTo, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Open

public Open(String sessionID,
    int blockSize,
    InBandBytestreamManager.StanzaType stanza)

Creates a new In-Band Bytestream open request packet.

The data sent over this In-Band Bytestream will be fragmented in blocks with the given block size. The block size should not be greater than 65535. A recommended default value is 4096.

The data can be sent using IQ stanzas or message stanzas.

Parameters:

sessionID - unique session ID identifying this In-Band Bytestream

blockSize - block size in which the data will be fragmented

stanza - stanza type used to encapsulate the data

Open

public Open(String sessionID,
    int blockSize)

Creates a new In-Band Bytestream open request packet.

The data sent over this In-Band Bytestream will be fragmented in blocks with the given block size. The block size should not be greater than 65535. A recommended default value is 4096.

The data will be sent using IQ stanzas.

Parameters:

sessionID - unique session ID identifying this In-Band Bytestream

blockSize - block size in which the data will be fragmented

Method Detail

getSessionID

public String getSessionID()

Returns the unique session ID identifying this In-Band Bytestream.

Returns:

the unique session ID identifying this In-Band Bytestream

getBlockSize

public int getBlockSize()

Returns the block size in which the data will be fragmented.

Returns:

the block size in which the data will be fragmented

getStanza

public InBandBytestreamManager.StanzaType getStanza()

Returns the stanza type used to encapsulate the data.

Returns:

the stanza type used to encapsulate the data

getChildElementXML

public String getChildElementXML()

Description copied from class: IQ

Returns the sub-element XML section of the IQ packet, or null if there isn't one. Packet extensions must be included, if any are defined.

Extensions of this class must override this method.

Specified by:

getChildElementXML in class IQ

Returns:

the child element section of the IQ XML.