rocks.xmpp.extensions.bytestreams.ibb

Class InBandByteStreamManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.extensions.bytestreams.ByteStreamManager

rocks.xmpp.extensions.bytestreams.ibb.InBandByteStreamManager

public final class InBandByteStreamManager
extends ByteStreamManager

A manager for XEP-0047: In-Band Bytestreams. IBB streams use the same transport as XMPP, i.e. the same TCP or BOSH connection.

To initiate an IBB session with another entity, use initiateSession(Jid, String, int).

This class is thread-safe.

See Also:

XEP-0047: In-Band Bytestreams

Method Summary

Modifier and Type	Method and Description
InBandByteStream.Open.StanzaType	getStanzaType() Gets the stanza type.
AsyncResult<ByteStreamSession>	initiateSession(Jid receiver, java.lang.String sessionId, int blockSize) Initiates an in-band byte stream session.
void	setStanzaType(InBandByteStream.Open.StanzaType stanzaType) Sets the stanza type, which is used to send data chunks.

Methods inherited from class rocks.xmpp.extensions.bytestreams.ByteStreamManager

addByteStreamListener, removeByteStreamListener

Methods inherited from class rocks.xmpp.core.session.Manager

isEnabled, setEnabled

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

initiateSession

public final AsyncResult<ByteStreamSession> initiateSession(Jid receiver,
                                                            java.lang.String sessionId,
                                                            int blockSize)

Initiates an in-band byte stream session.

Parameters:

receiver - The receiver.

sessionId - The session id.

blockSize - The block size.

Returns:

The async result with the in-band byte stream session.

setStanzaType

public final void setStanzaType(InBandByteStream.Open.StanzaType stanzaType)

Sets the stanza type, which is used to send data chunks. It is recommended to leave this on the default (InBandByteStream.Open.StanzaType.IQ).

Parameters:

stanzaType - The stanza type.

getStanzaType

public final InBandByteStream.Open.StanzaType getStanzaType()

Gets the stanza type.

Returns:

The stanza type.