com.idevicesinc.sweetblue.rx

Class RxBleTransaction

java.lang.Object

com.idevicesinc.sweetblue.rx.RxBleTransaction

All Implemented Interfaces:

P_ITransaction

Direct Known Subclasses:

RxBleTransaction.RxAuth, RxBleTransaction.RxInit, RxBleTransaction.RxOta

public abstract class RxBleTransaction
extends java.lang.Object
implements P_ITransaction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RxBleTransaction.RxAuth
static class	RxBleTransaction.RxInit
static class	RxBleTransaction.RxOta

Nested classes/interfaces inherited from interface com.idevicesinc.sweetblue.P_ITransaction

P_ITransaction.Type

Constructor Summary

Constructors

Constructor and Description
RxBleTransaction()

Method Summary

Modifier and Type	Method and Description
void	cancel()
<any>	disableNotifies(java.util.List<BleNotify> notifies) Forwards to RxBleDevice.disableNotifies(List)
<any>	disableNotify(BleNotify notify) Forwards to RxBleDevice.disableNotify(BleNotify)
<any>	enableNotifies(java.util.List<BleNotify> notifies) Forwards to RxBleDevice.enableNotifies(List)
<any>	enableNotify(BleNotify notify) Forwards to RxBleDevice.enableNotify(BleNotify)
boolean	fail() Call this from subclasses to indicate that the transaction has failed.
protected BleTransaction.Atomicity	getAtomicity() Default is Boolean.FALSE.
RxBleDevice	getDevice() Returns the device this transaction is running on.
double	getTime() Returns the total time that this transaction has been running.
P_ITransaction.Type	getTransactionType()
boolean	isRunning() Returns whether the transaction is currently running.
protected void	onEnd(BleTransaction.EndReason reason) Called when a transaction ends, either due to the transaction itself finishing itself through fail() or succeed(), or from the library implicitly ending the transaction, for example if getDevice() becomes BleDeviceState.BLE_DISCONNECTED.
<any>	read(BleDescriptorRead read) Forwards to RxBleDevice.read(BleDescriptorRead)
<any>	read(BleRead read) Forwards to RxBleDevice.read(BleRead)
<any>	readMany(BleRead[] bleReads) Forwards to BleDevice.readMany(BleRead[])
<any>	readMany(java.lang.Iterable<BleRead> bleReads) Forwards to BleDevice.readMany(Iterable)
<any>	readPhyOptions() Forwards to RxBleDevice.readPhyOptions()
<any>	readRssi() Forwards to RxBleDevice.readRssi()
<any>	setConnectionPriority(BleConnectionPriority connectionPriority) Forwards to RxBleDevice.setConnectionPriority(BleConnectionPriority)
<any>	setMtu(int mtu) Forwards to RxBleDevice.negotiateMtu(int)
<any>	setMtuToDefault() Forwards to RxBleDevice.negotiateMtuToDefault()
<any>	setPhyOptions(Phy phyOptions) Forwards to RxBleDevice.setPhyOptions(Phy)
protected abstract void	start()
boolean	succeed() Call this from subclasses to indicate that the transaction has succeeded.
protected void	update(double timeStep) Optional convenience method to override if you want to do periodic updates or time-based calculations.
<any>	write(BleDescriptorWrite write) Forwards to RxBleDevice.write(BleDescriptorWrite)
<any>	write(BleWrite write) Forwards to RxBleDevice.write(BleWrite)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RxBleTransaction

public RxBleTransaction()

Method Detail

start

protected abstract void start()

getTransactionType

public P_ITransaction.Type getTransactionType()

Specified by:

getTransactionType in interface P_ITransaction

update

protected void update(double timeStep)

Optional convenience method to override if you want to do periodic updates or time-based calculations.

onEnd

protected void onEnd(BleTransaction.EndReason reason)

Called when a transaction ends, either due to the transaction itself finishing itself through fail() or succeed(), or from the library implicitly ending the transaction, for example if getDevice() becomes BleDeviceState.BLE_DISCONNECTED. Override this method to wrap up any loose ends or notify UI or what have you.

getAtomicity

protected BleTransaction.Atomicity getAtomicity()

Default is Boolean.FALSE. Optionally override if you want your transaction's reads/writes to execute "atomically". This means that if you're connected to multiple devices only the reads/writes of this transaction's device will be executed until this transaction is finished.

getDevice

public RxBleDevice getDevice()

Returns the device this transaction is running on.

isRunning

public boolean isRunning()

Returns whether the transaction is currently running.

cancel

public void cancel()

fail

public boolean fail()

Call this from subclasses to indicate that the transaction has failed. Usually you call this in your GenericListener_Void.onEvent(Event) when ReadWriteListener.Status is something other than ReadWriteListener.Status.SUCCESS. If you do so, DeviceReconnectFilter.ConnectFailEvent.txnFailReason() will be set.

Returns:

false if the transaction wasn't running to begin with.

succeed

public boolean succeed()

Call this from subclasses to indicate that the transaction has succeeded.

Returns:

Boolean.FALSE if the transaction wasn't running to begin with.

getTime

public double getTime()

Returns the total time that this transaction has been running. You can use this in update(double) for example to fail() or succeed() a transaction that has taken longer than a certain amount of time.

See Also:

BleTransaction.update(double)

read

public final <any> read(BleRead read)

Forwards to RxBleDevice.read(BleRead)

readMany

public final <any> readMany(BleRead[] bleReads)

Forwards to BleDevice.readMany(BleRead[])

readMany

public final <any> readMany(java.lang.Iterable<BleRead> bleReads)

Forwards to BleDevice.readMany(Iterable)

enableNotifies

public final <any> enableNotifies(java.util.List<BleNotify> notifies)

Forwards to RxBleDevice.enableNotifies(List)

enableNotify

public final <any> enableNotify(BleNotify notify)

Forwards to RxBleDevice.enableNotify(BleNotify)

disableNotify

public final <any> disableNotify(BleNotify notify)

Forwards to RxBleDevice.disableNotify(BleNotify)

disableNotifies

public final <any> disableNotifies(java.util.List<BleNotify> notifies)

Forwards to RxBleDevice.disableNotifies(List)

write

public final <any> write(BleWrite write)

Forwards to RxBleDevice.write(BleWrite)

write

public final <any> write(BleDescriptorWrite write)

Forwards to RxBleDevice.write(BleDescriptorWrite)

read

public final <any> read(BleDescriptorRead read)

Forwards to RxBleDevice.read(BleDescriptorRead)

readRssi

public final <any> readRssi()

Forwards to RxBleDevice.readRssi()

setConnectionPriority

public final <any> setConnectionPriority(BleConnectionPriority connectionPriority)

Forwards to RxBleDevice.setConnectionPriority(BleConnectionPriority)

setMtuToDefault

public final <any> setMtuToDefault()

Forwards to RxBleDevice.negotiateMtuToDefault()

setMtu

public final <any> setMtu(int mtu)

Forwards to RxBleDevice.negotiateMtu(int)

setPhyOptions

public final <any> setPhyOptions(Phy phyOptions)

Forwards to RxBleDevice.setPhyOptions(Phy)

readPhyOptions

public final <any> readPhyOptions()

Forwards to RxBleDevice.readPhyOptions()