abs.ixi.client.io

Class XMPPPacketReader

java.lang.Object

abs.ixi.client.core.AbstractPacketForwarder

abs.ixi.client.io.XMPPPacketReader

All Implemented Interfaces:

PacketForwarder, PacketHandler<XMPPPacket>, Reader, ConnectionStateObserver, Runnable

public class XMPPPacketReader
extends AbstractPacketForwarder
implements Reader, PacketHandler<XMPPPacket>, ConnectionStateObserver

XMPPPacketReader continuously reads bytes from underlying XMPPConnection; generates packets from the data and forwards to registered PacketCollectors. By default, XMPPStreamManager is always registered as PacketCollector.

XMPPPacketReader is a stateful entity; therefore it must be restarted whenever underlying connection is reset.

Constructor Summary

Constructors

Constructor and Description
XMPPPacketReader(XMPPConnection connection)

Method Summary

Modifier and Type	Method and Description
void	closed() Called when connection is closed
void	closingConnection() Method call to inform the dependent entities that after this method call the connection will be closed.
void	connected() Invoked when physical connection is established with server.
void	handle(XMPPPacket packet)
boolean	isReading()
boolean	isShutdown()
protected ByteBuffer	read()
void	run()
boolean	shutdown() Shutdown the reader and further reading is stopped immediately.
void	start() Start reader; this will start reader thread and will turn on the 'Started' flag.
void	stop() Stop reader from reading.
String	toString()

Methods inherited from class abs.ixi.client.core.AbstractPacketForwarder

addPacketCollector, addPacketCollector, forwardDefault, forwardPacket, removePacketCollector, removePacketCollector

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface abs.ixi.client.core.PacketForwarder

addPacketCollector, addPacketCollector, forwardPacket, removePacketCollector, removePacketCollector

Constructor Detail

XMPPPacketReader

public XMPPPacketReader(XMPPConnection connection)

Method Detail

start

public void start()

Description copied from interface: Reader

Start reader; this will start reader thread and will turn on the 'Started' flag.

Specified by:

start in interface Reader

run

public void run()

Specified by:

run in interface Runnable

read

protected ByteBuffer read()
                   throws IOException

Throws:

IOException

handle

public void handle(XMPPPacket packet)
            throws Exception

Specified by:

handle in interface PacketHandler<XMPPPacket>

Parameters:

packet - bufpacketfer

Throws:

Exception - Exception

isReading

public boolean isReading()

Specified by:

isReading in interface Reader

Returns:

true if the reader is running and reading otherwise false. Important to note that a true value does not indicate that reader is reading content from socket at the moment. The flag value is indicative of the reading process status.

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface Reader

Returns:

true if the reader process has been shutdown. A value true means that Reader has been shutdown explicitly after it was started. A reader which was never started

closingConnection

public void closingConnection()

Description copied from interface: ConnectionStateObserver

Method call to inform the dependent entities that after this method call the connection will be closed.

Specified by:

closingConnection in interface ConnectionStateObserver

closed

public void closed()

Description copied from interface: ConnectionStateObserver

Called when connection is closed

Specified by:

closed in interface ConnectionStateObserver

connected

public void connected()

Description copied from interface: ConnectionStateObserver

Invoked when physical connection is established with server. This could be first time when tcp connection is extablished with the server or reconnected

Specified by:

connected in interface ConnectionStateObserver

stop

public void stop()

Description copied from interface: Reader

Stop reader from reading. This is just setiing the stop flag so that the reader will stop in next execution of the reader loop.

Specified by:

stop in interface Reader

shutdown

public boolean shutdown()

Description copied from interface: Reader

Shutdown the reader and further reading is stopped immediately. It does not take any action on the underlying connection though.

Specified by:

shutdown in interface Reader

Returns:

boolean true or false

toString

public String toString()

Overrides:

toString in class Object