com.idevicesinc.sweetblue

Enum OutgoingListener.Status

java.lang.Object

java.lang.Enum<OutgoingListener.Status>

com.idevicesinc.sweetblue.OutgoingListener.Status

All Implemented Interfaces:

UsesCustomNull, java.io.Serializable, java.lang.Comparable<OutgoingListener.Status>

Enclosing interface:

OutgoingListener

public static enum OutgoingListener.Status
extends java.lang.Enum<OutgoingListener.Status>
implements UsesCustomNull

Enumeration of the various success and error statuses possible for an outgoing message.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED_FROM_BLE_TURNING_OFF The operation was cancelled because BleManager went BleManagerState.TURNING_OFF and/or BleManagerState.OFF.
CANCELLED_FROM_DISCONNECT The operation was cancelled by the client/server becoming BleServerState.DISCONNECTED.
FAILED_TO_SEND_OUT The underlying call to BluetoothGattServer.sendResponse(BluetoothDevice, int, int, int, byte[]) or BluetoothGattServer.notifyCharacteristicChanged(BluetoothDevice, BluetoothGattCharacteristic, boolean) failed for reasons unknown.
FAILED_TO_SET_VALUE_ON_TARGET For now only relevant if ExchangeListener.ExchangeEvent.type() is ExchangeListener.Type.NOTIFICATION - BluetoothGattCharacteristic.setValue(byte[]) (or one of its overloads) returned false.
NO_MATCHING_TARGET Couldn't find a matching ExchangeListener.ExchangeEvent.target() for ExchangeListener.ExchangeEvent.charUuid().
NO_REQUEST_LISTENER_SET The server does not have a IncomingListener set so no valid response could be sent.
NO_RESPONSE_ATTEMPTED IncomingListener.Please.doNotRespond(OutgoingListener) (or overloads) were called or ExchangeListener.ExchangeEvent.responseNeeded() was false.
NOT_CONNECTED Could not communicate with the client device because the server is not currently BleServerState.CONNECTED.
NULL Fulfills the soft contract of UsesCustomNull.
NULL_SERVER BleServer.sendNotification(String, UUID, UUID, FutureData, OutgoingListener) or BleServer.sendIndication(String, UUID, byte[]) (or various overloads) was called on BleServer.NULL.
REMOTE_GATT_FAILURE The operation failed in a "normal" fashion, at least relative to all the other strange ways an operation can fail.
SUCCESS The outgoing message to the client was successfully sent.
TIMED_OUT Couldn't send out the data because the operation took longer than the time dictated by BleNodeConfig.taskTimeoutRequestFilter so we had to cut her loose.

Method Summary

Modifier and Type	Method and Description
boolean	isNull() Returns true if this== NULL.
static OutgoingListener.Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OutgoingListener.Status[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NULL

public static final OutgoingListener.Status NULL

Fulfills the soft contract of UsesCustomNull.

SUCCESS

public static final OutgoingListener.Status SUCCESS

The outgoing message to the client was successfully sent.

NULL_SERVER

public static final OutgoingListener.Status NULL_SERVER

BleServer.sendNotification(String, UUID, UUID, FutureData, OutgoingListener) or BleServer.sendIndication(String, UUID, byte[]) (or various overloads) was called on BleServer.NULL.

NO_RESPONSE_ATTEMPTED

public static final OutgoingListener.Status NO_RESPONSE_ATTEMPTED

IncomingListener.Please.doNotRespond(OutgoingListener) (or overloads) were called or ExchangeListener.ExchangeEvent.responseNeeded() was false.

NO_REQUEST_LISTENER_SET

public static final OutgoingListener.Status NO_REQUEST_LISTENER_SET

The server does not have a IncomingListener set so no valid response could be sent. Please set a listener through BleServer.setListener_Incoming(IncomingListener).

NO_MATCHING_TARGET

public static final OutgoingListener.Status NO_MATCHING_TARGET

Couldn't find a matching ExchangeListener.ExchangeEvent.target() for ExchangeListener.ExchangeEvent.charUuid().

FAILED_TO_SET_VALUE_ON_TARGET

public static final OutgoingListener.Status FAILED_TO_SET_VALUE_ON_TARGET

For now only relevant if ExchangeListener.ExchangeEvent.type() is ExchangeListener.Type.NOTIFICATION - BluetoothGattCharacteristic.setValue(byte[]) (or one of its overloads) returned false.

FAILED_TO_SEND_OUT

public static final OutgoingListener.Status FAILED_TO_SEND_OUT

The underlying call to BluetoothGattServer.sendResponse(BluetoothDevice, int, int, int, byte[]) or BluetoothGattServer.notifyCharacteristicChanged(BluetoothDevice, BluetoothGattCharacteristic, boolean) failed for reasons unknown.

REMOTE_GATT_FAILURE

public static final OutgoingListener.Status REMOTE_GATT_FAILURE

The operation failed in a "normal" fashion, at least relative to all the other strange ways an operation can fail. This means for example that BluetoothGattServer.notifyCharacteristicChanged(BluetoothDevice, BluetoothGattCharacteristic, boolean) returned a status code through BluetoothGattServerCallback.onNotificationSent(BluetoothDevice, int) that was not zero. This could mean the device went out of range, was turned off, signal was disrupted, whatever. Often this means that the client is about to become BleServerState.DISCONNECTED.

CANCELLED_FROM_DISCONNECT

public static final OutgoingListener.Status CANCELLED_FROM_DISCONNECT

The operation was cancelled by the client/server becoming BleServerState.DISCONNECTED.

CANCELLED_FROM_BLE_TURNING_OFF

public static final OutgoingListener.Status CANCELLED_FROM_BLE_TURNING_OFF

The operation was cancelled because BleManager went BleManagerState.TURNING_OFF and/or BleManagerState.OFF. Note that if the user turns off BLE from their OS settings (airplane mode, etc.) then OutgoingListener.OutgoingEvent.status() could potentially be CANCELLED_FROM_DISCONNECT because SweetBlue might get the disconnect callback before the turning off callback. Basic testing has revealed that this is *not* the case, but you never know.

Either way, the client was or will be disconnected.

TIMED_OUT

public static final OutgoingListener.Status TIMED_OUT

Couldn't send out the data because the operation took longer than the time dictated by BleNodeConfig.taskTimeoutRequestFilter so we had to cut her loose.

NOT_CONNECTED

public static final OutgoingListener.Status NOT_CONNECTED

Could not communicate with the client device because the server is not currently BleServerState.CONNECTED.

Method Detail

values

public static OutgoingListener.Status[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OutgoingListener.Status c : OutgoingListener.Status.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OutgoingListener.Status valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isNull

public final boolean isNull()

Returns true if this== NULL.

Specified by:

isNull in interface UsesCustomNull