abs.ixi.client.io

Interface ByteProcessor

All Known Implementing Classes:

XMPPByteProcessor

public interface ByteProcessor

Low-level byte stream processor which can process a certain type of byte stream i.e MIME byte stream, XMPP stream. The processors require governance by a controlling entity which can facilitate switch-over mechanism and can provide all the required dependencies and processing context. In scenarios in which a stream is multiplexed, multiple ByteProcessor will be required to work in tandem and during stream processing, ByteProcessor will switch.

Method Summary

Modifier and Type	Method and Description
void	flushUnprocessedBytes() Discard all the bytes which have not been processed.
void	processBytes(ByteSource networkData) Process byte stream; processing a byte stream typically involves encoding, parsing and building a packet.
void	processBytes(ByteSource networkData, int length) Process byte stream; processing a byte stream typically involves encoding, parsing and building a packet.
void	resume(Packet switchOver) Resume processing a byte stream.
int	unprocessedByteCount() A byte processor is likely to process bytes in chunks from a ByteSource.

Method Detail

resume

void resume(Packet switchOver)

Resume processing a byte stream. It could be that previous ByteProcessor was building a packet which is not yet complete. This half-built packet is passed onto to this ByteProcessor.

Parameters:

switchOver - half-built packet from previous processor

processBytes

void processBytes(ByteSource networkData)
           throws Exception

Process byte stream; processing a byte stream typically involves encoding, parsing and building a packet. Therefore, the method may throw ParserException or MalformedStreamException

Parameters:

networkData - networkData

Throws:

Exception - exception

processBytes

void processBytes(ByteSource networkData,
                  int length)
           throws Exception

Process byte stream; processing a byte stream typically involves encoding, parsing and building a packet. Therefore, the method may throw ParserException or MalformedStreamException a

Parameters:

networkData - networkData

length - length

Throws:

Exception - Exception

unprocessedByteCount

int unprocessedByteCount()

A byte processor is likely to process bytes in chunks from a ByteSource. It may happen that before a byte processor finishes processing a byte chunk, byte processing is taken over by another ByteProcessor. In this case, the active byte processor will require to know the number pf bytes which were left unprocessed in the chunk.

Returns:

int count

flushUnprocessedBytes

void flushUnprocessedBytes()

Discard all the bytes which have not been processed.