All Implemented Interfaces:


public final class BlePsFtpClient
extends BleGattBase

Polar simple file transfer client declaration.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`BlePsFtpClient.ProgressCallback`

Field Summary

Fields
Modifier and Type	Field	Description
`public final BleGattTxInterface`	`txInterface`
`public Boolean`	`isPrimaryService`
`private final Boolean`	`isEncryptionRequired`
`private final Boolean`	`isServiceDiscovered`

Constructor Summary

Constructors
Constructor	Description
`BlePsFtpClient(BleGattTxInterface txInterface)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Unit`	`setProgressCallback(BlePsFtpClient.ProgressCallback callback)`
`final Unit`	`setPacketsCount(Integer count)`	Set amount of packets written consecutive with BLE ATT WRITE before adding the BLE ATT WRITE REQUEST.
`final Integer`	`getPacketsCount()`
`Unit`	`reset()`
`Unit`	`processServiceData(UUID characteristic, ByteArray data, Integer status, Boolean notifying)`	Callback for GATT service characteristic data processing
`Unit`	`processServiceDataWritten(UUID characteristic, Integer status)`
`Unit`	`processServiceDataWrittenWithResponse(UUID characteristic, Integer status)`
`String`	`toString()`
`Unit`	`clientReady(Boolean checkConnection)`
`final ByteArrayOutputStream`	`request(ByteArray header, BlePsFtpClient.ProgressCallback progressCallback)`	Sends a request to the device and returns the response.
`final Flow<Long>`	`write(ByteArray header, ByteArrayInputStream data)`	Writes file to a device, atomic operation.
`final ByteArrayOutputStream`	`query(Integer id, ByteArray parameters)`	Sends a query to device.
`final <Error class: unknown class>`	`sendNotification(Integer id, ByteArray parameters)`	Sends a single notification to device.
`final Flow<BlePsFtpUtils.PftpNotificationMessage>`	`waitForNotification()`	Wait endlessly for notifications from device using a shared Flow.
`final <Error class: unknown class>`	`waitPsFtpClientReady(Boolean checkConnection)`	Suspend until both PS-FTP MTU and D2H notifications are enabled.
`final Unit`	`readResponse(ByteArrayOutputStream outputStream, Long timeoutSeconds)`

Methods inherited from class com.polar.androidcommunications.api.ble.model.gatt.BleGattBase
addCharacteristicNotification, authenticationCompleted, authenticationFailed, containsCharacteristic, containsCharacteristicRead, containsNotifyCharacteristic, descriptorWritten, getAvailableCharacteristics, getNotificationAtomicInteger, isAutomatic, isAutomaticRead, isEncryptionRequired, isServiceDiscovered, processCharacteristicDiscovered, removeCharacteristicNotification, serviceBelongsToClient, setMtuSize, setServiceDiscovered, waitNotificationEnabled, waitServiceDiscovered
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BlePsFtpClient
```
BlePsFtpClient(BleGattTxInterface txInterface)
```
- Method Detail
  - setProgressCallback
```
 final Unit setProgressCallback(BlePsFtpClient.ProgressCallback callback)
```
  - setPacketsCount
```
 final Unit setPacketsCount(Integer count)
```
    Set amount of packets written consecutive with BLE ATT WRITE before adding the BLE ATT WRITE REQUEST.
    
    Parameters:
    
    count - number of packets
  - getPacketsCount
```
 final Integer getPacketsCount()
```
  - reset
```
 Unit reset()
```
  - processServiceData
```
 Unit processServiceData(UUID characteristic, ByteArray data, Integer status, Boolean notifying)
```
    Callback for GATT service characteristic data processing
    
    Parameters:
    
    characteristic - characteristic UUID
    
    data - data in byte array
    
    status - status code of processed data
    
    notifying - if true data is notification data from GATT service
  - processServiceDataWritten
```
 Unit processServiceDataWritten(UUID characteristic, Integer status)
```
  - processServiceDataWrittenWithResponse
```
 Unit processServiceDataWrittenWithResponse(UUID characteristic, Integer status)
```
  - toString
```
 String toString()
```
  - clientReady
```
 Unit clientReady(Boolean checkConnection)
```
  - request
```
 final ByteArrayOutputStream request(ByteArray header, BlePsFtpClient.ProgressCallback progressCallback)
```
    Sends a request to the device and returns the response.
    
    Parameters:
    
    header - protobuf pftp operation bytes
    
    progressCallback - optional callback for progress updates
    
    Returns:
    
    ByteArrayOutputStream containing the response
  - write
```
 final Flow<Long> write(ByteArray header, ByteArrayInputStream data)
```
    Writes file to a device, atomic operation.
    
    Parameters:
    
    header - protobuf pftp operation bytes
    
    data - actual file data
    
    Returns:
    
    Flow emitting current byte offset progress; completes after device confirms write
  - query
```
 final ByteArrayOutputStream query(Integer id, ByteArray parameters)
```
    Sends a query to device.
    
    Parameters:
    
    id - query id value
    
    parameters - optional parameters
    
    Returns:
    
    ByteArrayOutputStream containing the query response
  - sendNotification
```
 final <Error class: unknown class> sendNotification(Integer id, ByteArray parameters)
```
    Sends a single notification to device.
    
    Parameters:
    
    id - one of the PbPFtpHostToDevNotification values
    
    parameters - matching parameter for PbPFtpHostToDevNotification value if any
  - waitForNotification
```
 final Flow<BlePsFtpUtils.PftpNotificationMessage> waitForNotification()
```
    Wait endlessly for notifications from device using a shared Flow.
    
    Returns:
    
    Flow emitting PftpNotificationMessage for each complete notification received. Throws on error; never completes on its own.
  - waitPsFtpClientReady
```
 final <Error class: unknown class> waitPsFtpClientReady(Boolean checkConnection)
```
    Suspend until both PS-FTP MTU and D2H notifications are enabled.
    
    Parameters:
    
    checkConnection - if true, checks connection state before waiting
  - readResponse
```
 final Unit readResponse(ByteArrayOutputStream outputStream, Long timeoutSeconds)
```

Class BlePsFtpClient

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.polar.androidcommunications.api.ble.model.gatt.BleGattBase

Methods inherited from class java.lang.Object

Constructor Detail

BlePsFtpClient

Method Detail

setProgressCallback

setPacketsCount

getPacketsCount

reset

processServiceData

processServiceDataWritten

processServiceDataWrittenWithResponse

toString

clientReady

request

write

query

sendNotification

waitForNotification

waitPsFtpClientReady

readResponse