ReadWriteListener.ReadWriteEvent

java.lang.Object
- com.idevicesinc.sweetblue.utils.Event
- - com.idevicesinc.sweetblue.ReadWriteListener.ReadWriteEvent

All Implemented Interfaces:

UsesCustomNull

Enclosing interface:

ReadWriteListener
```
public static class ReadWriteListener.ReadWriteEvent
extends Event
implements UsesCustomNull
```
Provides a bunch of information about a completed read or write.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.UUID`	`NON_APPLICABLE_UUID` Value used in place of `null`, either indicating that `descUuid()` isn't used for the `ReadWriteListener.ReadWriteEvent` because `target()` is `ReadWriteListener.Target.CHARACTERISTIC`, or that both `descUuid()` and `charUuid()` aren't applicable because `target()` is `ReadWriteListener.Target.RSSI`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BleCharacteristic`	`characteristic()` Forwards `BleNode.getNativeBleCharacteristic(UUID, UUID)`, which will be nonnull if `target()` is `ReadWriteListener.Target.CHARACTERISTIC` or `ReadWriteListener.Target.DESCRIPTOR`.
`java.util.UUID`	`charUuid()` The `UUID` of the characteristic associated with this `ReadWriteListener.ReadWriteEvent`.
`BleConnectionPriority`	`connectionPriority()` This value gets set as a result of a `BleDevice.setConnectionPriority(BleConnectionPriority, ReadWriteListener)` call.
`byte`	`data_byte()` Returns the first byte from `data()`, or 0x0 if not available.
`int`	`data_int(boolean reverse)` Convenience method that attempts to parse `data()` as an int.
`long`	`data_long(boolean reverse)` Convenience method that attempts to parse `data()` as a long.
`short`	`data_short(boolean reverse)` Convenience method that attempts to parse `data()` as a short.
`java.lang.String`	`data_string()` Best effort parsing of `data()` as a `String`.
`java.lang.String`	`data_string(java.lang.String charset)` Convenience method that attempts to parse `data()` as a `String` with the given charset, for example `"UTF-8"`.
`java.lang.String`	`data_utf8()` Convenience method that attempts to parse the data as a UTF-8 string.
`byte[]`	`data()` The data sent to the peripheral if `type()` `ReadWriteListener.Type.isWrite()`, otherwise the data received from the peripheral if `type()` `ReadWriteListener.Type.isRead()`.
`BleDescriptor`	`descriptor()` Forwards `BleNode.getNativeBleDescriptor_inChar(UUID, UUID)`, which will be nonnull if `target()` is `ReadWriteListener.Target.DESCRIPTOR`.
`DescriptorFilter`	`descriptorFilter()` This is the `DescriptorFilter` that was used for this read/write operation, if any.
`java.util.UUID`	`descUuid()` The `UUID` of the descriptor associated with this `ReadWriteListener.ReadWriteEvent`.
`BleDevice`	`device()` The `BleDevice` this `ReadWriteListener.ReadWriteEvent` is for.
`int`	`gattStatus()` The native gatt status returned from the stack, if applicable.
`boolean`	`isNull()` Forwards `ReadWriteListener.Type.isNull()`.
`boolean`	`isRead()` Forwards `ReadWriteListener.Type.isRead()`.
`boolean`	`isWrite()` Forwards `ReadWriteListener.Type.isWrite()`.
`java.lang.String`	`macAddress()` Convience to return the mac address of `device()`.
`int`	`mtu()` This value gets set as a result of a `BleDevice.negotiateMtu(int, ReadWriteListener)` call.
`Phy`	`phy()`
`int`	`rssi()` This value gets updated as a result of a `BleDevice.readRssi(ReadWriteListener)` call.
`BleService`	`service()` Forwards `BleNode.getNativeBleService(UUID)`, which will be nonnull if `target()` is `ReadWriteListener.Target.CHARACTERISTIC` or `ReadWriteListener.Target.DESCRIPTOR`.
`java.util.UUID`	`serviceUuid()` The `UUID` of the service associated with this `ReadWriteListener.ReadWriteEvent`.
`boolean`	`solicited()` This returns `true` if this event was the result of an explicit call through SweetBlue, e.g.
`ReadWriteListener.Status`	`status()` Indicates either success or the type of failure.
`ReadWriteListener.Target`	`target()` The type of GATT object this `ReadWriteListener.ReadWriteEvent` is for, currently characteristic, descriptor, or rssi.
`Interval`	`time_ota()` Time spent "over the air" - so in the native stack, processing in the peripheral's embedded software, what have you.
`Interval`	`time_total()` Total time it took for the operation to complete, whether success or failure.
`java.lang.String`	`toString()`
`ReadWriteListener.Type`	`type()` The type of operation, read, write, etc.
`boolean`	`wasCancelled()` Forwards `ReadWriteListener.Status.wasCancelled()`.
`boolean`	`wasSuccess()` Convenience method for checking if `status()` equals `ReadWriteListener.Status.SUCCESS`.

Methods inherited from class com.idevicesinc.sweetblue.utils.Event
isFor, isForAll, isForAny

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NON_APPLICABLE_UUID
```
public static final java.util.UUID NON_APPLICABLE_UUID
```
    Value used in place of null, either indicating that descUuid() isn't used for the ReadWriteListener.ReadWriteEvent because target() is ReadWriteListener.Target.CHARACTERISTIC, or that both descUuid() and charUuid() aren't applicable because target() is ReadWriteListener.Target.RSSI.
- Method Detail
  - device
```
public final BleDevice device()
```
    The BleDevice this ReadWriteListener.ReadWriteEvent is for.
  - macAddress
```
public final java.lang.String macAddress()
```
    Convience to return the mac address of device().
  - type
```
public final ReadWriteListener.Type type()
```
    The type of operation, read, write, etc.
  - target
```
public final ReadWriteListener.Target target()
```
    The type of GATT object this ReadWriteListener.ReadWriteEvent is for, currently characteristic, descriptor, or rssi.
  - serviceUuid
```
public final java.util.UUID serviceUuid()
```
    The UUID of the service associated with this ReadWriteListener.ReadWriteEvent. This will always be a non-null UUID, even if target() is ReadWriteListener.Target.DESCRIPTOR. If target() is ReadWriteListener.Target.RSSI then this will be referentially equal (i.e. you can use == to compare) to NON_APPLICABLE_UUID.
  - charUuid
```
public final java.util.UUID charUuid()
```
    The UUID of the characteristic associated with this ReadWriteListener.ReadWriteEvent. This will always be a non-null UUID, even if target() is ReadWriteListener.Target.DESCRIPTOR. If target() is ReadWriteListener.Target.RSSI then this will be referentially equal (i.e. you can use == to compare) to NON_APPLICABLE_UUID.
  - descUuid
```
public final java.util.UUID descUuid()
```
    The UUID of the descriptor associated with this ReadWriteListener.ReadWriteEvent. If target() is ReadWriteListener.Target.CHARACTERISTIC or ReadWriteListener.Target.RSSI then this will be referentially equal (i.e. you can use == to compare) to NON_APPLICABLE_UUID.
  - data
```
public final byte[] data()
```
    The data sent to the peripheral if type() ReadWriteListener.Type.isWrite(), otherwise the data received from the peripheral if type() ReadWriteListener.Type.isRead(). This will never be null. For error cases it will be a zero-length array.
  - phy
```
public final Phy phy()
```
  - rssi
```
public final int rssi()
```
    This value gets updated as a result of a BleDevice.readRssi(ReadWriteListener) call. It will always be equivalent to BleDevice.getRssi() but is included here for convenience.
    
    See Also:
    
    BleDevice.getRssi(), BleDevice.getRssiPercent(), BleDevice.getDistance()
  - mtu
```
public final int mtu()
```
    This value gets set as a result of a BleDevice.negotiateMtu(int, ReadWriteListener) call. The value returned will be the same as that given to BleDevice.negotiateMtu(int, ReadWriteListener), which means it will be the same as BleDevice.getMtu() if status() equals ReadWriteListener.Status.SUCCESS.
    
    See Also:
    
    BleDevice.getMtu()
  - status
```
public final ReadWriteListener.Status status()
```
    Indicates either success or the type of failure. Some values of ReadWriteListener.Status are not used for certain values of ReadWriteListener.Type.
  - time_ota
```
public final Interval time_ota()
```
    Time spent "over the air" - so in the native stack, processing in the peripheral's embedded software, what have you. This will always be slightly less than time_total().
  - time_total
```
public final Interval time_total()
```
    Total time it took for the operation to complete, whether success or failure. This mainly includes time spent in the internal job queue plus time_ota(). This will always be longer than time_ota(), though usually only slightly so.
  - gattStatus
```
public final int gattStatus()
```
    The native gatt status returned from the stack, if applicable. If the status() returned is, for example, ReadWriteListener.Status.NO_MATCHING_TARGET, then the operation didn't even reach the point where a gatt status is provided, in which case this member is set to BleStatuses.GATT_STATUS_NOT_APPLICABLE (value of -1). Otherwise it will be 0 for success or greater than 0 when there's an issue. Generally this value will only be meaningful when status() is ReadWriteListener.Status.SUCCESS or ReadWriteListener.Status.REMOTE_GATT_FAILURE. There are also some cases where this will be 0 for success but status() is for example ReadWriteListener.Status.NULL_DATA - in other words the underlying stack deemed the operation a success but SweetBlue disagreed. For this reason it's recommended to treat this value as a debugging tool and use status() for actual application logic if possible.
    
    See BluetoothGatt for its static GATT_* status code members. Also see the source code of BleStatuses for SweetBlue's more comprehensive internal reference list of gatt status values. This list may not be totally accurate or up-to-date, nor may it match GATT_ values used by the bluetooth stack on your phone.
  - solicited
```
public final boolean solicited()
```
    This returns true if this event was the result of an explicit call through SweetBlue, e.g. through BleDevice.read(UUID), BleDevice.write(UUID, byte[]), etc. It will return false otherwise, which can happen if for example you use BleDevice.getNativeGatt() to bypass SweetBlue for whatever reason. Another theoretical case is if you make an explicit call through SweetBlue, then you get ReadWriteListener.Status.TIMED_OUT, but then the native stack eventually *does* come back with something - this has never been observed, but it is possible.
  - connectionPriority
```
public final BleConnectionPriority connectionPriority()
```
    This value gets set as a result of a BleDevice.setConnectionPriority(BleConnectionPriority, ReadWriteListener) call. The value returned will be the same as that given to BleDevice.setConnectionPriority(BleConnectionPriority, ReadWriteListener), which means it will be the same as BleDevice.getConnectionPriority() if status() equals ReadWriteListener.Status.SUCCESS.
    
    See Also:
    
    BleDevice.getConnectionPriority()
  - descriptorFilter
```
public final DescriptorFilter descriptorFilter()
```
    This is the DescriptorFilter that was used for this read/write operation, if any.
  - service
```
public final BleService service()
```
    Forwards BleNode.getNativeBleService(UUID), which will be nonnull if target() is ReadWriteListener.Target.CHARACTERISTIC or ReadWriteListener.Target.DESCRIPTOR.
  - characteristic
```
public final BleCharacteristic characteristic()
```
    Forwards BleNode.getNativeBleCharacteristic(UUID, UUID), which will be nonnull if target() is ReadWriteListener.Target.CHARACTERISTIC or ReadWriteListener.Target.DESCRIPTOR.
  - descriptor
```
public final BleDescriptor descriptor()
```
    Forwards BleNode.getNativeBleDescriptor_inChar(UUID, UUID), which will be nonnull if target() is ReadWriteListener.Target.DESCRIPTOR.
  - wasSuccess
```
public final boolean wasSuccess()
```
    Convenience method for checking if status() equals ReadWriteListener.Status.SUCCESS.
  - wasCancelled
```
public final boolean wasCancelled()
```
    Forwards ReadWriteListener.Status.wasCancelled().
  - isRead
```
public final boolean isRead()
```
    Forwards ReadWriteListener.Type.isRead().
  - isWrite
```
public final boolean isWrite()
```
    Forwards ReadWriteListener.Type.isWrite().
  - data_byte
```
public final byte data_byte()
```
    Returns the first byte from data(), or 0x0 if not available.
  - data_utf8
```
public final java.lang.String data_utf8()
```
    Convenience method that attempts to parse the data as a UTF-8 string.
  - data_string
```
public final java.lang.String data_string()
```
    Best effort parsing of data() as a String. For now simply forwards data_utf8(). In the future may try to autodetect encoding first.
  - data_string
```
public final java.lang.String data_string(java.lang.String charset)
```
    Convenience method that attempts to parse data() as a String with the given charset, for example "UTF-8".
  - data_int
```
public final int data_int(boolean reverse)
```
    Convenience method that attempts to parse data() as an int.
    
    Parameters:
    
    reverse - - Set to true if you are connecting to a device with ByteOrder.BIG_ENDIAN byte order, to automatically reverse the bytes before conversion.
  - data_short
```
public final short data_short(boolean reverse)
```
    Convenience method that attempts to parse data() as a short.
    
    Parameters:
    
    reverse - - Set to true if you are connecting to a device with ByteOrder.BIG_ENDIAN byte order, to automatically reverse the bytes before conversion.
  - data_long
```
public final long data_long(boolean reverse)
```
    Convenience method that attempts to parse data() as a long.
    
    Parameters:
    
    reverse - - Set to true if you are connecting to a device with ByteOrder.BIG_ENDIAN byte order, to automatically reverse the bytes before conversion.
  - isNull
```
public final boolean isNull()
```
    Forwards ReadWriteListener.Type.isNull().
    
    Specified by:
    
    isNull in interface UsesCustomNull
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ReadWriteListener.ReadWriteEvent

Field Summary

Method Summary

Methods inherited from class com.idevicesinc.sweetblue.utils.Event

Methods inherited from class java.lang.Object

Field Detail

NON_APPLICABLE_UUID

Method Detail

device

macAddress

type

target

serviceUuid

charUuid

descUuid

data

phy

rssi

mtu

status

time_ota

time_total

gattStatus

solicited

connectionPriority

descriptorFilter

service

characteristic

descriptor

wasSuccess

wasCancelled

isRead

isWrite

data_byte

data_utf8

data_string

data_string

data_int

data_short

data_long

isNull

toString