/*
 * Copyright (c) 2015, Nordic Semiconductor
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package no.nordicsemi.android.nrftoolbox.profile;

import android.bluetooth.BluetoothDevice;
import android.bluetooth.BluetoothGatt;
import android.bluetooth.BluetoothGattCallback;

/**
 * DO NOT EDIT THIS FILE UNLESS NECESSARY!
 * The BleManagerCallbacks should be overridden in your app and all the 'high level' callbacks should be added there.
 * Keeping this file as is (and {@link BleManager} as well) will allow to quickly update it when an update is posted here.
 * @see no.nordicsemi.android.nrftoolbox.rsc.RSCManagerCallbacks
 */
public interface BleManagerCallbacks {

	/**
	 * Called when the Android device started connecting to given device.
	 * The {@link #onDeviceConnected(BluetoothDevice)} will be called when the device is connected,
	 * or {@link #onError(BluetoothDevice, String, int)} in case of error.
	 * @param device the device that got connected
	 */
	void onDeviceConnecting(final BluetoothDevice device);

	/**
	 * Called when the device has been connected. This does not mean that the application may start communication.
	 * A service discovery will be handled automatically after this call. Service discovery
	 * may ends up with calling {@link #onServicesDiscovered(BluetoothDevice, boolean)} or
	 * {@link #onDeviceNotSupported(BluetoothDevice)} if required services have not been found.
	 * @param device the device that got connected
	 */
	void onDeviceConnected(final BluetoothDevice device);

	/**
	 * Called when user initialized disconnection.
	 * @param device the device that gets disconnecting
	 */
	void onDeviceDisconnecting(final BluetoothDevice device);

	/**
	 * Called when the device has disconnected (when the callback returned
	 * {@link BluetoothGattCallback#onConnectionStateChange(BluetoothGatt, int, int)} with state DISCONNECTED),
	 * but ONLY if the {@link BleManager#shouldAutoConnect()} method returned false for this device when it was connecting.
	 * Otherwise the {@link #onLinklossOccur(BluetoothDevice)} method will be called instead.
	 * @param device the device that got disconnected
	 */
	void onDeviceDisconnected(final BluetoothDevice device);

	/**
	 * This callback is invoked when the Ble Manager lost connection to a device that has been connected
	 * with autoConnect option (see {@link BleManager#shouldAutoConnect()}.
	 * Otherwise a {@link #onDeviceDisconnected(BluetoothDevice)} method will be called on such event.
	 * @param device the device that got disconnected due to a link loss
	 */
	void onLinklossOccur(final BluetoothDevice device);

	/**
	 * Called when service discovery has finished and primary services has been found.
	 * This method is not called if the primary, mandatory services were not found during service discovery.
	 * For example in the Blood Pressure Monitor, a Blood Pressure service is a primary service and
	 * Intermediate Cuff Pressure service is a optional secondary service.
	 * Existence of battery service is not notified by this call.
	 * <p>After successful service discovery the service will initialize all services.
	 * The {@link #onDeviceReady(BluetoothDevice)} method will be called when the initialization is complete.</p>
	 *
	 * @param device the device which services got disconnected
	 * @param optionalServicesFound
	 *            if <code>true</code> the secondary services were also found on the device.
	 */
	void onServicesDiscovered(final BluetoothDevice device, final boolean optionalServicesFound);

	/**
	 * Method called when all initialization requests has been completed.
	 * @param device the device that get ready
	 */
	void onDeviceReady(final BluetoothDevice device);

	/**
	 * This method should return true if Battery Level notifications should be enabled on the target device.
	 * If there is no Battery Service, or the Battery Level characteristic does not have NOTIFY property,
	 * this method will not be called for this device.
	 * <p>This method may return true only if an activity is bound to the service (to display the information
	 * to the user), always (e.g. if critical battery level is reported using notifications) or never, if
	 * such information is not important or the manager wants to control Battery Level notifications on its own.</p>
	 * @param device target device
	 * @return true to enabled battery level notifications after connecting to the device, false otherwise
	 */
	boolean shouldEnableBatteryLevelNotifications(final BluetoothDevice device);

	/**
	 * Called when battery value has been received from the device.
	 *
	 * @param value
	 *            the battery value in percent
	 * @param device the device frm which the battery value has changed
	 */
	void onBatteryValueReceived(final BluetoothDevice device, final int value);

	/**
	 * Called when an {@link BluetoothGatt#GATT_INSUFFICIENT_AUTHENTICATION} error occurred and the device bond state is NOT_BONDED
	 * @param device the device that requires bonding
	 */
	void onBondingRequired(final BluetoothDevice device);

	/**
	 * Called when the device has been successfully bonded.
	 * @param device the device that got bonded
	 */
	void onBonded(final BluetoothDevice device);

	/**
	 * Called when a BLE error has occurred
	 *
	 * @param message
	 *            the error message
	 * @param errorCode
	 *            the error code
	 * @param device the device that caused an error
	 */
	void onError(final BluetoothDevice device, final String message, final int errorCode);

	/**
	 * Called when service discovery has finished but the main services were not found on the device.
	 * @param device the device that failed to connect due to lack of required services
	 */
	void onDeviceNotSupported(final BluetoothDevice device);
}
