-/******************************************************************
+/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
******************************************************************/
/**
- * @file caleclient.h
- * @brief This file contains the APIs for BT LE communications.
+ * @file
+ * This file contains the APIs for BT LE communications.
*/
#ifndef CA_LECLIENT_H_
#define CA_LECLIENT_H_
+#include "calestate.h"
#include "cacommon.h"
#include "cathreadpool.h"
#include "uarraylist.h"
{
#endif
-static const uint16_t STATE_CHARACTER_SET = 2;
-static const uint16_t STATE_CHARACTER_UNSET = 1;
-static const uint16_t STATE_CHARACTER_NO_CHANGE = 0;
-
-static const uint16_t STATE_SEND_NONE = 0;
-static const uint16_t STATE_SEND_SUCCESS = 1;
-static const uint16_t STATE_SEND_FAILED = 2;
-
-static const uint32_t STATE_CONNECTED = 2;
-static const uint32_t STATE_DISCONNECTED = 0;
-
-typedef struct le_state_info
+/**
+ * BLE Scanning State.
+ */
+typedef enum
{
- char address[CA_MACADDR_SIZE];
- uint32_t connectedState;
- uint16_t notificationState;
- uint16_t sendState;
-} CALEState_t;
+ BLE_SCAN_ENABLE = 0, /**< BLE scan is working */
+ BLE_SCAN_DISABLE, /**< BLE scan is not working */
+ BLE_SCAN_NONE /**< Initialize State */
+} CALEScanState_t;
/**
- * @brief Callback to be notified on reception of any data from remote devices.
- * @param address [IN] MAC address of remote device.
- * @param data [IN] Data received from remote device.
- * @return None
+ * Callback to be notified on reception of any data from remote devices.
+ * @param[in] address MAC address of remote device.
+ * @param[in] data Data received from remote device.
* @pre Callback must be registered using CALESetCallback(CAPacketReceiveCallback callback)
*/
-typedef void (*CAPacketReceiveCallback)(const char *address, const char *data);
+typedef void (*CAPacketReceiveCallback)(const char *address, const uint8_t *data);
/**
- * @brief initialize JNI object
- * @return None
+ * initialize JNI object.
*/
void CALEClientJniInit();
/**
- * @brief set context of application
- * @return None
+ * set context of application.
*/
void CALEClientJNISetContext();
/**
- * @brief create interface object and initialize the object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * create interface object and initialize the object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientCreateJniInterfaceObject();
/**
- * @brief initialize client for BLE
- * @param handle [IN] thread pool handle object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * initialize client for BLE.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
-CAResult_t CALEClientInitialize(ca_thread_pool_t handle);
+CAResult_t CALEClientInitialize();
/**
- * @brief terminate client for BLE
- * @return None
+ * terminate client for BLE.
*/
void CALEClientTerminate();
/**
- * @brief for destroy sending routine
- * @param env [IN] JNI interface pointer
- * @param gatt [IN] Gatt profile object
- * @return None
+ * destroy interface object and terminate the interface.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CALEClientDestroyJniInterface();
+
+/**
+ * for destroy sending routine.
+ * @param[in] env JNI interface pointer.
+ * @param[in] gatt Gatt profile object.
*/
void CALEClientSendFinish(JNIEnv *env, jobject gatt);
/**
- * @brief send data for unicast (interface)
- * @param address [IN] remote address
- * @param data [IN] data for transmission
- * @param dataLen [IN] data length
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * send negotiation message after gatt connection is done.
+ * @param[in] address remote address.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
-CAResult_t CALEClientSendUnicastMessage(const char *address, const char *data,
+CAResult_t CALEClientSendNegotiationMessage(const char* address);
+
+/**
+ * send data for unicast (interface).
+ * @param[in] address remote address.
+ * @param[in] data data for transmission.
+ * @param[in] dataLen data length.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CALEClientSendUnicastMessage(const char *address, const uint8_t *data,
const uint32_t dataLen);
/**
- * @brief send data for multicast (interface)
- * @param data [IN] data for transmission
- * @param dataLen [IN] data length
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * send data for multicast (interface).
+ * @param[in] data data for transmission.
+ * @param[in] dataLen data length.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
-CAResult_t CALEClientSendMulticastMessage(const char *data, const uint32_t dataLen);
+CAResult_t CALEClientSendMulticastMessage(const uint8_t *data, const uint32_t dataLen);
/**
- * @brief start unicast server
- * @param address [IN] remote address
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * start unicast server.
+ * @param[in] address remote address.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientStartUnicastServer(const char *address);
/**
- * @brief start multicast server (start discovery)
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * start multicast server (start discovery).
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientStartMulticastServer();
/**
- * @brief stop unicast server
- * @return None
+ * stop unicast server.
*/
void CALEClientStopUnicastServer();
/**
- * @brief stop multicast server (stop discovery)
- * @return None
+ * stop multicast server (stop discovery).
*/
void CALEClientStopMulticastServer();
/**
- * @brief set this callback for receiving data packets from peer devices.
- * @param callback [IN] callback to be notified on reception of
- * unicast/multicast data packets.
- * @return None
+ * set this callback for receiving data packets from peer devices.
+ * @param[in] callback callback to be notified on reception of
+ * unicast/multicast data packets.
*/
void CALEClientSetCallback(CAPacketReceiveCallback callback);
/**
- * @brief get local address (interface)
- * @param address [OUT] local address
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * waiting to get scanned device from BT Platform.
+ * if there is no scanned device in the list.
+ * @param[in] env JNI interface pointer.
+ * @param[in] address LE address.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
-CAResult_t CALEClientGetInterfaceInfo(char **address);
+CAResult_t CALEClientIsThereScannedDevices(JNIEnv *env, const char* address);
/**
- * @brief get local address (implement)
- * @param address [OUT] local address
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * send data for unicast (implement).
+ * @param[in] address remote address.
+ * @param[in] data data for transmission.
+ * @param[in] dataLen data length.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
-CAResult_t CALEClientGetLocalAddress(char** address);
-
-/**
- * @brief send data for unicast (implement)
- * @param address [IN] remote address
- * @param data [IN] data for transmission
- * @param dataLen [IN] data length
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
- */
-CAResult_t CALEClientSendUnicastMessageImpl(const char *address, const char *data,
+CAResult_t CALEClientSendUnicastMessageImpl(const char *address, const uint8_t *data,
const uint32_t dataLen);
/**
- * @brief send data for multicast (implement)
- * @param env [IN] JNI interface pointer
- * @param data [IN] data for transmission
- * @param dataLen [IN] data length
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * send data for multicast (implement).
+ * @param[in] env JNI interface pointer.
+ * @param[in] data data for transmission.
+ * @param[in] dataLen data length.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
-CAResult_t CALEClientSendMulticastMessageImpl(JNIEnv *env, const char *data,
+CAResult_t CALEClientSendMulticastMessageImpl(JNIEnv *env, const uint8_t *data,
const uint32_t dataLen);
/**
- * @brief check whether it is connected or not with remote address.
- * @param address [IN] remote address
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
- */
-CAResult_t CALECheckSendState(const char* address);
-
-/**
- * @brief send data to remote device.
- * if it isn't connected yet. connect LE before try to send data
- * @param env [IN] JNI interface pointer
- * @param device [IN] bluetooth device object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * send data to remote device.
+ * if it isn't connected yet. connect LE before try to send data.
+ * @param[in] env JNI interface pointer.
+ * @param[in] device bluetooth device object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientSendData(JNIEnv *env, jobject device);
/**
- * @brief get address from bluetooth gatt object
- * @param env [IN] JNI interface pointer
- * @param gatt [IN] Gatt profile object
- * @return bluetooth address
+ * get address from bluetooth gatt object.
+ * @param[in] env JNI interface pointer.
+ * @param[in] gatt Gatt profile object.
+ * @return bluetooth address.
*/
jstring CALEClientGetAddressFromGattObj(JNIEnv *env, jobject gatt);
/**
- * @brief get remote address from bluetooth socket object
- * @param env [IN] JNI interface pointer
- * @param bluetoothSocketObj [IN] bluetooth socket
- * @return bluetooth address
+ * get remote address from bluetooth socket object.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothSocketObj bluetooth socket.
+ * @return bluetooth address.
*/
jstring CALEClientGetRemoteAddress(JNIEnv *env, jobject bluetoothSocketObj);
/**
- * @brief close gatt
- * @param env [IN] JNI interface pointer
- * @param bluetoothGatt [IN] gatt profile object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * close gatt.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothGatt gatt profile object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientGattClose(JNIEnv *env, jobject bluetoothGatt);
/**
- * @brief start to scan whole bluetooth devices (interface)
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * start to scan whole bluetooth devices (interface).
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientStartScan();
/**
- * @brief start to scan whole bluetooth devices (implement)
- * @param env [IN] JNI interface pointer
- * @param callback [IN] callback to receive device object by scanning
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * start to scan whole bluetooth devices (implement).
+ * @param[in] env JNI interface pointer.
+ * @param[in] callback callback to receive device object by scanning.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientStartScanImpl(JNIEnv *env, jobject callback);
/**
- * @brief start to scan target bluetooth devices for service uuid (implement)
- * @param env [IN] JNI interface pointer
- * @param uuids [IN] target UUID
- * @param callback [IN] callback to receive device object by scanning
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * start to scan whole bluetooth devices for android API level 21 (implement).
+ * @param[in] env JNI interface pointer.
+ * @param[in] callback callback to receive device object by scanning.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CALEClientStartScanImplForV21(JNIEnv *env, jobject callback);
+
+/**
+ * start to scan target bluetooth devices for service uuid (implement).
+ * @param[in] env JNI interface pointer.
+ * @param[in] uuids target UUID.
+ * @param[in] callback callback to receive device object by scanning.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientStartScanWithUUIDImpl(JNIEnv *env, jobjectArray uuids,
jobject callback);
/**
- * @brief get uuid object
- * @param env [IN] JNI interface pointer
- * @param uuid [IN] uuid
- * @return uuid object
+ * start to scan target bluetooth devices for service uuid for android API level 21 (implement).
+ * @param[in] env JNI interface pointer.
+ * @param[in] uuids target UUID.
+ * @param[in] callback callback to receive device object by scanning.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CALEClientStartScanWithUUIDImplForV21(JNIEnv *env, jobjectArray uuids,
+ jobject callback);
+
+/**
+ * get uuid object.
+ * @param[in] env JNI interface pointer.
+ * @param[in] uuid uuid.
+ * @return uuid object.
*/
jobject CALEClientGetUUIDObject(JNIEnv *env, const char *uuid);
/**
- * @brief stop scan (interface)
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * stop scan (interface).
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientStopScan();
/**
- * @brief stop scan (implement)
- * @param env [IN] JNI interface pointer
- * @param callback [IN] callback to receive device object by scanning
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * stop scan (implement).
+ * @param[in] env JNI interface pointer.
+ * @param[in] callback callback to receive device object by scanning.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientStopScanImpl(JNIEnv *env, jobject callback);
/**
- * @brief connect to gatt server hosted
- * @param env [IN] JNI interface pointer
- * @param bluetoothDevice [IN] bluetooth Device object
- * @param autoconnect [IN] whether to directly connect to the remote device(false) or
+ * stop scan for android API level 21(implement).
+ * @param[in] env JNI interface pointer.
+ * @param[in] callback callback to receive device object by scanning.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CALEClientStopScanImplForV21(JNIEnv *env, jobject callback);
+
+/**
+ * connect to gatt server hosted.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothDevice bluetooth Device object.
+ * @param[in] autoconnect whether to directly connect to the remote device(false) or
* to automatically connect as soon as the remote device
- * becomes available
- * @param callback [IN] callback for connection state change
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * becomes available.
+ * @return gatt object
*/
-CAResult_t CALEClientConnect(JNIEnv *env, jobject bluetoothDevice, jboolean autoconnect,
- jobject callback);
+jobject CALEClientConnect(JNIEnv *env, jobject bluetoothDevice, jboolean autoconnect);
/**
- * @brief disconnect to gatt server by a target device
- * @param env [IN] JNI interface pointer
- * @param bluetoothGatt [IN] Gatt profile object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * disconnect to gatt server by a target device.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothGatt Gatt profile object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientDisconnect(JNIEnv *env, jobject bluetoothGatt);
/**
- * @brief disconnect to gatt server by whole devices
- * @param env [IN] JNI interface pointer
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * disconnect to gatt server by whole devices.
+ * @param[in] env JNI interface pointer.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientDisconnectAll(JNIEnv *env);
/**
- * @brief start discovery server
- * @param env [IN] JNI interface pointer
- * @param bluetoothGatt [IN] Gatt profile object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * disconnect to gatt server by selected address.
+ * @param[in] env JNI interface pointer.
+ * @param[in] remoteAddress remote address.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CALEClientDisconnectforAddress(JNIEnv *env, jstring remoteAddress);
+
+/**
+ * request MTU size negotiation to server.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothGatt gatt object.
+ * @param[in] size MTU size.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CALEClientRequestMTU(JNIEnv *env, jobject bluetoothGatt, jint size);
+/**
+ * start discovery server.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothGatt Gatt profile object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientDiscoverServices(JNIEnv *env, jobject bluetoothGatt);
/**
- * @brief create GattCharacteristic and call CALEClientWriteCharacteristicImpl
- * for request to write gatt characteristic
- * @param env [IN] JNI interface pointer
- * @param gatt [IN] Gatt profile object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * call CALESetValueAndWriteCharacteristic when connection is successful.
+ * @param[in] env JNI interface pointer.
+ * @param[in] gatt Gatt profile object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientWriteCharacteristic(JNIEnv *env, jobject gatt);
/**
- * @brief request to write gatt characteristic
- * @param env [IN] JNI interface pointer
- * @param bluetoothGatt [IN] Gatt profile object
- * @param gattCharacteristic [IN] characteristic object that contain data to send
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * create GattCharacteristic and call CALEClientWriteCharacteristicImpl
+ * for request to write gatt characteristic.
+ * @param[in] env JNI interface pointer.
+ * @param[in] gatt Gatt profile object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CALESetValueAndWriteCharacteristic(JNIEnv *env, jobject gatt);
+
+/**
+ * request to write gatt characteristic.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothGatt Gatt profile object.
+ * @param[in] gattCharacteristic characteristic object that contain data to send.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientWriteCharacteristicImpl(JNIEnv *env, jobject bluetoothGatt,
jobject gattCharacteristic);
/**
- * @brief request to read gatt characteristic
- * @param env [IN] JNI interface pointer
- * @param bluetoothGatt [IN] Gatt profile object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * request to read gatt characteristic.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothGatt Gatt profile object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientReadCharacteristic(JNIEnv *env, jobject bluetoothGatt);
/**
- * @brief enable notification for a target device
- * @param env [IN] JNI interface pointer
- * @param bluetoothGatt [IN] Gatt profile object
- * @param characteristic [IN] Characteristic object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * enable notification for a target device.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothGatt Gatt profile object.
+ * @param[in] characteristic Characteristic object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientSetCharacteristicNotification(JNIEnv *env, jobject bluetoothGatt,
jobject characteristic);
/**
- * @brief create gatt characteristic object
- * @param env [IN] JNI interface pointer
- * @param bluetoothGatt [IN] Gatt profile object
- * @param data [IN] for make Characteristic with data
- * @return Gatt Characteristic object
+ * create gatt characteristic object.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothGatt Gatt profile object.
+ * @param[in] data for make Characteristic with data.
+ * @return Gatt Characteristic object.
*/
jobject CALEClientCreateGattCharacteristic(JNIEnv *env, jobject bluetoothGatt, jbyteArray data);
/**
- * @brief get gatt service
- * @param env [IN] JNI interface pointer
- * @param bluetoothGatt [IN] Gatt profile object
- * @param characterUUID [IN] for make BluetoothGattCharacteristic object
- * @return Gatt Service
+ * get gatt service.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothGatt Gatt profile object.
+ * @param[in] characterUUID for make BluetoothGattCharacteristic object.
+ * @return Gatt Service.
*/
jobject CALEClientGetGattService(JNIEnv *env, jobject bluetoothGatt, jstring characterUUID);
/**
- * @brief get value from characteristic
- * @param env [IN] JNI interface pointer
- * @param characteristic [IN] Characteristic object
- * @return value in characteristic
+ * get value from characteristic.
+ * @param[in] env JNI interface pointer.
+ * @param[in] characteristic Characteristic object.
+ * @return value in characteristic.
*/
jbyteArray CALEClientGetValueFromCharacteristic(JNIEnv *env, jobject characteristic);
/**
- * @brief create UUID List
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * create UUID List.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientCreateUUIDList();
/**
- * @brief set UUID to descriptor
- * @param env [IN] JNI interface pointer
- * @param bluetoothGatt [IN] Gatt profile object
- * @param characteristic [IN] Characteristic object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * set UUID to descriptor.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothGatt Gatt profile object.
+ * @param[in] characteristic Characteristic object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientSetUUIDToDescriptor(JNIEnv *env, jobject bluetoothGatt,
jobject characteristic);
/**
- * BluetoothDevice List
- */
-/**
- * @brief add device object to scan device list
- * @param env [IN] JNI interface pointer
- * @param device [IN] bluetooth device object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * add device object to scan device list.
+ * @param[in] env JNI interface pointer.
+ * @param[in] device bluetooth device object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientAddScanDeviceToList(JNIEnv *env, jobject device);
/**
- * @brief check whether the device exist in list or not
- * @param env [IN] JNI interface pointer
- * @param remoteAddress [IN] remote address
- * @return true or false
+ * check whether the device exist in list or not.
+ * @param[in] env JNI interface pointer.
+ * @param[in] remoteAddress remote address.
+ * @return true or false.
*/
bool CALEClientIsDeviceInScanDeviceList(JNIEnv *env, const char *remoteAddress);
/**
- * @brief remove all devices in scan device list
- * @param env [IN] JNI interface pointer
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * remove all devices in scan device list.
+ * @param[in] env JNI interface pointer.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientRemoveAllScanDevices(JNIEnv *env);
/**
- * @brief remove target device in scan device list
- * @param env [IN] JNI interface pointer
- * @param remoteAddress [IN] remote address
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * remove target device in scan device list.
+ * @param[in] env JNI interface pointer.
+ * @param[in] remoteAddress remote address.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientRemoveDeviceInScanDeviceList(JNIEnv *env, jstring remoteAddress);
/**
- * BluetoothGatt List
- */
-
-/**
- * @brief add gatt object to gatt object list
- * @param env [IN] JNI interface pointer
- * @param gatt [IN] Gatt profile object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * add gatt object to gatt object list.
+ * @param[in] env JNI interface pointer.
+ * @param[in] gatt Gatt profile object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientAddGattobjToList(JNIEnv *env, jobject gatt);
/**
- * @brief check whether the gatt object exist in list or not
- * @param env [IN] JNI interface pointer
- * @param remoteAddress [IN] remote address
- * @return true or false
+ * check whether the gatt object exist in list or not.
+ * @param[in] env JNI interface pointer.
+ * @param[in] remoteAddress remote address.
+ * @return true or false.
*/
bool CALEClientIsGattObjInList(JNIEnv *env, const char *remoteAddress);
/**
- * @brief get the gatt object
- * @param env [IN] JNI interface pointer
- * @param remoteAddress [IN] remote address
- * @return gatt object
+ * get the gatt object.
+ * @param[in] env JNI interface pointer.
+ * @param[in] remoteAddress remote address.
+ * @return gatt object.
*/
jobject CALEClientGetGattObjInList(JNIEnv *env, const char* remoteAddress);
/**
- * @brief remove all gatt objects in gatt object list
- * @param env [IN] JNI interface pointer
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * remove all gatt objects in gatt object list.
+ * @param[in] env JNI interface pointer.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientRemoveAllGattObjs(JNIEnv *env);
/**
- * @brief remove target device in gatt object list
- * @param env [IN] JNI interface pointer
- * @param gatt [IN] Gatt profile object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * remove target device in gatt object list.
+ * @param[in] env JNI interface pointer.
+ * @param[in] gatt Gatt profile object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientRemoveGattObj(JNIEnv *env, jobject gatt);
/**
- * @brief remove gatt object of target device for address in gatt object list
- * @param env [IN] JNI interface pointer
- * @param gatt [IN] Gatt profile object
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * remove gatt object of target device for address in gatt object list.
+ * @param[in] env JNI interface pointer.
+ * @param[in] gatt Gatt profile object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
CAResult_t CALEClientRemoveGattObjForAddr(JNIEnv *env, jstring addr);
/**
- * BT State Info List
+ * get ble address from Bluetooth device.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothDevice Bluetooth device.
+ * @return ble address.
*/
+jstring CALEClientGetLEAddressFromBTDevice(JNIEnv *env, jobject bluetoothDevice);
/**
- * @brief update new state information
- * @param address [IN] remote address
- * @param connectedState [IN] connection state
- * @param notificationState [IN] whether characteristic notification already set or not
- * @param sendState [IN] whether sending was success or not
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * update new state information by Bluetooth device object.
+ * @param[in] env JNI interface pointer.
+ * @param[in] device Bluetooth device.
+ * @param[in] state_type state type.
+ * @param[in] target_state state index to update.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
-CAResult_t CALEClientUpdateDeviceState(const char* address, uint32_t connectedState,
- uint16_t notificationState, uint16_t sendState);
+CAResult_t CALEClientUpdateDeviceStateWithBtDevice(JNIEnv *env,
+ jobject device,
+ uint16_t state_type,
+ uint16_t target_state);
/**
- * @brief add new state to state list
- * @param state [IN] new state
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * set flag into State List.
+ * @param[in] env JNI interface pointer.
+ * @param[in] jni_address remote address.
+ * @param[in] state_idx state index.
+ * @param[in] flag auto connect flag.
*/
-CAResult_t CALEClientAddDeviceStateToList(CALEState_t* state);
+CAResult_t CALEClientSetFlagToState(JNIEnv *env, jstring jni_address,
+ jint state_idx, jboolean flag);
/**
- * @brief check whether the remote address is existed or not.
- * @param address [IN] remote address
- * @return true or false
+ * get flag from State List.
+ * @param[in] env JNI interface pointer.
+ * @param[in] jni_address remote address.
+ * @param[in] state_idx state index.
+ * @return current flag;
*/
-bool CALEClientIsDeviceInList(const char *remoteAddress);
+jboolean CALEClientGetFlagFromState(JNIEnv *env, jstring jni_address, jint state_idx);
/**
- * @brief remove all device states
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * get MTU size.
+ * @param[in] address the address of the remote device.
+ * @return mtu size negotiated from remote device.
*/
-CAResult_t CALEClientRemoveAllDeviceState();
+uint16_t CALEClientGetMtuSize(const char* address);
/**
- * @brief remove the device state for a remote device
- * @param remoteAddress [IN] remote address
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * Reset values of device state for all of devices.
+ * this method has to be invoked when BT adapter is disabled.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
-CAResult_t CALEClientRemoveDeviceState(const char* remoteAddress);
+CAResult_t CALEClientResetDeviceStateForAll();
/**
- * @brief get state information for a remote device
- * @param remoteAddress [IN] remote address
- * @return CALEState_t
+ * create scan device list.
*/
-CALEState_t* CALEClientGetStateInfo(const char* remoteAddress);
+void CALEClientCreateDeviceList();
/**
- * @brief check whether the remote address is connected or not.
- * @param remoteAddress [IN] remote address
- * @return true or false
+ * update the counter which data is sent to remote device.
+ * @param[in] env JNI interface pointer.
*/
-bool CALEClientIsConnectedDevice(const char* remoteAddress);
+void CALEClientUpdateSendCnt(JNIEnv *env);
/**
- * @brief check whether the remote address set CharacteristicNotification or not
- * @param remoteAddress [IN] remote address
- * @return true or false
+ * initialize mutex.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
-bool CALEClientIsSetCharacteristic(const char* remoteAddress);
+CAResult_t CALEClientInitGattMutexVaraibles();
/**
- * @brief create scan device list
- * @return None
+ * terminate mutex.
*/
-void CALEClientCreateDeviceList();
+void CALEClientTerminateGattMutexVariables();
/**
- * @brief Reordering for device state list
- * @param index [IN] index of device list that want to reordering
- * @param list [IN] the list to reorder
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * set send finish flag.
+ * @param[in] flag finish flag.
*/
-CAResult_t CALEClientReorderingList(uint32_t index, u_arraylist_t *list);
+void CALEClientSetSendFinishFlag(bool flag);
/**
- * @brief update the counter which data is sent to remote device
- * @param env [IN] JNI interface pointer
- * @return None
+ * close the connection of the profile proxy to the Service.
+ * @param[in] env JNI interface pointer.
+ * @param[in] gatt gatt profile object.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
-void CALEClientUpdateSendCnt(JNIEnv *env);
+CAResult_t CALEClientCloseProfileProxy(JNIEnv *env, jobject gatt);
/**
- * @brief initialize mutex
- * @return CA_STATUS_OK or ERROR CODES (CAResult_t error codes in cacommon.h)
+ * connect to GATT Server hosted by this device.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothDevice bluetooth device object.
+ * @param[in] autoconnect connect as soon as the device becomes avaiable(true).
+ * @return gatt profile object
*/
-CAResult_t CALEClientInitGattMutexVaraibles();
+jobject CALEClientGattConnect(JNIEnv *env, jobject bluetoothDevice, jboolean autoconnect);
/**
- * @brief terminate mutex
- * @return None
+ * connect to GATT Server hosted by this device directly.
+ * @param[in] env JNI interface pointer.
+ * @param[in] bluetoothDevice bluetooth device object.
+ * @param[in] autoconnect connect as soon as the device becomes avaiable(true).
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
*/
-void CALEClientTerminateGattMutexVariables();
+CAResult_t CALEClientDirectConnect(JNIEnv *env, jobject bluetoothDevice, jboolean autoconnect);
/**
- * @brief set send finish flag
- * @param flag [IN] flag
- * @return None
+ * check connection status.
+ * @param[in] address the address of the remote device.
+ * @return true or false.
*/
-void CALEClientSetSendFinishFlag(bool flag);
+bool CALEClientIsConnected(const char* address);
/**
- * @brief set the flag whether WriteCharacteristicCB is called
- * @param flag [IN] flag
- * @return None
+ * set new interval time and working count.
+ * @param[in] intervalTime interval time(Seconds).
+ * @param[in] workingCount working count for selected interval time.
+ * @param[in] nextScanningStep set next scanning state.
*/
-void CALEClientSetWriteCharacteristicCBFlag(bool flag);
+void CALEClientSetScanInterval(int32_t intervalTime, int32_t workingCount,
+ CALEScanState_t nextScanningStep);
/**
- * @brief set the flag whether Send Request is called
- * @param flag [IN] flag
- * @return None
+ * restart scanning with new interval time and working count.
+ * @param[in] intervalTime interval time(Seconds).
+ * @param[in] workingCount working count for selected interval time.
+ * @param[in] nextScanningStep set next scanning state.
*/
-void CALEClientSetTheSendRequestFlag(bool flag);
+void CALERestartScanWithInterval(int32_t intervalTime, int32_t workingCount,
+ CALEScanState_t nextScanningStep);
+
+/**
+ * start LE scanning logic with interval time and working count.
+ * @return ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
+ */
+CAResult_t CALEClientStartScanWithInterval();
+
+/**
+ * stop LE scanning logic with interval time and cycle.
+ */
+void CALEClientStopScanWithInterval();
#ifdef __cplusplus
} /* extern "C" */
#endif
-#endif
+#endif /* CA_LECLIENT_H_ */
projects / platform / upstream / iotivity.git / blobdiff