abs.ixi.client.io

Interface Reader

All Superinterfaces:

PacketForwarder, Runnable

All Known Implementing Classes:

XMPPPacketReader

public interface Reader
extends Runnable, PacketForwarder

Read data from a network socket. The reader works at byte level.

Method Summary

Modifier and Type	Method and Description
boolean	isReading()
boolean	isShutdown()
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.

Methods inherited from interface java.lang.Runnable

run

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

addPacketCollector, addPacketCollector, forwardPacket, removePacketCollector, removePacketCollector

Method Detail

start

void start()

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

isReading

boolean isReading()

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

boolean isShutdown()

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

stop

void stop()

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

shutdown

boolean shutdown()

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

Returns:

boolean true or false