no.nordicsemi.android.ble

Class WriteRequest

java.lang.Object

no.nordicsemi.android.ble.Request

no.nordicsemi.android.ble.SimpleRequest

no.nordicsemi.android.ble.SimpleValueRequest<DataSentCallback>

no.nordicsemi.android.ble.WriteRequest

All Implemented Interfaces:

Operation

public final class WriteRequest
extends SimpleValueRequest<DataSentCallback>
implements Operation

Field Summary

Fields inherited from class no.nordicsemi.android.ble.Request

handler, requestHandler

Method Summary

Modifier and Type	Method and Description
WriteRequest	before(BeforeCallback callback) Sets a callback that will be executed before the execution of this operation starts.
WriteRequest	done(SuccessCallback callback) Use to set a completion callback.
WriteRequest	fail(FailCallback callback) Use to set a callback that will be called in case the request has failed.
WriteRequest	invalid(InvalidRequestCallback callback) Use to set a callback that will be called in case the request was invalid, for example called before the device was connected.
WriteRequest	setHandler(android.os.Handler handler) Sets the handler that will be used to invoke callbacks.
WriteRequest	split() Adds a default MTU splitter that will be used to cut given data into at-most MTU-3 bytes long packets.
WriteRequest	split(DataSplitter splitter) Adds a splitter that will be used to cut given data into multiple packets.
WriteRequest	split(DataSplitter splitter, WriteProgressCallback callback) Adds a splitter that will be used to cut given data into multiple packets.
WriteRequest	split(WriteProgressCallback callback) Adds a default MTU splitter that will be used to cut given data into at-most MTU-3 bytes long packets.
WriteRequest	with(DataSentCallback callback) Sets the value callback.

Methods inherited from class no.nordicsemi.android.ble.SimpleValueRequest

await, await

Methods inherited from class no.nordicsemi.android.ble.SimpleRequest

await

Methods inherited from class no.nordicsemi.android.ble.Request

createBond, enqueue, newConnectionPriorityRequest, newDisableBatteryLevelNotificationsRequest, newDisableIndicationsRequest, newDisableNotificationsRequest, newEnableBatteryLevelNotificationsRequest, newEnableIndicationsRequest, newEnableNotificationsRequest, newMtuRequest, newReadBatteryLevelRequest, newReadPhyRequest, newReadRequest, newReadRequest, newReadRssiRequest, newRefreshCacheRequest, newSetPreferredPhyRequest, newSleepRequest, newWaitForIndicationRequest, newWaitForNotificationRequest, newWriteRequest, newWriteRequest, newWriteRequest, newWriteRequest, newWriteRequest, newWriteRequest, removeBond

Methods inherited from class java.lang.Object

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

Method Detail

setHandler

@NonNull
public WriteRequest setHandler(@NonNull
                                         android.os.Handler handler)

Description copied from class: Request

Sets the handler that will be used to invoke callbacks. By default, the handler set in BleManager will be used.

Overrides:

setHandler in class Request

Parameters:

handler - The handler to invoke callbacks for this request.

Returns:

The request.

done

@NonNull
public WriteRequest done(@NonNull
                                   SuccessCallback callback)

Description copied from class: Request

Use to set a completion callback. The callback will be invoked when the operation has finished successfully unless the request was executed synchronously, in which case this callback will be ignored.

Overrides:

done in class Request

Parameters:

callback - the callback.

Returns:

The request.

fail

@NonNull
public WriteRequest fail(@NonNull
                                   FailCallback callback)

Description copied from class: Request

Use to set a callback that will be called in case the request has failed. If the target device wasn't set before executing this request (BleManager.connect(BluetoothDevice) was never called), the Request.invalid(InvalidRequestCallback) will be used instead, as the BluetoothDevice is not known.

This callback will be ignored if request was executed synchronously, in which case the error will be returned as an exception.

Overrides:

fail in class Request

Parameters:

callback - the callback.

Returns:

The request.

invalid

@NonNull
public WriteRequest invalid(@NonNull
                                      InvalidRequestCallback callback)

Description copied from class: Request

Use to set a callback that will be called in case the request was invalid, for example called before the device was connected. This callback will be ignored if request was executed synchronously, in which case the error will be returned as an exception.

Overrides:

invalid in class Request

Parameters:

callback - the callback.

Returns:

The request.

before

@NonNull
public WriteRequest before(@NonNull
                                     BeforeCallback callback)

Description copied from class: Request

Sets a callback that will be executed before the execution of this operation starts.

Overrides:

before in class Request

Parameters:

callback - the callback.

Returns:

The request.

with

@NonNull
public WriteRequest with(@NonNull
                                   DataSentCallback callback)

Description copied from class: SimpleValueRequest

Sets the value callback. When the request is invoked synchronously, this callback will be ignored and the received value will be returned by the await(...) method;

Overrides:

with in class SimpleValueRequest<DataSentCallback>

Parameters:

callback - the callback.

Returns:

The request.

split

@NonNull
public WriteRequest split(@NonNull
                                    DataSplitter splitter)

Adds a splitter that will be used to cut given data into multiple packets. The splitter may modify each packet if necessary, i.e. add a flag indicating first packet, continuation or the last packet.

Parameters:

splitter - an implementation of a splitter.

Returns:

The request.

See Also:

split()

split

@NonNull
public WriteRequest split(@NonNull
                                    DataSplitter splitter,
                                    @NonNull
                                    WriteProgressCallback callback)

Adds a splitter that will be used to cut given data into multiple packets. The splitter may modify each packet if necessary, i.e. add a flag indicating first packet, continuation or the last packet.

Parameters:

splitter - an implementation of a splitter.

callback - the progress callback that will be notified each time a packet was sent.

Returns:

The request.

See Also:

split()

split

@NonNull
public WriteRequest split()

Adds a default MTU splitter that will be used to cut given data into at-most MTU-3 bytes long packets.

Returns:

The request.

split

@NonNull
public WriteRequest split(@NonNull
                                    WriteProgressCallback callback)

Adds a default MTU splitter that will be used to cut given data into at-most MTU-3 bytes long packets.

Parameters:

callback - the progress callback that will be notified each time a packet was sent.

Returns:

The request.