org.refcodes.io.ShortBlockConsumer Maven / Gradle / Ivy

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 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;

import org.refcodes.component.OpenException;

/**
 * The {@link ShortBlockConsumer} is used to send short blocks (arrays) in a
 * unified way.
 */
@FunctionalInterface
public interface ShortBlockConsumer {

	/**
	 * Writes (sends) a short block.
	 * 
	 * @param aDatagrams The short to be pushed.
	 * 
	 * @throws OpenException Thrown in case opening or accessing an open line
	 *         (connection, junction, link) caused problems.
	 */
	default void writeDatagrams( short[] aDatagrams ) throws OpenException {
		writeDatagrams( aDatagrams, 0, aDatagrams.length );
	}

	/**
	 * Writes (sends) a short block.
	 * 
	 * @param aDatagrams The short to be pushed.
	 * 
	 * @param aOffset The offset from which to take the data.
	 * 
	 * @param aLength The number of elements to push starting at the given
	 *        offset.
	 * 
	 * @throws OpenException Thrown in case opening or accessing an open line
	 *         (connection, junction, link) caused problems.
	 */
	void writeDatagrams( short[] aDatagrams, int aOffset, int aLength ) throws OpenException;

}