All Implemented Interfaces:: com.polar.androidcommunications.api.ble.model.gatt.BleGattTxInterface


public final class BDDeviceSessionImpl
extends BleDeviceSession implements BleGattTxInterface

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private BluetoothDevice`	`bluetoothDevice`
`private final Object`	`gattMutex`
`private Job`	`serviceDiscovery`
`private BluetoothGatt`	`gatt`
`private final AtomicSet<Channel<Integer>>`	`rssiObservers`
`private final Boolean`	`isNonConnectableAdvertisement`
`private final String`	`address`
`private final Boolean`	`isAuthenticated`
`private final Boolean`	`isAuthenticationNeeded`
`private Boolean`	`directConnect`
`private Integer`	`directConnectRetryCount`
`private Integer`	`consecutiveNoCallbackConnects`
`private Long`	`nextConnectAllowedTimeMs`
`private volatile Boolean`	`pendingWatchdogCancel`
`private final BleDeviceSession.DisconnectReason`	`disconnectReason`
`private final Integer`	`disconnectStatus`
`private final Boolean`	`isIntentionalDisconnect`
`private final Long`	`deviceCommandDisconnectDeadlineMs`
`private final BleDeviceSession.DeviceCommand`	`pendingDeviceCommand`
`private final Boolean`	`wasBondedAtConnection`
`private final Boolean`	`hasEstablishedBond`
`private final Integer`	`securityRecoveryAttempts`
`private final Boolean`	`securityRecoveryExhausted`
`private BleDeviceSession.DeviceSessionState`	`sessionState`
`private final BleDeviceSession.DeviceSessionState`	`previousState`
`private BleAdvertisementContent`	`advertisementContent`
`private final BleAdvertisementContent`	`getAdvertisementContent`
`private List<String>`	`connectionUuids`
`private final Boolean`	`isConnectableAdvertisement`
`private final String`	`name`
`private final String`	`polarDeviceId`
`private final String`	`polarDeviceType`
`private final Long`	`polarDeviceIdInt`
`private final Integer`	`medianRssi`
`private final Integer`	`rssi`
`private final BlePolarHrAdvertisement`	`blePolarHrAdvertisement`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`BluetoothDevice`	`getBluetoothDevice()`
`Unit`	`setBluetoothDevice(BluetoothDevice bluetoothDevice)`
`final Object`	`getGattMutex()`
`final Job`	`getServiceDiscovery()`
`final Unit`	`setServiceDiscovery(Job serviceDiscovery)`
`final BluetoothGatt`	`getGatt()`
`final Unit`	`setGatt(BluetoothGatt gatt)`
`final AtomicSet<Channel<Integer>>`	`getRssiObservers()`
`Boolean`	`isNonConnectableAdvertisement()`
`String`	`getAddress()`
`Boolean`	`isAuthenticated()`
`final Boolean`	`isAuthenticationNeeded()`
`final Boolean`	`getDirectConnect()`	When true, this session was opened via connectToBondedDevice.
`final Unit`	`setDirectConnect(Boolean directConnect)`	When true, this session was opened via connectToBondedDevice.
`final Integer`	`getDirectConnectRetryCount()`	Number of consecutive auto-reconnect attempts made after the session dropped to SESSION_OPEN_PARK while directConnect is true.
`final Unit`	`setDirectConnectRetryCount(Integer directConnectRetryCount)`	Number of consecutive auto-reconnect attempts made after the session dropped to SESSION_OPEN_PARK while directConnect is true.
`final Integer`	`getConsecutiveNoCallbackConnects()`	Number of consecutive connects where the watchdog fired before onConnectionStateChange arrived (i.e.
`final Unit`	`setConsecutiveNoCallbackConnects(Integer consecutiveNoCallbackConnects)`	Number of consecutive connects where the watchdog fired before onConnectionStateChange arrived (i.e.
`final Long`	`getNextConnectAllowedTimeMs()`	Earliest System.currentTimeMillis() for the next advertisement-triggered connect.
`final Unit`	`setNextConnectAllowedTimeMs(Long nextConnectAllowedTimeMs)`	Earliest System.currentTimeMillis() for the next advertisement-triggered connect.
`final Boolean`	`getPendingWatchdogCancel()`	Set by the watchdog before calling disconnectDevice() so the handler can count this as a no-callback failure and apply backoff.
`final Unit`	`setPendingWatchdogCancel(Boolean pendingWatchdogCancel)`	Set by the watchdog before calling disconnectDevice() so the handler can count this as a no-callback failure and apply backoff.
`final Unit`	`resetGatt()`
`final Unit`	`setSessionStates(BleDeviceSession.DeviceSessionState sessionState)`	Internal use only
`final Unit`	`reset()`
`Unit`	`authenticate()`	start pairing and optionally bonding procedure with the device
`Boolean`	`clearGattCache()`
`Deferred<Integer>`	`readRssiValue()`
`Pair<Boolean, Integer>`	`getIndicatesPairingProblem()`	Checks if session indicates pairing problem.
`Unit`	`gattClientRequestStopScanning()`	gatt client requests to stop scanning, while there is some heavy attribute operation ongoing
`Unit`	`gattClientResumeScanning()`	gatt client has completed heavy attribute operation, and scanning can continue if needed
`Integer`	`transportQueueSize()`
`final Unit`	`handleDisconnection()`
`Unit`	`transmitMessages(UUID serviceUuid, UUID characteristicUuid, List<ByteArray> packets, Boolean withResponse)`
`Unit`	`transmitMessage(UUID serviceUuid, UUID characteristicUuid, ByteArray packet, Boolean withResponse)`
`Unit`	`readValue(UUID serviceUuid, UUID characteristicUuid)`
`Unit`	`setCharacteristicNotify(UUID serviceUuid, UUID characteristicUuid, Boolean enable)`
`Deferred<List<UUID>>`	`monitorServicesDiscovered(Boolean checkConnection)`	Monitor services discovered — suspends until services are discovered or disconnection occurs.
`Boolean`	`isConnected()`
`final Unit`	`handleServicesDiscovered()`
`final Unit`	`handleCharacteristicWrite(BluetoothGattService service, BluetoothGattCharacteristic characteristic, Integer status)`
`final Unit`	`handleCharacteristicRead(BluetoothGattService service, BluetoothGattCharacteristic characteristic, ByteArray value, Integer status)`
`final Unit`	`handleCharacteristicValueUpdated(BluetoothGattService service, BluetoothGattCharacteristic characteristic, ByteArray value)`
`final Unit`	`handleDescriptorRead(BluetoothGattDescriptor descriptor, ByteArray value, Integer status)`
`final Unit`	`handleDescriptorWrite(BluetoothGattService service, BluetoothGattCharacteristic characteristic, ByteArray value, Integer status)`
`final Unit`	`handleMtuChanged(Integer mtu, Integer status)`
`final Unit`	`handleAuthenticationComplete()`
`final Unit`	`processNextAttributeOperation(Boolean remove)`
`final Unit`	`handleRssiRead(Integer rssi, Integer status)`
`final Unit`	`resetDirectConnect()`
`final Integer`	`incrementDirectConnectRetryCount()`

Methods inherited from class com.polar.androidcommunications.api.ble.model.BleDeviceSession
clearDisconnectReason, clientsReady, fetchClient, getAdvertisementContent, getBlePolarHrAdvertisement, getConnectionUuids, getDeviceCommandDisconnectDeadlineMs, getDisconnectReason, getDisconnectStatus, getGetAdvertisementContent, getHasEstablishedBond, getMedianRssi, getName, getPendingDeviceCommand, getPolarDeviceId, getPolarDeviceIdInt, getPolarDeviceType, getPreviousState, getRssi, getSecurityRecoveryAttempts, getSecurityRecoveryExhausted, getSessionState, getWasBondedAtConnection, isAdvertising, isConnectableAdvertisement, isDeviceAlive, isExpectedDeviceCommandDisconnectStillValid, isIntentionalDisconnect, markBondedAtConnection, markDisconnect, markExpectedDeviceCommandDisconnect, markIntentionalDisconnect, recordSecurityRecoveryAttempt, setAdvertisementContent, setConnectionUuids, setSessionState
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getBluetoothDevice
```
 BluetoothDevice getBluetoothDevice()
```
    Returns:
    
    android bluetooth device instance
  - setBluetoothDevice
```
 Unit setBluetoothDevice(BluetoothDevice bluetoothDevice)
```
  - getGattMutex
```
 final Object getGattMutex()
```
  - getServiceDiscovery
```
 final Job getServiceDiscovery()
```
  - setServiceDiscovery
```
 final Unit setServiceDiscovery(Job serviceDiscovery)
```
  - getGatt
```
 final BluetoothGatt getGatt()
```
  - setGatt
```
 final Unit setGatt(BluetoothGatt gatt)
```
  - getRssiObservers
```
 final AtomicSet<Channel<Integer>> getRssiObservers()
```
  - isNonConnectableAdvertisement
```
 Boolean isNonConnectableAdvertisement()
```
    Returns:
    
    true if device is in non-connectable advertisement<BR></BR> Notes: Depending on Android API version,it's impossible to know this.<BR></BR> So this would work only for Polar Devices that follows Polar BLE Advertising data spec
  - getAddress
```
 String getAddress()
```
    Returns:
    
    bluetooth device address in string format
  - isAuthenticated
```
 Boolean isAuthenticated()
```
    Returns:
    
    true if session is bonded device
  - isAuthenticationNeeded
```
 final Boolean isAuthenticationNeeded()
```
  - getDirectConnect
```
 final Boolean getDirectConnect()
```
    When true, this session was opened via connectToBondedDevice. The library will retry the connection without waiting for an advertisement.
  - setDirectConnect
```
 final Unit setDirectConnect(Boolean directConnect)
```
    When true, this session was opened via connectToBondedDevice. The library will retry the connection without waiting for an advertisement.
  - getDirectConnectRetryCount
```
 final Integer getDirectConnectRetryCount()
```
    Number of consecutive auto-reconnect attempts made after the session dropped to SESSION_OPEN_PARK while directConnect is true. Reset to 0 each time connectToBondedDevice is called.
  - setDirectConnectRetryCount
```
 final Unit setDirectConnectRetryCount(Integer directConnectRetryCount)
```
    Number of consecutive auto-reconnect attempts made after the session dropped to SESSION_OPEN_PARK while directConnect is true. Reset to 0 each time connectToBondedDevice is called.
  - getConsecutiveNoCallbackConnects
```
 final Integer getConsecutiveNoCallbackConnects()
```
    Number of consecutive connects where the watchdog fired before onConnectionStateChange arrived (i.e. no OS callback).
  - setConsecutiveNoCallbackConnects
```
 final Unit setConsecutiveNoCallbackConnects(Integer consecutiveNoCallbackConnects)
```
    Number of consecutive connects where the watchdog fired before onConnectionStateChange arrived (i.e. no OS callback).
  - getNextConnectAllowedTimeMs
```
 final Long getNextConnectAllowedTimeMs()
```
    Earliest System.currentTimeMillis() for the next advertisement-triggered connect. 0 means no limit.
  - setNextConnectAllowedTimeMs
```
 final Unit setNextConnectAllowedTimeMs(Long nextConnectAllowedTimeMs)
```
    Earliest System.currentTimeMillis() for the next advertisement-triggered connect. 0 means no limit.
  - getPendingWatchdogCancel
```
 final Boolean getPendingWatchdogCancel()
```
    Set by the watchdog before calling disconnectDevice() so the handler can count this as a no-callback failure and apply backoff.
  - setPendingWatchdogCancel
```
 final Unit setPendingWatchdogCancel(Boolean pendingWatchdogCancel)
```
    Set by the watchdog before calling disconnectDevice() so the handler can count this as a no-callback failure and apply backoff.
  - resetGatt
```
 final Unit resetGatt()
```
  - setSessionStates
```
 final Unit setSessionStates(BleDeviceSession.DeviceSessionState sessionState)
```
    Internal use only
    
    Parameters:
    
    sessionState - @see BleDeviceSession.
  - reset
```
 final Unit reset()
```
  - authenticate
```
 Unit authenticate()
```
    start pairing and optionally bonding procedure with the device
    
    Returns:
    
    Either produces complete for already bonded device or starts pairing/bonding procedure or onError on failure case
  - clearGattCache
```
 Boolean clearGattCache()
```
    Returns:
    
    true if current gatt cache clear was ok
  - readRssiValue
```
 Deferred<Integer> readRssiValue()
```
    Returns:
    
    Deferred result for rssi values
  - getIndicatesPairingProblem
```
 Pair<Boolean, Integer> getIndicatesPairingProblem()
```
    Checks if session indicates pairing problem. This is a helper method to check if the session is in a state where pairing problems are likely, for example due to failed authentication attempts or other issues that may arise during the pairing process.
    
    Returns:
    
    Boolean indicating if the session indicates a pairing problem. True if there are indications of a pairing problem, false otherwise. Int value contains Bluetooth error code if there is a pairing problem, otherwise it is -1 (not set).
  - gattClientRequestStopScanning
```
 Unit gattClientRequestStopScanning()
```
    gatt client requests to stop scanning, while there is some heavy attribute operation ongoing
  - gattClientResumeScanning
```
 Unit gattClientResumeScanning()
```
    gatt client has completed heavy attribute operation, and scanning can continue if needed
  - transportQueueSize
```
 Integer transportQueueSize()
```
    Returns:
    
    current att operation queue size
  - handleDisconnection
```
 final Unit handleDisconnection()
```
  - transmitMessages
```
 Unit transmitMessages(UUID serviceUuid, UUID characteristicUuid, List<ByteArray> packets, Boolean withResponse)
```
  - transmitMessage
```
 Unit transmitMessage(UUID serviceUuid, UUID characteristicUuid, ByteArray packet, Boolean withResponse)
```
  - readValue
```
 Unit readValue(UUID serviceUuid, UUID characteristicUuid)
```
  - setCharacteristicNotify
```
 Unit setCharacteristicNotify(UUID serviceUuid, UUID characteristicUuid, Boolean enable)
```
  - monitorServicesDiscovered
```
 Deferred<List<UUID>> monitorServicesDiscovered(Boolean checkConnection)
```
    Monitor services discovered — suspends until services are discovered or disconnection occurs.
  - isConnected
```
 Boolean isConnected()
```
  - handleServicesDiscovered
```
 final Unit handleServicesDiscovered()
```
  - handleCharacteristicWrite
```
 final Unit handleCharacteristicWrite(BluetoothGattService service, BluetoothGattCharacteristic characteristic, Integer status)
```
  - handleCharacteristicRead
```
 final Unit handleCharacteristicRead(BluetoothGattService service, BluetoothGattCharacteristic characteristic, ByteArray value, Integer status)
```
  - handleCharacteristicValueUpdated
```
 final Unit handleCharacteristicValueUpdated(BluetoothGattService service, BluetoothGattCharacteristic characteristic, ByteArray value)
```
  - handleDescriptorRead
```
 final Unit handleDescriptorRead(BluetoothGattDescriptor descriptor, ByteArray value, Integer status)
```
  - handleDescriptorWrite
```
 final Unit handleDescriptorWrite(BluetoothGattService service, BluetoothGattCharacteristic characteristic, ByteArray value, Integer status)
```
  - handleMtuChanged
```
 final Unit handleMtuChanged(Integer mtu, Integer status)
```
  - handleAuthenticationComplete
```
 final Unit handleAuthenticationComplete()
```
  - processNextAttributeOperation
```
 final Unit processNextAttributeOperation(Boolean remove)
```
  - handleRssiRead
```
 final Unit handleRssiRead(Integer rssi, Integer status)
```
  - resetDirectConnect
```
 final Unit resetDirectConnect()
```
  - incrementDirectConnectRetryCount
```
 final Integer incrementDirectConnectRetryCount()
```

Class BDDeviceSessionImpl

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.polar.androidcommunications.api.ble.model.BleDeviceSession

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getBluetoothDevice

setBluetoothDevice

getGattMutex

getServiceDiscovery

setServiceDiscovery

getGatt

setGatt

getRssiObservers

isNonConnectableAdvertisement

getAddress

isAuthenticated

isAuthenticationNeeded

getDirectConnect

setDirectConnect

getDirectConnectRetryCount

setDirectConnectRetryCount

getConsecutiveNoCallbackConnects

setConsecutiveNoCallbackConnects

getNextConnectAllowedTimeMs

setNextConnectAllowedTimeMs

getPendingWatchdogCancel

setPendingWatchdogCancel

resetGatt

setSessionStates

reset

authenticate

clearGattCache

readRssiValue

getIndicatesPairingProblem

gattClientRequestStopScanning

gattClientResumeScanning

transportQueueSize

handleDisconnection

transmitMessages

transmitMessage

readValue

setCharacteristicNotify

monitorServicesDiscovered

isConnected

handleServicesDiscovered

handleCharacteristicWrite

handleCharacteristicRead

handleCharacteristicValueUpdated

handleDescriptorRead

handleDescriptorWrite

handleMtuChanged

handleAuthenticationComplete

processNextAttributeOperation

handleRssiRead

resetDirectConnect

incrementDirectConnectRetryCount