com.polidea.rxandroidble2.internal

Class SingleResponseOperation<T>

java.lang.Object

com.polidea.rxandroidble2.internal.QueueOperation<T>

com.polidea.rxandroidble2.internal.SingleResponseOperation<T>

Type Parameters:

T - The type of emitted result.

All Implemented Interfaces:

Operation<T>, java.lang.Comparable<Operation<?>>

Direct Known Subclasses:

CharacteristicReadOperation, CharacteristicWriteOperation, ConnectionPriorityChangeOperation, DescriptorReadOperation, DescriptorWriteOperation, MtuRequestOperation, ReadRssiOperation, ServiceDiscoveryOperation

public abstract class SingleResponseOperation<T>
extends QueueOperation<T>

A convenience class intended to use with BluetoothGatt functions that fire one-time actions.

Constructor Summary

Constructors

Constructor and Description
SingleResponseOperation(android.bluetooth.BluetoothGatt bluetoothGatt, RxBleGattCallback rxBleGattCallback, BleGattOperationType gattOperationType, TimeoutConfiguration timeoutConfiguration)

Method Summary

Modifier and Type	Method and Description
protected abstract <any>	getCallback(RxBleGattCallback rxBleGattCallback) A function that should return Observable derived from the passed RxBleGattCallback.
protected void	protectedRun(<any> emitter, QueueReleaseInterface queueReleaseInterface) This method must be overridden in a concrete operation implementations and should contain specific operation logic.
protected BleException	provideException(android.os.DeadObjectException deadObjectException) This function will be overridden in concrete operation implementations to provide an exception with needed context
protected abstract boolean	startOperation(android.bluetooth.BluetoothGatt bluetoothGatt) A function that should call the passed BluetoothGatt and return `true` if the call has succeeded.
protected <any>	timeoutFallbackProcedure(android.bluetooth.BluetoothGatt bluetoothGatt, RxBleGattCallback rxBleGattCallback, Scheduler timeoutScheduler)
java.lang.String	toString()

Methods inherited from class com.polidea.rxandroidble2.internal.QueueOperation

compareTo, definedPriority, run

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleResponseOperation

public SingleResponseOperation(android.bluetooth.BluetoothGatt bluetoothGatt,
                               RxBleGattCallback rxBleGattCallback,
                               BleGattOperationType gattOperationType,
                               TimeoutConfiguration timeoutConfiguration)

Method Detail

protectedRun

protected final void protectedRun(<any> emitter,
                                  QueueReleaseInterface queueReleaseInterface)
                           throws java.lang.Throwable

Description copied from class: QueueOperation

This method must be overridden in a concrete operation implementations and should contain specific operation logic. Implementations should call emitter methods to inform the outside world about emissions of `onNext()`/`onError()`/`onCompleted()`. Implementations must call QueueReleaseInterface.release() at appropriate point to release the queue for any other operations that are queued. If the emitter is cancelled, a responsibility of the operation is to call QueueReleaseInterface.release(). The radio should be released as soon as the operation decides it won't interact with the BluetoothGatt anymore and subsequent operations will be able to start. Check usage of QueueReleasingEmitterWrapper for convenience.

Specified by:

protectedRun in class QueueOperation<T>

Parameters:

emitter - the emitter to be called in order to inform the caller about the output of a particular run of the operation

queueReleaseInterface - the queue release interface to release the queue when ready

Throws:

java.lang.Throwable

getCallback

protected abstract <any> getCallback(RxBleGattCallback rxBleGattCallback)

A function that should return Observable derived from the passed RxBleGattCallback. The returned Observable will be automatically unsubscribed after the first emission. The returned Observable is a subject to Observable#timeout(long, TimeUnit, Scheduler, io.reactivex.ObservableSource) and by default it will throw BleGattCallbackTimeoutException. This behaviour can be overridden by overriding timeoutFallbackProcedure(BluetoothGatt, RxBleGattCallback, Scheduler).

Parameters:

rxBleGattCallback - the RxBleGattCallback to use

Returns:

the Observable

startOperation

protected abstract boolean startOperation(android.bluetooth.BluetoothGatt bluetoothGatt)

A function that should call the passed BluetoothGatt and return `true` if the call has succeeded.

Parameters:

bluetoothGatt - the BluetoothGatt to use

Returns:

`true` if success, `false` otherwise

timeoutFallbackProcedure

protected <any> timeoutFallbackProcedure(android.bluetooth.BluetoothGatt bluetoothGatt,
                                         RxBleGattCallback rxBleGattCallback,
                                         Scheduler timeoutScheduler)

provideException

protected BleException provideException(android.os.DeadObjectException deadObjectException)

Description copied from class: QueueOperation

This function will be overridden in concrete operation implementations to provide an exception with needed context

Specified by:

provideException in class QueueOperation<T>

Parameters:

deadObjectException - the cause for the exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object