abs.ixi.client.io

Class XMPPPacketWriter

java.lang.Object

abs.ixi.client.io.XMPPPacketWriter

All Implemented Interfaces:

PacketCollector, Writer, ReconnectionListener

public class XMPPPacketWriter
extends Object
implements Writer, PacketCollector, ReconnectionListener

Writer implementation which writes XMPP packets onto wire. XMPPConnection and TCPConnection are not thread-safe. Moreover, a socket does not permit concurrent writes; therefore, XMPPPacketWriter enforces serial execution of write calls which may be triggered by different threads.

XMPPPacketWriter keeps track of the packets for which client has received ACK from the server. If the client does not receive ACK from server for a Packet in stipulated time, client assumes that connection to server is broken. It could be that device does not have Internet connection; or something unexpected has broken the connection.

Constructor Summary

Constructors

Constructor and Description
XMPPPacketWriter(XMPPConnection connection)

Method Summary

Modifier and Type	Method and Description
void	collect(Packet packet) This collector takes the given packet.
boolean	isShutdown()
boolean	isWriting()
void	reconnected() Call if reconnection is successful
void	reconnectionFailed() Call if reconnection failed.
void	reconnectionStarted() Call when reconnection is triggered
boolean	shutdown() Shutdown the writer after writing all the queued packets; however writer will stop accepting packets for writing immediately.
boolean	shutdownNow() Shutdown the writer immediately.
void	start() Start Writer; this will start writer thread and will turn on the 'Started' flag.
String	toString()
boolean	writeAsync(Stanza stanza) Add a Stanza to writerWaitingQ.
boolean	writeNextAsync(Stanza stanza) Add a Stanza at the HEAD of writerWaitingQ.
void	writeSync(Packet packet) Write packets on to the wire directly bypassing normal flow of XMPPPacketWriter process.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMPPPacketWriter

public XMPPPacketWriter(XMPPConnection connection)

Method Detail

start

public void start()

Description copied from interface: Writer

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

Specified by:

start in interface Writer

writeAsync

public boolean writeAsync(Stanza stanza)

Add a Stanza to writerWaitingQ. Writer thread will write the stanza whenver stream is ready

Specified by:

writeAsync in interface Writer

Parameters:

stanza - Stanza packet to be sent to server

Returns:

a true value indicates that the packet was added to the queue and a false value indicates that the queue was full and the packet could not be added to the queue

writeNextAsync

public boolean writeNextAsync(Stanza stanza)

Description copied from interface: Writer

Add a Stanza at the HEAD of writerWaitingQ. As the stanza is added at the head of the queue, it will be picked up for writing in next WRITE operation.

Specified by:

writeNextAsync in interface Writer

Parameters:

stanza - Stanza packet to be sent to server

Returns:

a true value indicates that the packet was added to the queue and a false value indicates that the queue was full and the packet could not be added to the queue

collect

public void collect(Packet packet)

Description copied from interface: PacketCollector

This collector takes the given packet. The collector may employ further filtering and may decide to ignore/drop this packet.

Specified by:

collect in interface PacketCollector

Parameters:

packet - packet instance to be collected

isWriting

public boolean isWriting()

Specified by:

isWriting in interface Writer

Returns:

true if the writer is running otherwise false. Important to note that a true value does not indicate that writer is literally writing content on the wire at the moment. The flag value is indicative of the writing process status.

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface Writer

Returns:

true if the writer process has been shutdown. A value true means that Writer has been shutdown explicitly after it was started. A writer which was never started will return false value.

reconnectionStarted

public void reconnectionStarted()

Description copied from interface: ReconnectionListener

Call when reconnection is triggered

Specified by:

reconnectionStarted in interface ReconnectionListener

reconnected

public void reconnected()

Description copied from interface: ReconnectionListener

Call if reconnection is successful

Specified by:

reconnected in interface ReconnectionListener

reconnectionFailed

public void reconnectionFailed()

Description copied from interface: ReconnectionListener

Call if reconnection failed.

Specified by:

reconnectionFailed in interface ReconnectionListener

writeSync

public void writeSync(Packet packet)
               throws NetworkException

Write packets on to the wire directly bypassing normal flow of XMPPPacketWriter process. This method has restricted access and meant to be used by SDK only; specifically StreamNegotiator

While stream negotiations are in progress, writer thread waits for negotiation process to finish. In this case, anything added to writer queue will not be processed by writer thread.

Specified by:

writeSync in interface Writer

Parameters:

packet - packet to be written

Throws:

NetworkException - when IO error occurrs, device does not have internet or connection is not connected

shutdown

public boolean shutdown()

Description copied from interface: Writer

Shutdown the writer after writing all the queued packets; however writer will stop accepting packets for writing immediately. No action is taken on the underlying connection.

Specified by:

shutdown in interface Writer

Returns:

boolean true or false

shutdownNow

public boolean shutdownNow()

Description copied from interface: Writer

Shutdown the writer immediately. In this case, writer will not wait to finish writing all the queued packets. It does not take any action on the underlying connection though.

Specified by:

shutdownNow in interface Writer

Returns:

boolean true or false

toString

public String toString()

Overrides:

toString in class Object