rocks.xmpp.nio.codec

Class XmppStreamDecoder

java.lang.Object

rocks.xmpp.nio.codec.XmppStreamDecoder

public final class XmppStreamDecoder
extends java.lang.Object

Decodes a stream of byte buffers to XMPP elements.

Decoding is thread-safe, as long as the supplied Unmarshaller is not shared by another thread, e.g. if a thread-local Unmarshaller is supplied.

Stream restarts can be achieved by using the restart() methods. Decoding and restarts are thread-safe, i.e. can be called by different threads.

Constructor Summary

Constructors

Constructor and Description
XmppStreamDecoder(java.util.function.Supplier<javax.xml.bind.Unmarshaller> unmarshaller) Creates the XMPP decoder.

Method Summary

Modifier and Type	Method and Description
void	decode(java.nio.ByteBuffer in, java.util.function.BiConsumer<java.lang.String,StreamElement> out) Decodes a stream of byte buffers to XMPP elements.
void	restart() Restarts the stream, i.e. a new reader will be created.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmppStreamDecoder

public XmppStreamDecoder(java.util.function.Supplier<javax.xml.bind.Unmarshaller> unmarshaller)

Creates the XMPP decoder.

Because Unmarshaller is not thread-safe, it is recommended to pass a ThreadLocal<Unmarshaller> to this constructor, which ensures thread-safety during unmarshalling.

Parameters:

unmarshaller - Supplies the unmarshaller which will convert XML to objects.

Method Detail

decode

public final void decode(java.nio.ByteBuffer in,
                         java.util.function.BiConsumer<java.lang.String,StreamElement> out)
                  throws StreamErrorException

Decodes a stream of byte buffers to XMPP elements.

Parameters:

in - The byte buffer which was read from the channel. It must be ready to read, i.e. flipped.

out - Consumes any decoded elements as string and as unmarshalled object.

Throws:

StreamErrorException - If parsing XML fails or any other stream error occurred (e.g. invalid XML).

restart

public final void restart()

Restarts the stream, i.e. a new reader will be created.