org.refcodes.io.LoopbackShortsReceiver 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.8
Show newest version
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// =============================================================================
// This code is copyright (c) by Siegfried Steiner, Munich, Germany, distributed
// on an "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, and licen-
// sed 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/TEXT-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;

import java.io.IOException;

/**
 * A {@link LoopbackShortsReceiver} is a {@link DatagramReceiver} connected
 * directly within the same JVM with a {@link LoopbackShortsTransmitter}; a
 * "loopback" connection is used for establishing the connection which cannot be
 * accessed outside the JVM or the running machine.
 */
public class LoopbackShortsReceiver extends AbstractShortsReceiver implements ConnectionShortsReceiver {

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

	private LoopbackShortsTransmitter _loopbackSender;

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

	/**
	 * Instantiates a new loopback short receiver impl.
	 */
	public LoopbackShortsReceiver() {}

	/**
	 * Instantiates a new loopback short receiver impl.
	 *
	 * @param aCapacity the capacity
	 */
	public LoopbackShortsReceiver( int aCapacity ) {
		super( aCapacity );
	}

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

	/**
	 * {@inheritDoc}
	 */
	@Override
	public boolean isOpenable( LoopbackShortsTransmitter aLoopbackSender ) {
		return super.isOpenable() && aLoopbackSender != null;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public synchronized void open( LoopbackShortsTransmitter aLoopbackSender ) throws IOException {
		if ( isOpened() ) {
			if ( _loopbackSender == aLoopbackSender && _loopbackSender.isOpened() ) {
				return;
			}
			throw new IOException( "Unable to open the connection is is is ALREADY OPEN; connection status is " + getConnectionStatus() + "." );
		}
		super.open();
		_loopbackSender = aLoopbackSender;
		if ( _loopbackSender.isOpenable( this ) ) {
			_loopbackSender.open( this );
		}
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void pushDatagram( short aDatagram ) throws IOException {
		super.pushDatagram( aDatagram );
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void pushDatagrams( short[] aDatagrams ) throws IOException {
		super.pushDatagrams( aDatagrams );
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void pushDatagrams( short[] aDatagrams, int aOffset, int aLength ) throws IOException {
		super.pushDatagrams( aDatagrams, aOffset, aLength );
	}

	//	/**
	//	 * Pushes the datagrams into the {@link LoopbackBytesReceiver}. Them
	//	 * datagrams can be retrieved via {@link #receive()}: use
	//	 * {@link #available()} to test beforehand whether there is a datagram
	//	 * available.
	//	 *
	//	 * @param aDatagrams The datagrams to be pushed into the
	//	 *        {@link LoopbackBytesReceiver}; to be retrieved with the
	//	 *        {@link #receive()} method.
	//	 * @throws IOException the open exception
	//	 */
	//	public void pushDatagrams( short[] aDatagrams ) throws IOException {
	//		pushDatagrams( aDatagrams, 0, aDatagrams.length );
	//	}
	//
	//	/**
	//	 * Pushes the according number of datagrams beginning at the given offset
	//	 * into the {@link LoopbackBytesReceiver}. Them datagrams can be retrieved
	//	 * via {@link #receive()}: use {@link #available()} to test
	//	 * beforehand whether there is a datagram available.
	//	 *
	//	 * @param aDatagrams The datagrams to be pushed into the
	//	 *        {@link LoopbackBytesReceiver}; to be retrieved with the
	//	 *        {@link #receive()} method.
	//	 * @param aOffset The offset from which to begin pushing.
	//	 * @param aLength The number of elements to be pushed.
	//	 * @throws IOException the open exception
	//	 */
	//	public void pushDatagrams( short[] aDatagrams, int aOffset, int aLength ) throws IOException {
	//		for ( int i = 0; i < aLength; i++ ) {
	//			pushDatagram( aDatagrams[i + aOffset] );
	//		}
	//	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public synchronized void close() throws IOException {
		super.close();
		if ( _loopbackSender != null && !_loopbackSender.isClosed() ) {
			_loopbackSender.close();
			_loopbackSender = null;
		}
	}
}