unprocessed.java

Short Message Peer to Peer

/*
 * Copyright (c) 1996-2001
 * Logica Mobile Networks Limited
 * All rights reserved.
 *
 * This software is distributed under Logica Open Source License Version 1.0
 * ("Licence Agreement"). You shall use it and distribute only in accordance
 * with the terms of the License Agreement.
 *
 */
package org.smpp.util;

import org.smpp.Data;
import org.smpp.util.ByteBuffer;

/**
 * Utility class <code>Unprocessed</code> is used for data received from
 * connection which aren't complete PDU yet.
 *
 * @author Logica Mobile Networks SMPP Open Source Team
 * @version $Revision: 1.1 $
 */
public class Unprocessed {
	/**
	* Buffer for data which aren't complete PDU yet. Each time new data
	* are received, they are appended to this buffer and PDU is created
	* from this buffer.
	*
	* @see #hasUnprocessed
	* @see org.smpp.ReceiverBase#receivePDUFromConnection(Connection,Unprocessed)
	*/
	private ByteBuffer unprocessed = new ByteBuffer();

	/**
	 * Contains haw many bytes is expected after it's been decided that
	 * the current bytes aren't enough to build up complete PDU.
	 */
	private int expected = 0;

	/**
	* Indicates that after creating PDU from <code>unprocessed</code> buffer
	* there were still some data left in the <code>unprocessed</code> buffer.
	* In the next receive even if no new data will be received an attempt
	* to create PDU from <code>unprocessed</code> buffer will be performed.
	*
	* @see #unprocessed
	* @see org.smpp.ReceiverBase#receivePDUFromConnection(Connection,Unprocessed)
	*/
	private boolean hasUnprocessed = false;

	/**
	* Contains the time when some data were received from connection.
	* If it is currently longer from <code>lastTimeReceived</code>
	* than specified by <code>receiveTimeout</code>,
	* <code>TimeoutException</code> is thrown. 
	*
	* @see org.smpp.ReceiverBase#receiveTimeout
	* @see TimeoutException
	* @see org.smpp.ReceiverBase#receivePDUFromConnection(Connection,Unprocessed)
	*/
	private long lastTimeReceived = 0;

	/**
	* Resets flag <code>hasUnprocessed</code>, removes all bytes
	* from <code>unprocessed</code> buffer and sets <code>expected</code>
	* to zero.
	*
	* @see #hasUnprocessed
	* @see #unprocessed
	* @see #expected
	*/
	public void reset() {
		hasUnprocessed = false;
		unprocessed.setBuffer(null);
		expected = 0;
	}

	/**
	* Sets flag <code>hasUnprocessed</code> if there are any
	* unprocessed bytes in <code>unprocessed</code> buffer.
	*
	* @see #hasUnprocessed
	* @see #unprocessed
	*/
	public void check() {
		hasUnprocessed = unprocessed.length() > 0;
	}

	public void setHasUnprocessed(boolean value) {
		hasUnprocessed = value;
	}
	public void setExpected(int value) {
		expected = value;
	}
	public void setLastTimeReceived(long value) {
		lastTimeReceived = value;
	}
	public void setLastTimeReceived() {
		lastTimeReceived = Data.getCurrentTime();
	}

	public ByteBuffer getUnprocessed() {
		return unprocessed;
	}
	public boolean getHasUnprocessed() {
		return hasUnprocessed;
	}
	public int getExpected() {
		return expected;
	}
	public long getLastTimeReceived() {
		return lastTimeReceived;
	}
}
/*
 * $Log: Unprocessed.java,v $
 * Revision 1.1  2003/07/23 00:29:08  sverkera
 * Imported
 *
 */