org.refcodes.codec.ModemDecoder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of refcodes-codec Show documentation

Artifact with encoding and decoding (not in terms of encryption/decryption) implementations (codecs) such as BASE64 encoding / decoding.

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")
// -----------------------------------------------------------------------------
// 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.codec;

import org.refcodes.component.ConnectionComponent;
import org.refcodes.io.ByteProvider;
import org.refcodes.io.ShortProvider;

/**
 * The {@link ModemDecoder} implements a Frequency-shift keyring decoder.
 * 
 * "... Frequency-shift keyring (FSK) is a frequency modulation scheme in which
 * digital information is transmitted through discrete frequency changes of a
 * carrier signal ..." (Wikipedia)
 * 
 * @see "https://en.wikipedia.org/wiki/Frequency-shift_keyring"
 */
public interface ModemDecoder extends Decoder, DemodulatorStatusAccessor {

	// /////////////////////////////////////////////////////////////////////////
	// INNER CLASSES:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * The {@link ModemByteDecoderProvider} implements the {@link ModemDecoder}
	 * functionality in terms of a {@link ConnectionComponent}. In addition to
	 * the {@link ModemDecoder} it provides means to open a dedicated
	 * {@link ByteProvider} connection.
	 */
	public interface ModemByteDecoderProvider extends ModemDecoder, ConnectionComponent {}

	// /////////////////////////////////////////////////////////////////////////
	// INNER CLASSES:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * The {@link ModemShortDecoderProvider} implements the {@link ModemDecoder}
	 * functionality in terms of a {@link ConnectionComponent}. In addition to
	 * the {@link ModemDecoder} it provides means to open a dedicated
	 * {@link ShortProvider} connection.
	 */
	public interface ModemShortDecoderProvider extends ModemDecoder, ConnectionComponent {}

}