OutgoingTCPClientPacket.java

/*Copyright (c) 2008 Nikos Siatras

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.*/
package Extasys.Network.TCP.Client.Connectors.Packets;

import Extasys.Network.TCP.Client.Connectors.TCPConnector;
import Extasys.ManualResetEvent;
import Extasys.Network.TCP.Client.Exceptions.ConnectorCannotSendPacketException;
import java.io.IOException;

/**
 *
 * @author Nikos Siatras
 */
public class OutgoingTCPClientPacket implements Runnable
{

    public ManualResetEvent fDone = new ManualResetEvent(false);
    private TCPConnector fConnector;
    private byte[] fBytes;
    private int fOffset;
    private int fLength;
    private OutgoingTCPClientPacket fPreviousPacket;
    public boolean fCancel = false;

    /**
     * Constructs a new outgoing packet for an existing TCP Connector.
     * 
     * Use this class to send data from the TCP Connector to a server.
     * This is an outgoing message that will remain in the servers thread pool 
     * as a job for the thread pool workers.
     * 
     * @param TCPConnector is the TCPConnector where this message belongs to.
     * @param bytes is the byte array to be sent.
     * @param offset is the position in the data buffer at witch to begin sending.
     * @param length is the number of the bytes to be send.
     * @param previousPacket is the previous outgoing packet of the TCPConnector.
     */
    public OutgoingTCPClientPacket(TCPConnector connector, byte[] bytes, int offset, int length, OutgoingTCPClientPacket previousPacket) throws ConnectorCannotSendPacketException
    {
        fConnector = connector;
        fBytes = bytes;
        fOffset = offset;
        fLength = length;
        fPreviousPacket = previousPacket;

        connector.getMyExtasysTCPClient().getMyThreadPool().execute(this);
    }

    /**
     * Cancel this outgoing packet.
     * 
     * By calling this method this and all the previous outgoing packets that 
     * are stored in the thread pool will be canceled.
     * Call this method for the last outgoing packet of the TCP Connector
     * when the TCP Connector disconnects.
     * 
     */
    public void Cancel()
    {
        fCancel = true;
        fDone.Set();
    }

    public void run()
    {
        try
        {
            if (fPreviousPacket == null)
            {
                try
                {
                    fConnector.fOutput.write(fBytes, fOffset, fLength);
                    fConnector.fBytesOut += fLength;
                }
                catch (IOException ioException)
                {
                    fCancel = true;
                    fConnector.Stop();
                }
            }
            else
            {
                fPreviousPacket.fDone.WaitOne();

                if (!fCancel && !fPreviousPacket.fCancel)
                {
                    try
                    {
                        fConnector.fOutput.write(fBytes, fOffset, fLength);
                        fConnector.fBytesOut += fLength;
                    }
                    catch (IOException ioException)
                    {
                        fCancel = true;
                        fConnector.Stop();
                    }
                }
                else
                {
                    fCancel = true;
                }
            }
        }
        catch (Exception ex)
        {
        }

        if (fPreviousPacket != null)
        {
            fPreviousPacket = null;
        }

        fDone.Set();
    }

    /**
     * Returns the byte array of this packet.
     * 
     * @return the byte array of this packet.
     */
    public byte[] getBytes()
    {
        return fBytes;
    }

    /**
     * Returns the offset of this packet.
     * 
     * @return the offset of this packet.
     */
    public int getOffset()
    {
        return fOffset;
    }

    /**
     * Returns the number of bytes to send from this packet.
     * 
     * @return the number of bytes to send from this packet.
     */
    public int getLength()
    {
        return fLength;
    }
}