com.polidea.rxandroidble2.internal

Class QueueOperation<T>

java.lang.Object

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

Type Parameters:

T - What is returned from this operation onNext()

All Implemented Interfaces:

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

Direct Known Subclasses:

CharacteristicLongWriteOperation, ConnectOperation, DisconnectOperation, ScanOperation, SingleResponseOperation

public abstract class QueueOperation<T>
extends java.lang.Object
implements Operation<T>

The base class for all operations that are executed on the Bluetooth Queue. This class is intended to be a kind of wrapper over an Observable (returned by function run(QueueReleaseInterface)). Implements Operation.run(QueueReleaseInterface) interface which will be subscribed and unsubscribed on the application's main thread.

Constructor Summary

Constructors

Constructor and Description
QueueOperation()

Method Summary

Modifier and Type	Method and Description
int	compareTo(Operation another) The function for determining which position in Bluetooth Radio's Priority Blocking Queue this operation should take
Priority	definedPriority() A function returning the priority of this operation
protected abstract void	protectedRun(<any> emitter, QueueReleaseInterface queueReleaseInterface) This method must be overridden in a concrete operation implementations and should contain specific operation logic.
protected abstract BleException	provideException(android.os.DeadObjectException deadObjectException) This function will be overridden in concrete operation implementations to provide an exception with needed context
<any>	run(QueueReleaseInterface queueReleaseInterface) A function that returns this operation as an Observable.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueueOperation

public QueueOperation()

Method Detail

run

public final <any> run(QueueReleaseInterface queueReleaseInterface)

A function that returns this operation as an Observable. When the returned observable is subscribed, this operation will be scheduled to be run on the main thread. When appropriate the call to run() will be executed. This operation is expected to call releaseRadio() at appropriate point after the run() was called.

Specified by:

run in interface Operation<T>

protectedRun

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

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.

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

provideException

protected abstract BleException provideException(android.os.DeadObjectException deadObjectException)

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

Parameters:

deadObjectException - the cause for the exception

definedPriority

public Priority definedPriority()

A function returning the priority of this operation

Specified by:

definedPriority in interface Operation<T>

Returns:

the priority of this operation

compareTo

public int compareTo(Operation another)

The function for determining which position in Bluetooth Radio's Priority Blocking Queue this operation should take

Specified by:

compareTo in interface java.lang.Comparable<Operation<?>>

Parameters:

another - another operation

Returns:

the comparison result