Package com.dsi.ant.channel
Enum Class AntCommandFailureReason
- All Implemented Interfaces:
Serializable
,Comparable<AntCommandFailureReason>
,Constable
The possible causes of an
AntCommandFailedException
.- Since:
- 4.0
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAnother channel is already performing a background scan.The blocking operation was interrupted.The channel is releasing, and is no longer acquired by this application.The ANT Adapter replied with a channel response including a response code that was not "no error".The attempted operation is not valid for this channel in its current state.There was a failure communicating with the ANT hardware.The attempted transfer (Acknowledged message or Burst transfer) was not able to be sent to the receiver.This channel is already processing an acknowledged message, or any channel is processing a burst.The service sent a failure not defined in this version of the library. -
Method Summary
Modifier and TypeMethodDescriptionstatic AntCommandFailureReason
create
(int rawValue) Used internally by the API to create a failure reason received from ANT Radio Service.int
Returns the raw value of this enumeration value.static AntCommandFailureReason
Returns the enum constant of this class with the specified name.static AntCommandFailureReason[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
UNKNOWN
The service sent a failure not defined in this version of the library.- Since:
- 4.0
-
IO_ERROR
There was a failure communicating with the ANT hardware. The channel will be released.- Since:
- 4.0
-
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 theIAntChannelEventHandler
.- Since:
- 4.0
-
CHANNEL_RELEASING
The channel is releasing, and is no longer acquired by this application.- Since:
- 4.0
-
INVALID_REQUEST
The attempted operation is not valid for this channel in its current state.- Since:
- 4.0
-
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
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
Another channel is already performing a background scan.- Since:
- 4.0
-
CANCELLED
The blocking operation was interrupted.- Since:
- 4.0
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- 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
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
-