org.refcodes.io.impls.AbstractByteReceiver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-io Show documentation
Artifact with commonly used I/O functionality and for connection related issues such as receiving or transmitting data in a unified way.
There is a newer version: 3.3.9
Show newest version
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// =============================================================================
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// =============================================================================
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// together with the GPL linking exception applied; as being applied by the GNU
// Classpath ("http://www.gnu.org/software/classpath/license.html")
// =============================================================================
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// =============================================================================
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.io.impls;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.TimeUnit;

import org.refcodes.component.CloseException;
import org.refcodes.component.OpenException;
import org.refcodes.component.impls.AbstractConnectableAutomaton;
import org.refcodes.controlflow.RetryCounter;
import org.refcodes.controlflow.impls.RetryCounterImpl;
import org.refcodes.data.ControlFlowConsts;
import org.refcodes.io.ByteBlockReceiver;
import org.refcodes.io.ByteDatagramReceiver;
import org.refcodes.io.ByteReceiver;
import org.refcodes.logger.RuntimeLogger;
import org.refcodes.logger.impls.RuntimeLoggerFactorySingleton;

/**
 * The {@link AbstractByteReceiver} is a base abstract implementation of the
 * {@link ByteReceiver} interface providing common functionality for concrete
 * real live {@link ByteDatagramReceiver} and {@link ByteBlockReceiver} (=
 * {@link ByteReceiver}) implementations.
 * 
 * A blocking queue is used internally to which received datagrams are put via
 * {@link #pushDatagram(Serializable)} and which can be retrieved via
 * {@link #readDatagram()}. The {@link #pushDatagram(byte)} method is your hook
 * when extending this class.
 * 
 * Make sure your code fetches the datagrams quick enough to prevent filling up
 * of the queue. In case the queue is filled up, adding elements via
 * {@link #pushDatagram(byte) to the queue is blocked until elements are taken
 * from the queue via {@link #readDatagram()}. So cautions are taken to prevent
 * a memory leak.
 */
public abstract class AbstractByteReceiver extends AbstractConnectableAutomaton implements ByteReceiver {

	private static RuntimeLogger LOGGER = RuntimeLoggerFactorySingleton.createRuntimeLogger();

	// /////////////////////////////////////////////////////////////////////////
	// CONSTANTS:
	// /////////////////////////////////////////////////////////////////////////

	public static final int DATAGRAM_QUEUE_SIZE = AbstractReceiver.DATAGRAM_QUEUE_SIZE;

	// /////////////////////////////////////////////////////////////////////////
	// VARIABLES:
	// /////////////////////////////////////////////////////////////////////////

	protected LinkedBlockingQueue _datagramQueue;

	// /////////////////////////////////////////////////////////////////////////
	// CONSTRUCTORS:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * Constructs a {@link AbstractByteReceiver} with a default sized blocking
	 * queue enabling a maximum of {@link #DATAGRAM_QUEUE_SIZE} datagrams.
	 * -------------------------------------------------------------------------
	 * Make sure your code fetches the datagrams quick enough to prevent filling
	 * up of the queue. In case the queue is filled up, adding elements via
	 * {@link #pushDatagram(Serializable)} to the queue is blocked until
	 * elements are taken from the queue via {@link #readDatagram()}.
	 */
	public AbstractByteReceiver() {
		_datagramQueue = new LinkedBlockingQueue( DATAGRAM_QUEUE_SIZE );
	}

	/**
	 * Constructs a {@link AbstractByteReceiver} with a custom sized
	 * blocking queue enabling a maximum of datagrams as specified by the
	 * capacity parameter.
	 * -------------------------------------------------------------------------
	 * Make sure your code fetches the datagrams quick enough to prevent filling
	 * up of the queue. In case the queue is filled up, adding elements via
	 * {@link #pushDatagram(Serializable)} to the queue is blocked until
	 * elements are taken from the queue via {@link #readDatagram()}.
	 * 
	 * @param aCapacity The capacity of the queue holding the received
	 *        datagrams.
	 */
	public AbstractByteReceiver( int aCapacity ) {
		_datagramQueue = new LinkedBlockingQueue( aCapacity );
	}

	// /////////////////////////////////////////////////////////////////////////
	// METHODS:
	// /////////////////////////////////////////////////////////////////////////

	@Override
	public byte readDatagram() throws OpenException, InterruptedException {
		if ( _datagramQueue.isEmpty() && !isOpened() ) { throw new OpenException( "Unable to read datagram  as the connection is NOT OPEN; connection status is " + getConnectionStatus() + "." ); }
		return _datagramQueue.take();
	}

	@Override
	public byte[] readDatagrams() throws OpenException, InterruptedException {
		if ( _datagramQueue.isEmpty() && !isOpened() ) { throw new OpenException( "Unable to read datagram  as the connection is NOT OPEN; connection status is " + getConnectionStatus() + "." ); }
		List theBytes = new ArrayList<>();
		_datagramQueue.drainTo( theBytes );
		byte[] theDatagrams = new byte[theBytes.size()];
		for ( int i = 0; i < theDatagrams.length; i++ ) {
			theDatagrams[i] = theBytes.get( i );
		}
		return theDatagrams;
	}

	@Override
	public boolean hasDatagram() throws OpenException {
		// Enable the caller to get all elements from the queue:
		// if ( _datagramQueue.isEmpty() && !isOpened() ) { throw new OpenException( "Unable to read datagram  as the connection is NOT OPEN; connection status is " + getConnectionStatus() + "." ); }
		return !_datagramQueue.isEmpty();
	}

	@Override
	public void close() throws CloseException {
		if ( isOpened() ) {
			super.close();
			releaseAll();
		}
	}

	@Override
	public void releaseAll() {
		synchronized ( _datagramQueue ) {
			_datagramQueue.notifyAll();
		}
	}

	// /////////////////////////////////////////////////////////////////////////
	// HOOKS:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * Pushes a datagram into the receiver and puts it into the blocking queue
	 * containing the so far received datagrams. Them datagrams can be retrieved
	 * via {@link #readDatagram()}: use {@link #hasDatagram()} to test
	 * beforehand whether there is a datagram available.
	 * 
	 * @param aDatagram The datagram to be pushed at the end of the blocking
	 *        queue; to be retrieved with the {@link #readDatagram()} method.
	 */
	protected void pushDatagram( byte aDatagram ) throws OpenException {
		if ( !isOpened() ) { throw new OpenException( "Unable to push datagram <" + aDatagram + "> as the connection is NOT OPEN; connection status is " + getConnectionStatus() + "." ); }
		RetryCounter theRetryCounter = new RetryCounterImpl( ControlFlowConsts.MAX_IO_RETRIES );
		try {
			while ( !_datagramQueue.offer( aDatagram, ControlFlowConsts.MAX_CODE_LOOP_SLEEP_TIME_IN_MS, TimeUnit.MILLISECONDS ) && theRetryCounter.nextRetry() ) {
				LOGGER.warn( "Trying to offer (add) a datagram to the datagram queue, though the queue is full, this is retry # <" + theRetryCounter.getRetryCount() + ">, aborting after <" + theRetryCounter.getRetryNumber() + "> retries. Retrying now after a delay of <" + (ControlFlowConsts.MAX_CODE_LOOP_SLEEP_TIME_IN_MS / 1000) + "> seconds..." );
				if ( !theRetryCounter.hasNextRetry() ) { throw new OpenException( "Unable to process the datagram after <" + theRetryCounter.getRetryNumber() + "> retries, aborting retries, dismissing datagram \"" + aDatagram + "\"!", null, null ); }
			}
		}
		catch ( InterruptedException ignored ) {}
	}
}