com.idevicesinc.sweetblue

Class DeviceReconnectFilter.ConnectFailEvent

java.lang.Object

com.idevicesinc.sweetblue.utils.Event

com.idevicesinc.sweetblue.ReconnectFilter.ConnectFailEvent

com.idevicesinc.sweetblue.DeviceReconnectFilter.ConnectFailEvent

All Implemented Interfaces:

UsesCustomNull

Enclosing interface:

DeviceReconnectFilter

public static final class DeviceReconnectFilter.ConnectFailEvent
extends ReconnectFilter.ConnectFailEvent
implements UsesCustomNull

Structure passed to ReconnectFilter.onConnectFailed(ReconnectFilter.ConnectFailEvent) to provide more info about how/why the connection failed.

Method Summary

Modifier and Type	Method and Description
int	bondFailReason() See BondListener.BondEvent.failReason().
BleDevice	device() The BleDevice this DeviceReconnectFilter.ConnectFailEvent is for.
boolean	equals(java.lang.Object obj)
BleDeviceState	highestStateReached_latest() The highest state reached by the latest connection attempt.
BleDeviceState	highestStateReached_total() The highest state reached during the whole connection attempt cycle.
DeviceReconnectFilter.ConnectFailEvent[]	history() Returns a chronologically-ordered list of all DeviceReconnectFilter.ConnectFailEvent instances returned through ReconnectFilter.onConnectFailed(ReconnectFilter.ConnectFailEvent) since the first call to BleDevice.connect(), including the current instance.
boolean	isNull() Returns whether this DeviceReconnectFilter.ConnectFailEvent instance is a "dummy" value.
java.lang.String	macAddress() Convience to return the mac address of device().
boolean	shouldBeReportedToUser() Forwards DeviceReconnectFilter.Status.shouldBeReportedToUser() using status().
DeviceReconnectFilter.Status	status() General reason why the connection failed.
DeviceReconnectFilter.Timing	timing() Further timing information for DeviceReconnectFilter.Status.NATIVE_CONNECTION_FAILED, DeviceReconnectFilter.Status.BONDING_FAILED, and DeviceReconnectFilter.Status.DISCOVERING_SERVICES_FAILED.
java.lang.String	toString()
ReadWriteListener.ReadWriteEvent	txnFailReason() If status() is DeviceReconnectFilter.Status.AUTHENTICATION_FAILED or DeviceReconnectFilter.Status.INITIALIZATION_FAILED and BleTransaction.fail() was called somewhere in or downstream of GenericListener_Void.onEvent(Event), then the ReadWriteListener.ReadWriteEvent passed there will be returned here.

Methods inherited from class com.idevicesinc.sweetblue.ReconnectFilter.ConnectFailEvent

attemptTime_latest, attemptTime_total, autoConnectUsage, failureCountSoFar, gattStatus

Methods inherited from class com.idevicesinc.sweetblue.utils.Event

isFor, isForAll, isForAny

Methods inherited from class java.lang.Object

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

Method Detail

device

public final BleDevice device()

The BleDevice this DeviceReconnectFilter.ConnectFailEvent is for.

macAddress

public final java.lang.String macAddress()

Convience to return the mac address of device().

status

public final DeviceReconnectFilter.Status status()

General reason why the connection failed.

bondFailReason

public final int bondFailReason()

See BondListener.BondEvent.failReason().

highestStateReached_latest

public final BleDeviceState highestStateReached_latest()

The highest state reached by the latest connection attempt.

highestStateReached_total

public final BleDeviceState highestStateReached_total()

The highest state reached during the whole connection attempt cycle.

TIP: You can use this to keep the visual feedback in your connection progress UI "bookmarked" while the connection retries and goes through previous states again.

timing

public final DeviceReconnectFilter.Timing timing()

Further timing information for DeviceReconnectFilter.Status.NATIVE_CONNECTION_FAILED, DeviceReconnectFilter.Status.BONDING_FAILED, and DeviceReconnectFilter.Status.DISCOVERING_SERVICES_FAILED.

txnFailReason

public final ReadWriteListener.ReadWriteEvent txnFailReason()

If status() is DeviceReconnectFilter.Status.AUTHENTICATION_FAILED or DeviceReconnectFilter.Status.INITIALIZATION_FAILED and BleTransaction.fail() was called somewhere in or downstream of GenericListener_Void.onEvent(Event), then the ReadWriteListener.ReadWriteEvent passed there will be returned here. Otherwise, this will return a ReadWriteListener.ReadWriteEvent for which ReadWriteListener.ReadWriteEvent.isNull() returns true.

history

public final DeviceReconnectFilter.ConnectFailEvent[] history()

Returns a chronologically-ordered list of all DeviceReconnectFilter.ConnectFailEvent instances returned through ReconnectFilter.onConnectFailed(ReconnectFilter.ConnectFailEvent) since the first call to BleDevice.connect(), including the current instance. Thus this list will always have at least a length of one (except if isNull() is true). The list length is "reset" back to one whenever a BleDeviceState.CONNECTING_OVERALL operation completes, either through becoming BleDeviceState.INITIALIZED, or BleDeviceState.BLE_DISCONNECTED for good.

isNull

public final boolean isNull()

Returns whether this DeviceReconnectFilter.ConnectFailEvent instance is a "dummy" value. For now used for ReconnectFilter.ConnectionLostEvent.connectionFailEvent() in certain situations.

Specified by:

isNull in interface UsesCustomNull

shouldBeReportedToUser

public final boolean shouldBeReportedToUser()

Forwards DeviceReconnectFilter.Status.shouldBeReportedToUser() using status().

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object