Class BurstState

java.lang.Object
com.dsi.ant.channel.BurstState
All Implemented Interfaces:
android.os.Parcelable

public final class BurstState extends Object implements android.os.Parcelable
The status of burst transfers (transmit or receive) on this ANT adapter. Only one channel can request a burst transmit or process a burst at a time. Attempted bursts must not exceed the maximum size at the time they are requested.
Since:
4.0
  • Nested Class Summary

    Nested classes/interfaces inherited from interface android.os.Parcelable

    android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final android.os.Parcelable.Creator<BurstState>
    For Parcelable

    Fields inherited from interface android.os.Parcelable

    CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
  • Method Summary

    Modifier and Type
    Method
    Description
    int
     
    boolean
     
    int
    The maximum allowed burst transfer size.
    int
     
    boolean
    Is a burst transfer currently occurring.
    boolean
    Has any channel on this adapter (in use by any application) initiated a burst transfer.
     
    void
    writeToParcel(android.os.Parcel dest, int flags)
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • CREATOR

      public static final android.os.Parcelable.Creator<BurstState> CREATOR
      For Parcelable
  • Method Details

    • isProcessing

      public boolean isProcessing()
      Is a burst transfer currently occurring. At this time only the bursting channel will be able to send or receive data, all other channels are blocked.
      Returns:
      True if any channel, on the adapter this channel is on, is actively transferring burst data.
      Since:
      4.0
    • isTransmitInProgress

      public boolean isTransmitInProgress()
      Has any channel on this adapter (in use by any application) initiated a burst transfer.
      Returns:
      True if a transmit is pending or processing.
      Since:
      4.0
    • getMaxBurstSize

      public int getMaxBurstSize()
      The maximum allowed burst transfer size. Transferring bursts larger than this value will drastically impact other channels and is prohibited.
      Returns:
      The maximum number of bytes allowed for a burst transfer
      Since:
      4.1
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
      Since:
      4.0
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
      Since:
      4.0
    • toString

      public String toString()
      Overrides:
      toString in class Object
      Since:
      4.0
    • describeContents

      public int describeContents()
      Specified by:
      describeContents in interface android.os.Parcelable
    • writeToParcel

      public void writeToParcel(android.os.Parcel dest, int flags)
      Specified by:
      writeToParcel in interface android.os.Parcelable