com.polidea.rxandroidble2.internal.operations

Class ScanOperation<SCAN_RESULT_TYPE,SCAN_CALLBACK_TYPE>

java.lang.Object

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

com.polidea.rxandroidble2.internal.operations.ScanOperation<SCAN_RESULT_TYPE,SCAN_CALLBACK_TYPE>

Type Parameters:

SCAN_RESULT_TYPE - Type of the objects that the QueueOperation should emit

SCAN_CALLBACK_TYPE - Type of the BLE scan callback used by a particular implementation

All Implemented Interfaces:

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

Direct Known Subclasses:

LegacyScanOperation, ScanOperationApi18, ScanOperationApi21

public abstract class ScanOperation<SCAN_RESULT_TYPE,SCAN_CALLBACK_TYPE>
extends QueueOperation<SCAN_RESULT_TYPE>

A class that handles starting and stopping BLE scans.

Method Summary

Modifier and Type	Method and Description
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

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, toString, wait, wait, wait

Method Detail

protectedRun

protected final void protectedRun(<any> emitter,
                                  QueueReleaseInterface queueReleaseInterface)

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<SCAN_RESULT_TYPE>

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

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<SCAN_RESULT_TYPE>

Parameters:

deadObjectException - the cause for the exception