com.dsi.ant.channel

Enum AntCommandFailureReason

java.lang.Object

java.lang.Enum<AntCommandFailureReason>

com.dsi.ant.channel.AntCommandFailureReason

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AntCommandFailureReason>

public enum AntCommandFailureReason
extends java.lang.Enum<AntCommandFailureReason>

The possible causes of an AntCommandFailedException.

Since:

4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACKGROUND_SCAN_IN_USE Another channel is already performing a background scan.
CANCELLED The blocking operation was interrupted.
CHANNEL_RELEASING The channel is releasing, and is no longer acquired by this application.
CHANNEL_RESPONSE The ANT Adapter replied with a channel response including a response code that was not "no error".
INVALID_REQUEST The attempted operation is not valid for this channel in its current state.
IO_ERROR There was a failure communicating with the ANT hardware.
TRANSFER_FAILED The attempted transfer (Acknowledged message or Burst transfer) was not able to be sent to the receiver.
TRANSFER_IN_PROGRESS This channel is already processing an acknowledged message, or any channel is processing a burst.
UNKNOWN The service sent a failure not defined in this version of the library.

Method Summary

Methods

Modifier and Type	Method and Description
static AntCommandFailureReason	create(int rawValue) Used internally by the API to create a failure reason received from ANT Radio Service.
int	getRawValue() Returns the raw value of this enumeration value.
static AntCommandFailureReason	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AntCommandFailureReason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final AntCommandFailureReason UNKNOWN

The service sent a failure not defined in this version of the library.

Since:

4.0

IO_ERROR

public static final AntCommandFailureReason IO_ERROR

There was a failure communicating with the ANT hardware. The channel will be released.

Since:

4.0

CHANNEL_RESPONSE

public static final AntCommandFailureReason CHANNEL_RESPONSE

The ANT Adapter replied with a channel response including a response code that was not "no error". The response message will also be received through the IAntChannelEventHandler.

Since:

4.0

CHANNEL_RELEASING

public static final AntCommandFailureReason CHANNEL_RELEASING

The channel is releasing, and is no longer acquired by this application.

Since:

4.0

INVALID_REQUEST

public static final AntCommandFailureReason INVALID_REQUEST

The attempted operation is not valid for this channel in its current state.

Since:

4.0

TRANSFER_IN_PROGRESS

public static final AntCommandFailureReason TRANSFER_IN_PROGRESS

This channel is already processing an acknowledged message, or any channel is processing a burst. If the ANT adapter can not cancel an acknowledge message request, then close will fail with this error while an acknowledge message is processing.

Since:

4.0

TRANSFER_FAILED

public static final AntCommandFailureReason TRANSFER_FAILED

The attempted transfer (Acknowledged message or Burst transfer) was not able to be sent to the receiver. The remote side may have actually received the data, but an acknowledgment was never read back.

This is only triggered when processing a method which waits for the transfer result.

Since:

4.0

BACKGROUND_SCAN_IN_USE

public static final AntCommandFailureReason BACKGROUND_SCAN_IN_USE

Another channel is already performing a background scan.

Since:

4.0

CANCELLED

public static final AntCommandFailureReason CANCELLED

The blocking operation was interrupted.

Since:

4.0

Method Detail

values

public static AntCommandFailureReason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AntCommandFailureReason c : AntCommandFailureReason.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AntCommandFailureReason valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getRawValue

public int getRawValue()

Returns the raw value of this enumeration value. Applications should use the enumeration values directly.

Since:

4.0

create

public static AntCommandFailureReason create(int rawValue)

Used internally by the API to create a failure reason received from ANT Radio Service. Applications should use and access the enumeration values directly.

Since:

4.0