LongWriteOperationBuilderImpl (rxandroidble 1.10.1 API)

java.lang.Object
- com.polidea.rxandroidble2.internal.connection.LongWriteOperationBuilderImpl

All Implemented Interfaces:: RxBleConnection.LongWriteOperationBuilder

public final class LongWriteOperationBuilderImpl
extends java.lang.Object
implements RxBleConnection.LongWriteOperationBuilder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<any>`	`build()` Build function for the long write
`RxBleConnection.LongWriteOperationBuilder`	`setBytes(byte[] bytes)` Setter for a byte array to write This function MUST be called prior to `RxBleConnection.LongWriteOperationBuilder.build()`
`RxBleConnection.LongWriteOperationBuilder`	`setCharacteristic(android.bluetooth.BluetoothGattCharacteristic bluetoothGattCharacteristic)` Setter for a `BluetoothGattCharacteristic` to write to This function or `RxBleConnection.LongWriteOperationBuilder.setCharacteristicUuid(UUID)` MUST be called prior to `RxBleConnection.LongWriteOperationBuilder.build()`
`RxBleConnection.LongWriteOperationBuilder`	`setCharacteristicUuid(java.util.UUID uuid)` Setter for a `UUID` of the `BluetoothGattCharacteristic` to write to This function or `RxBleConnection.LongWriteOperationBuilder.setCharacteristic(BluetoothGattCharacteristic)` MUST be called prior to `RxBleConnection.LongWriteOperationBuilder.build()`
`RxBleConnection.LongWriteOperationBuilder`	`setMaxBatchSize(int maxBatchSize)` Setter for a maximum size of a byte array that may be write at once If this is not specified - the default value of the connection's MTU is used
`RxBleConnection.LongWriteOperationBuilder`	`setWriteOperationAckStrategy(RxBleConnection.WriteOperationAckStrategy writeOperationAckStrategy)` Setter for a strategy used to mark batch write completed.
`RxBleConnection.LongWriteOperationBuilder`	`setWriteOperationRetryStrategy(RxBleConnection.WriteOperationRetryStrategy writeOperationRetryStrategy)` Setter for a retry strategy in case something goes wrong when writing data.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setBytes
```
public RxBleConnection.LongWriteOperationBuilder setBytes(byte[] bytes)
```
    Description copied from interface: RxBleConnection.LongWriteOperationBuilder
    
    Setter for a byte array to write This function MUST be called prior to RxBleConnection.LongWriteOperationBuilder.build()
    
    Specified by:
    
    setBytes in interface RxBleConnection.LongWriteOperationBuilder
    
    Parameters:
    
    bytes - the bytes to write
    
    Returns:
    
    the LongWriteOperationBuilder
  - setCharacteristicUuid
```
public RxBleConnection.LongWriteOperationBuilder setCharacteristicUuid(java.util.UUID uuid)
```
    Description copied from interface: RxBleConnection.LongWriteOperationBuilder
    
    Setter for a UUID of the BluetoothGattCharacteristic to write to This function or RxBleConnection.LongWriteOperationBuilder.setCharacteristic(BluetoothGattCharacteristic) MUST be called prior to RxBleConnection.LongWriteOperationBuilder.build()
    
    Specified by:
    
    setCharacteristicUuid in interface RxBleConnection.LongWriteOperationBuilder
    
    Parameters:
    
    uuid - the UUID
    
    Returns:
    
    the LongWriteOperationBuilder
  - setCharacteristic
```
public RxBleConnection.LongWriteOperationBuilder setCharacteristic(android.bluetooth.BluetoothGattCharacteristic bluetoothGattCharacteristic)
```
    Description copied from interface: RxBleConnection.LongWriteOperationBuilder
    
    Setter for a BluetoothGattCharacteristic to write to This function or RxBleConnection.LongWriteOperationBuilder.setCharacteristicUuid(UUID) MUST be called prior to RxBleConnection.LongWriteOperationBuilder.build()
    
    Specified by:
    
    setCharacteristic in interface RxBleConnection.LongWriteOperationBuilder
    
    Parameters:
    
    bluetoothGattCharacteristic - the BluetoothGattCharacteristic
    
    Returns:
    
    the LongWriteOperationBuilder
  - setMaxBatchSize
```
public RxBleConnection.LongWriteOperationBuilder setMaxBatchSize(int maxBatchSize)
```
    Description copied from interface: RxBleConnection.LongWriteOperationBuilder
    
    Setter for a maximum size of a byte array that may be write at once If this is not specified - the default value of the connection's MTU is used
    
    Specified by:
    
    setMaxBatchSize in interface RxBleConnection.LongWriteOperationBuilder
    
    Parameters:
    
    maxBatchSize - the maximum size of a byte array to write at once
    
    Returns:
    
    the LongWriteOperationBuilder
  - setWriteOperationRetryStrategy
```
public RxBleConnection.LongWriteOperationBuilder setWriteOperationRetryStrategy(RxBleConnection.WriteOperationRetryStrategy writeOperationRetryStrategy)
```
    Description copied from interface: RxBleConnection.LongWriteOperationBuilder
    
    Setter for a retry strategy in case something goes wrong when writing data. If any BleException is raised, a RxBleConnection.WriteOperationRetryStrategy.LongWriteFailure object is emitted. RxBleConnection.WriteOperationRetryStrategy.LongWriteFailure contains both the BleException and the batch number for which the write request failed. The RxBleConnection.WriteOperationRetryStrategy.LongWriteFailure emitted by the writeOperationRetryStrategy will be used to retry the specified batch number write request.
    If this is not specified - if batch write fails, the long write operation is stopped and whole operation is interrupted.
    It is expected that the Observable returned from the writeOperationRetryStrategy will emit exactly the same events as the source, however you may delay them at your pace.
    
    Specified by:
    
    setWriteOperationRetryStrategy in interface RxBleConnection.LongWriteOperationBuilder
    
    Parameters:
    
    writeOperationRetryStrategy - the retry strategy
    
    Returns:
    
    the LongWriteOperationBuilder
  - setWriteOperationAckStrategy
```
public RxBleConnection.LongWriteOperationBuilder setWriteOperationAckStrategy(RxBleConnection.WriteOperationAckStrategy writeOperationAckStrategy)
```
    Description copied from interface: RxBleConnection.LongWriteOperationBuilder
    
    Setter for a strategy used to mark batch write completed. Only after previous batch has finished, the next (if any left) can be written. If this is not specified - the next batch of bytes is written right after the previous one has finished. A bytes batch is a part (slice) of the original byte array to write. Imagine a byte array of {0, 1, 2, 3, 4} where the maximum number of bytes that may be transmitted at once is 2. Then the original byte array will be transmitted in three batches: {0, 1}, {2, 3}, {4} It is expected that the Observable returned from the writeOperationAckStrategy will emit exactly the same events as the source, however you may delay them at your pace.
    
    Specified by:
    
    setWriteOperationAckStrategy in interface RxBleConnection.LongWriteOperationBuilder
    
    Parameters:
    
    writeOperationAckStrategy - the function that acknowledges writing of the batch of bytes. It takes an Observable that emits a boolean value each time the byte array batch has finished to write. Boolean.TRUE means that there are more items in the buffer, Boolean.FALSE otherwise. If you want to delay the next batch use provided observable and add some custom behavior (delay, waiting for a message from the device, etc.)
    
    Returns:
    
    the LongWriteOperationBuilder
  - build
```
public <any> build()
```
    Description copied from interface: RxBleConnection.LongWriteOperationBuilder
    
    Build function for the long write
    
    Specified by:
    
    build in interface RxBleConnection.LongWriteOperationBuilder
    
    Returns:
    
    the Observable which will enqueue the long write operation when subscribed.

Class LongWriteOperationBuilderImpl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setBytes

setCharacteristicUuid

setCharacteristic

setMaxBatchSize

setWriteOperationRetryStrategy

setWriteOperationAckStrategy

build