com.polidea.rxandroidble2

Class ConnectionSetup.Builder

java.lang.Object

com.polidea.rxandroidble2.ConnectionSetup.Builder

Enclosing class:

ConnectionSetup

public static class ConnectionSetup.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ConnectionSetup	build()
ConnectionSetup.Builder	setAutoConnect(boolean autoConnect) Autoconnect concept may be misleading at first glance.
ConnectionSetup.Builder	setOperationTimeout(Timeout operationTimeout)
ConnectionSetup.Builder	setSuppressIllegalOperationCheck(boolean suppressOperationCheck)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setAutoConnect

public ConnectionSetup.Builder setAutoConnect(boolean autoConnect)

Autoconnect concept may be misleading at first glance. In cases when the BLE device is available and it is advertising constantly you won't need to use autoconnect. Use autoconnect for connections where the BLE device is not advertising at the moment of RxBleDevice#establishConnection(ConnectionSetup) call.

Parameters:

autoConnect - Flag related to BluetoothDevice.connectGatt(Context, boolean, BluetoothGattCallback) autoConnect flag. In case of auto connect is enabled the observable will wait with the emission of RxBleConnection. Without auto connect flag set to true the connection will fail with BleGattException if the device is not in range after a 30 seconds timeout.

Returns:

this builder instance

setSuppressIllegalOperationCheck

public ConnectionSetup.Builder setSuppressIllegalOperationCheck(boolean suppressOperationCheck)

Parameters:

suppressOperationCheck - Flag describing the method of operation viability checking. If set to false, a BleIllegalOperationException will be emitted every time properties of the characteristic don't match those required by the operation. If set to true, an event will be logged without interrupting the execution.

Returns:

this builder instance

setOperationTimeout

public ConnectionSetup.Builder setOperationTimeout(Timeout operationTimeout)

Parameters:

operationTimeout - Timeout after which the operation will be considered as broken. Eventually the operation will be canceled and removed from queue. Keep in mind that it will cancel the library's operation only and may leave Android's BLE stack in an inconsistent state.

Returns:

this builder instance

build

public ConnectionSetup build()