abs.ixi.client.io

Interface Writer

All Known Implementing Classes:

XMPPPacketWriter

public interface Writer

Interface specification for writer implementations in SDK. Writer interface work at user packet level. It accepts Packet instances and writes them on the wire. WRITE operations are available in both synchronous and asynchronous fashion.

Method Summary

Modifier and Type	Method and Description
boolean	isShutdown()
boolean	isWriting()
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.
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 a packet synchronously.

Method Detail

start

void start()

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

writeSync

void writeSync(Packet packet)
        throws NetworkException

Write a packet synchronously. As oposed to asynchronous writing in which packets are added to the WriteWaitingQ and writer thread keeps writing them from that queue, synchronous write immediately writes packets on underlying connection. This operation is executed inside invoker thread; therefore this operation may conflict with Writer thread's write operation.

This operation should never be used to by applications using SDK; it is solely for internal use. Moreover, this method does not updates counters/ACK status etc which may corrupt the stream state if used to transmit stanza packets

Parameters:

packet - pakcet to be written on connection

Throws:

NetworkException - if any network related error occurrs

writeAsync

boolean writeAsync(Stanza stanza)

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

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

boolean writeNextAsync(Stanza stanza)

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.

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

isWriting

boolean isWriting()

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

boolean isShutdown()

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.

shutdown

boolean shutdown()

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.

Returns:

boolean true or false

shutdownNow

boolean shutdownNow()

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.

Returns:

boolean true or false