Package org.jivesoftware.smack

Interface XmppInputOutputFilter

public interface XmppInputOutputFilter

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	XmppInputOutputFilter.OutputResult

Method Summary

Modifier and Type	Method	Description
default void	closeInputOutput()
String	getFilterName()
Object	getStats()
ByteBuffer	input(ByteBuffer inputData)	The returned ByteBuffer is going to get fliped by the caller.
XmppInputOutputFilter.OutputResult	output(ByteBuffer outputData, boolean isFinalDataOfElement, boolean destinationAddressChanged, boolean moreDataAvailable)	The outputData argument may be a direct ByteBuffer.
default void	waitUntilInputOutputClosed()

Method Detail

output

XmppInputOutputFilter.OutputResult output(ByteBuffer outputData,
                                          boolean isFinalDataOfElement,
                                          boolean destinationAddressChanged,
                                          boolean moreDataAvailable)
                                   throws IOException

The outputData argument may be a direct ByteBuffer. The filter has consume the data of the buffer completely. This method must return a XmppInputOutputFilter.OutputResult. Use XmppInputOutputFilter.OutputResult.NO_OUTPUT if there is no output.

Parameters:

outputData - the data this method needs to process.

isFinalDataOfElement - if this is the final data of the element.

destinationAddressChanged - if the destination address has changed.

moreDataAvailable - if more data is available.

Returns:

a output result.

Throws:

IOException - in case an I/O exception occurs.

input

ByteBuffer input(ByteBuffer inputData)
          throws IOException

The returned ByteBuffer is going to get fliped by the caller. The callee must not flip the buffer.

Parameters:

inputData - the data this methods needs to process.

Returns:

a ByteBuffer or null if no data could be produced.

Throws:

IOException - in case an I/O exception occurs.

closeInputOutput

default void closeInputOutput()

waitUntilInputOutputClosed

default void waitUntilInputOutputClosed()
                                 throws IOException,
                                        SmackException.NoResponseException,
                                        CertificateException,
                                        InterruptedException,
                                        SmackException,
                                        XMPPException

Throws:

IOException

SmackException.NoResponseException

CertificateException

InterruptedException

SmackException

XMPPException

getStats

Object getStats()

getFilterName

String getFilterName()