Enhanced comment ratio for le_adapter 17/24617/6
authorKush <kush.agrawal@samsung.com>
Tue, 10 Apr 2018 09:47:53 +0000 (15:17 +0530)
committerAshok Babu Channa <ashok.channa@samsung.com>
Wed, 18 Apr 2018 11:54:02 +0000 (11:54 +0000)
Change-Id: I893246e60d959efa65741635e8e8b286e05a0b4d
Signed-off-by: Kush <kush.agrawal@samsung.com>
resource/csdk/connectivity/src/bt_le_adapter/android/caleclient.c
resource/csdk/connectivity/src/bt_le_adapter/android/caleserver.c
resource/csdk/connectivity/src/bt_le_adapter/android/calestate.c
resource/csdk/connectivity/src/bt_le_adapter/android/caleutils.c
resource/csdk/connectivity/src/bt_le_adapter/tizen/caleutil.c
resource/csdk/connectivity/util/src/camanager/bt_le_manager/android/camanagerdevice.c

index 1552c90..86713cd 100644 (file)
@@ -38,6 +38,9 @@
 #include "uarraylist.h"
 #include "org_iotivity_ca_CaLeClientInterface.h"
 
+/**
+ * Logging tag for module name.
+ */
 #define TAG PCF("OIC_CA_LE_CLIENT")
 
 #define MICROSECS_PER_SEC 1000000
@@ -72,7 +75,7 @@ static jobject g_leGattCallback = NULL;
 static jobject g_context = NULL;
 static jobjectArray g_uuidList = NULL;
 
-// it will be prevent to start send logic when adapter has stopped.
+// It will be prevent to start send logic when adapter has stopped.
 static bool g_isStartedLEClient = false;
 
 static jbyteArray g_sendBuffer = NULL;
@@ -146,7 +149,7 @@ static bool CALECheckConnectionStateValue(jint state)
 }
 
 /**
- * delete global reference for g_sendBuffer
+ * Delete global reference for g_sendBuffer
  * @param[in]   env                   JNI interface pointer.
  */
 static void CALEDeleteSendBuffer(JNIEnv *env)
@@ -218,7 +221,7 @@ static void CALEScanThread(void* object)
         OIC_LOG(DEBUG, TAG, "scan waiting time out");
         if (BLE_SCAN_ENABLE == g_curScanningStep)
         {
-            //stop scan
+            // stop scan
             CAResult_t ret = CALEClientStopScan();
             if (CA_STATUS_OK != ret)
             {
@@ -227,7 +230,7 @@ static void CALEScanThread(void* object)
         }
         else if (BLE_SCAN_DISABLE == g_curScanningStep)
         {
-            //start scan
+            // start scan
             CAResult_t ret = CALEClientStartScan();
             if (CA_STATUS_OK != ret)
             {
@@ -319,7 +322,7 @@ void CALEClientStopScanWithInterval()
     oc_cond_signal(g_threadScanIntervalCond);
 }
 
-//getting jvm
+//Getting jvm
 void CALEClientJniInit()
 {
     OIC_LOG(DEBUG, TAG, "CALEClientJniInit");
@@ -416,6 +419,9 @@ error_exit:
     return CA_STATUS_FAILED;
 }
 
+/**
+ * Initialize client for BLE.
+ */
 CAResult_t CALEClientInitialize()
 {
     OIC_LOG(DEBUG, TAG, "CALEClientInitialize");
@@ -515,6 +521,9 @@ CAResult_t CALEClientInitialize()
     return CA_STATUS_OK;
 }
 
+/**
+ * Terminate client for BLE.
+ */
 void CALEClientTerminate()
 {
     OIC_LOG(DEBUG, TAG, "CALEClientTerminate");
@@ -591,6 +600,7 @@ void CALEClientTerminate()
         OIC_LOG(ERROR, TAG, "CALEClientRemoveAllGattObjs has failed");
     }
 
+    // sets send finish flag
     CALEClientSetSendFinishFlag(true);
 
     CALEClientTerminateGattMutexVariables();
@@ -619,6 +629,9 @@ void CALEClientTerminate()
     }
 }
 
+/**
+ * Destroy interface object and terminate the interface.
+ */
 CAResult_t CALEClientDestroyJniInterface()
 {
     OIC_LOG(DEBUG, TAG, "CALEClientDestroyJniInterface");
@@ -689,6 +702,9 @@ detach_thread:
     return CA_STATUS_FAILED;
 }
 
+/**
+ * For destroy sending routine.
+ */
 void CALEClientSendFinish(JNIEnv *env, jobject gatt)
 {
     OIC_LOG(DEBUG, TAG, "CALEClientSendFinish");
@@ -705,6 +721,9 @@ void CALEClientSendFinish(JNIEnv *env, jobject gatt)
     CALEClientUpdateSendCnt(env);
 }
 
+/**
+ * Send negotiation message after gatt connection is done.
+ */
 CAResult_t CALEClientSendNegotiationMessage(const char* address)
 {
     VERIFY_NON_NULL(address, TAG, "address is null");
@@ -712,6 +731,9 @@ CAResult_t CALEClientSendNegotiationMessage(const char* address)
     return CALEClientSendUnicastMessageImpl(address, NULL, 0);
 }
 
+/**
+ * Send data for unicast (interface).
+ */
 CAResult_t CALEClientSendUnicastMessage(const char* address,
                                         const uint8_t* data,
                                         const uint32_t dataLen)
@@ -722,6 +744,9 @@ CAResult_t CALEClientSendUnicastMessage(const char* address,
     return CALEClientSendUnicastMessageImpl(address, data, dataLen);
 }
 
+/**
+ * Send data for multicast (interface).
+ */
 CAResult_t CALEClientSendMulticastMessage(const uint8_t* data,
                                           const uint32_t dataLen)
 {
@@ -763,6 +788,9 @@ CAResult_t CALEClientSendMulticastMessage(const uint8_t* data,
     return ret;
 }
 
+/**
+ * Start unicast server.
+ */
 CAResult_t CALEClientStartUnicastServer(const char* address)
 {
 #ifndef TB_LOG
@@ -773,6 +801,9 @@ CAResult_t CALEClientStartUnicastServer(const char* address)
     return CA_NOT_SUPPORTED;
 }
 
+/**
+ * Start multicast server (start discovery).
+ */
 CAResult_t CALEClientStartMulticastServer()
 {
     OIC_LOG(DEBUG, TAG, "it is not needed in this platform");
@@ -780,26 +811,41 @@ CAResult_t CALEClientStartMulticastServer()
     return CA_NOT_SUPPORTED;
 }
 
+/**
+ * Stop unicast server.
+ */
 void CALEClientStopUnicastServer()
 {
     OIC_LOG(DEBUG, TAG, "CALEClientStopUnicastServer");
 }
 
+/**
+ * Stop multicast server (stop discovery).
+ */
 void CALEClientStopMulticastServer()
 {
     OIC_LOG(DEBUG, TAG, "CALEClientStopMulticastServer");
 }
 
+/**
+ * Set this callback for receiving data packets from peer devices.
+ */
 void CALEClientSetCallback(CAPacketReceiveCallback callback)
 {
     g_packetReceiveCallback = callback;
 }
 
+/**
+ * Set this callback for handling error scenarios.
+ */
 void CASetBLEClientErrorHandleCallback(CABLEErrorHandleCallback callback)
 {
     g_clientErrorCallback = callback;
 }
 
+/**
+ * Waiting to get scanned device from BT Platform.
+ */
 CAResult_t CALEClientIsThereScannedDevices(JNIEnv *env, const char* address)
 {
     VERIFY_NON_NULL(env, TAG, "env");
@@ -892,7 +938,9 @@ CAResult_t CALEClientIsThereScannedDevices(JNIEnv *env, const char* address)
     return CA_STATUS_OK;
 }
 
-
+/**
+ * Send data for unicast (implement).
+ */
 CAResult_t CALEClientSendUnicastMessageImpl(const char* address, const uint8_t* data,
                                             const uint32_t dataLen)
 {
@@ -922,6 +970,7 @@ CAResult_t CALEClientSendUnicastMessageImpl(const char* address, const uint8_t*
 
     oc_mutex_lock(g_threadSendMutex);
 
+    // sets send finish flag as false so that next data packet should be after this is completed.
     CALEClientSetSendFinishFlag(false);
 
     CAResult_t ret = CALEClientIsThereScannedDevices(env, address);
@@ -1059,6 +1108,9 @@ error_exit:
     return CA_SEND_FAILED;
 }
 
+/**
+ * Send data for multicast (implement).
+ */
 CAResult_t CALEClientSendMulticastMessageImpl(JNIEnv *env, const uint8_t* data,
                                               const uint32_t dataLen)
 {
@@ -1071,7 +1123,7 @@ CAResult_t CALEClientSendMulticastMessageImpl(JNIEnv *env, const uint8_t* data,
         OIC_LOG(ERROR, TAG, "g_deviceList is null");
         return CA_STATUS_FAILED;
     }
-
+    // Locks this mutex so that no other thread can access g_deviceList and change it.
     oc_mutex_lock(g_threadSendMutex);
 
     CALEClientSetSendFinishFlag(false);
@@ -1079,6 +1131,7 @@ CAResult_t CALEClientSendMulticastMessageImpl(JNIEnv *env, const uint8_t* data,
     OIC_LOG(DEBUG, TAG, "set byteArray for data");
     CALEDeleteSendBuffer(env);
 
+    // checks for scanned devices.
     CAResult_t res = CALEClientIsThereScannedDevices(env, NULL);
     if (CA_STATUS_OK != res)
     {
@@ -1130,6 +1183,9 @@ error_exit:
     return CA_SEND_FAILED;
 }
 
+/**
+ * Send data to remote device.
+ */
 CAResult_t CALEClientSendData(JNIEnv *env, jobject device)
 {
     OIC_LOG(DEBUG, TAG, "IN - CALEClientSendData");
@@ -1202,6 +1258,7 @@ CAResult_t CALEClientSendData(JNIEnv *env, jobject device)
     }
     else
     {
+        // If it is already connected.
         if (CALEIsValidState(address, CA_LE_CONNECTION_STATE,
                              STATE_SERVICE_CONNECTED,
                              g_deviceStateList,
@@ -1217,6 +1274,7 @@ CAResult_t CALEClientSendData(JNIEnv *env, jobject device)
                 return CA_STATUS_FAILED;
             }
 
+            //Write data
             CAResult_t ret = CALESetValueAndWriteCharacteristic(env, gatt);
             if (CA_STATUS_OK != ret)
             {
@@ -1274,6 +1332,9 @@ CAResult_t CALEClientSendData(JNIEnv *env, jobject device)
     return CA_STATUS_OK;
 }
 
+/**
+ * Get address from bluetooth gatt object.
+ */
 jstring CALEClientGetAddressFromGattObj(JNIEnv *env, jobject gatt)
 {
     VERIFY_NON_NULL_RET(gatt, TAG, "gatt is null", NULL);
@@ -1338,6 +1399,9 @@ CAResult_t CALEClientGattClose(JNIEnv *env, jobject bluetoothGatt)
     return CA_STATUS_OK;
 }
 
+/**
+ * Start to scan bluetooth devices.
+ */
 CAResult_t CALEClientStartScan()
 {
     if (!g_isStartedLEClient)
@@ -1597,6 +1661,9 @@ error_exit:
     return res;
 }
 
+/**
+ * Start to scan target bluetooth devices for service uuid.
+ */
 CAResult_t CALEClientStartScanWithUUIDImpl(JNIEnv *env, jobjectArray uuids, jobject callback)
 {
     OIC_LOG(DEBUG, TAG, "CALEClientStartScanWithUUIDImpl IN");
@@ -2045,6 +2112,9 @@ error_exit:
     return res;
 }
 
+/**
+ * Gets UUID Object
+ */
 jobject CALEClientGetUUIDObject(JNIEnv *env, const char* uuid)
 {
     VERIFY_NON_NULL_RET(uuid, TAG, "uuid is null", NULL);
@@ -2084,6 +2154,9 @@ error_exit:
     return NULL;
 }
 
+/**
+ * Stops scan
+ */
 CAResult_t CALEClientStopScan()
 {
     if (!g_jvm)
@@ -2110,6 +2183,7 @@ CAResult_t CALEClientStopScan()
 
     if (g_jniIntSdk >= BLE_SCAN_API_LEVEL)
     {
+        // new UUID scan for V21
         ret = CALEClientStopScanImplForV21(env, g_leScanCallback);
     }
     else
@@ -2316,6 +2390,9 @@ CAResult_t CALEClientStopScanImplForV21(JNIEnv *env, jobject callback)
     return CA_STATUS_OK;
 }
 
+/**
+ * Connect to GATT Server hosted by this device directly.
+ */
 CAResult_t CALEClientDirectConnect(JNIEnv *env, jobject bluetoothDevice, jboolean autoconnect)
 {
     OIC_LOG(DEBUG, TAG, "CALEClientDirectConnect");
@@ -2347,6 +2424,7 @@ CAResult_t CALEClientDirectConnect(JNIEnv *env, jobject bluetoothDevice, jboolea
                         g_deviceStateList,
                         g_deviceStateListMutex))
     {
+        // request connect
         jobject newGatt = CALEClientConnect(env, bluetoothDevice, autoconnect);
         if (NULL == newGatt)
         {
@@ -2359,6 +2437,9 @@ CAResult_t CALEClientDirectConnect(JNIEnv *env, jobject bluetoothDevice, jboolea
     return res;
 }
 
+/**
+ * Connect to GATT server.
+ */
 jobject CALEClientConnect(JNIEnv *env, jobject bluetoothDevice, jboolean autoconnect)
 {
     OIC_LOG(DEBUG, TAG, "CALEClientConnect");
@@ -2421,6 +2502,10 @@ jobject CALEClientConnect(JNIEnv *env, jobject bluetoothDevice, jboolean autocon
     return newGatt;
 }
 
+/**
+ * Connect to GATT Server hosted by device.
+ * Autoconnect as soon as the device becomes available.
+ */
 jobject CALEClientGattConnect(JNIEnv *env, jobject bluetoothDevice, jboolean autoconnect)
 {
     OIC_LOG(DEBUG, TAG, "GATT CONNECT");
@@ -2451,6 +2536,7 @@ jobject CALEClientGattConnect(JNIEnv *env, jobject bluetoothDevice, jboolean aut
     OIC_LOG_V(INFO, TAG, "API level is %d", jni_int_sdk);
     if (jni_int_sdk >= 23) // upper than API level 23
     {
+        // Fetch method ID for method Name and class
         jmethodID jni_mid_connectGatt = CAGetJNIMethodID(env, "android/bluetooth/BluetoothDevice",
                                                          "connectGatt",
                                                          "(Landroid/content/Context;ZLandroid/"
index b960a46..df17d20 100644 (file)
@@ -36,6 +36,9 @@
 #include "uarraylist.h"
 #include "org_iotivity_ca_CaLeServerInterface.h"
 
+/**
+ * Logging tag for module name
+ */
 #define TAG PCF("OIC_CA_LE_SERVER")
 
 #define WAIT_TIME_WRITE_CHARACTERISTIC 10000000
@@ -51,7 +54,14 @@ static jobject g_bluetoothManager = NULL;
 static CAPacketReceiveCallback g_packetReceiveCallback = NULL;
 static CABLEErrorHandleCallback g_serverErrorCallback;
 
+/**
+ * List for storing connected devices.
+ */
 static u_arraylist_t *g_connectedDeviceList = NULL;
+
+/**
+ * List for storing device states.
+ */
 static u_arraylist_t *g_deviceStateList = NULL;
 
 static bool g_isStartServer = false;
@@ -61,15 +71,42 @@ static jbyteArray g_sendBuffer = NULL;
 static jobject g_obj_bluetoothDevice = NULL;
 
 static CABLEDataReceivedCallback g_CABLEServerDataReceivedCallback = NULL;
+
+/**
+ * Mutex to synchronize access to the requestResponse callback to be called .
+ */
 static oc_mutex g_bleReqRespCbMutex = NULL;
+
+/**
+ * Mutex to synchronize access to remote device address
+ *When data is received.
+ */
 static oc_mutex g_bleClientBDAddressMutex = NULL;
+
+/**
+ * Mutex to synchronize access to connected device list.
+ */
 static oc_mutex g_connectedDeviceListMutex = NULL;
 
+/**
+ * Mutex to synchronize access when data sending is in progress.
+ */
 static oc_mutex g_threadSendMutex = NULL;
+
+/**
+ * Mutex to synchronize access to notify callback.
+ */
 static oc_mutex g_threadSendNotifyMutex = NULL;
+
+/**
+ * Condition for sending notification.
+ */
 static oc_cond g_threadSendNotifyCond = NULL;
 static bool g_isSignalSetFlag = false;
 
+/**
+ * Mutex to synchronize access to device state list.
+ */
 static oc_mutex g_deviceStateListMutex = NULL;
 
 static jint g_state_connected = INVALID_STATE;
@@ -202,6 +239,9 @@ static jint CALEServerGetConnectionState(JNIEnv *env, jobject device)
     return jni_state;
 }
 
+/**
+ * Set data in BluetoothGattCharacteristic.
+ */
 jobject CALEServerSetResponseData(JNIEnv *env, jbyteArray responseData)
 {
     OIC_LOG(DEBUG, TAG, "IN - CALEServerSetResponseData");
@@ -299,6 +339,9 @@ jobject CALEServerSetResponseData(JNIEnv *env, jbyteArray responseData)
     return jni_obj_bluetoothGattCharacteristic;
 }
 
+/**
+ * Send data through notifyCharacteristicChanged api of android.
+ */
 CAResult_t CALEServerSendResponseData(JNIEnv *env, jobject device, jobject responseData)
 {
     OIC_LOG(DEBUG, TAG, "CALEServerSendResponseData");
@@ -368,6 +411,9 @@ CAResult_t CALEServerSendResponseData(JNIEnv *env, jobject device, jobject respo
     return CA_STATUS_OK;
 }
 
+/**
+ * Send a response to a write request to a remote device.
+ */
 CAResult_t CALEServerSendResponse(JNIEnv *env, jobject device, jint requestId, jint status,
                                         jint offset, jbyteArray value)
 {
@@ -786,7 +832,7 @@ CAResult_t CALEServerStopAdvertise()
         }
         isAttached = true;
     }
-
+    // stop advertise
     CAResult_t ret = CALEServerStopAdvertiseImpl(env, g_leAdvertiseCallback);
     if (CA_STATUS_OK != ret)
     {
@@ -1066,6 +1112,7 @@ jobject CALEServerCreateGattService(JNIEnv *env)
     jfieldID jni_fid_writeProperties = NULL;
     if (g_setHighQoS)
     {
+        // setting read characterstics
         jni_fid_readProperties = (*env)->GetStaticFieldID(env,
                                                           jni_cid_bluetoothGattCharacteristic,
                                                           "PROPERTY_INDICATE", "I");
@@ -1074,7 +1121,7 @@ jobject CALEServerCreateGattService(JNIEnv *env)
             OIC_LOG(ERROR, TAG, "jni_fid_readProperties is null");
             goto error_exit;
         }
-
+        // setting write characterstics
         jni_fid_writeProperties = (*env)->GetStaticFieldID(env,
                                                            jni_cid_bluetoothGattCharacteristic,
                                                            "PROPERTY_WRITE", "I");
@@ -1130,6 +1177,7 @@ jobject CALEServerCreateGattService(JNIEnv *env)
         goto error_exit;
     }
 
+    // adding characterstics to gatt service
     jmethodID jni_mid_addCharacteristic = (*env)->GetMethodID(env, jni_cid_bluetoothGattService,
                                                               "addCharacteristic",
                                                               "(Landroid/bluetooth/"
@@ -1245,6 +1293,9 @@ error_exit:
     return NULL;
 }
 
+/**
+ * Add descriptor to the characteristic
+ */
 CAResult_t CALEServerAddDescriptor(JNIEnv *env, jobject characteristic)
 {
     OIC_LOG(DEBUG, TAG, "CALEServerAddDescriptor");
@@ -1338,6 +1389,9 @@ error_exit:
     return CA_STATUS_FAILED;
 }
 
+/**
+ * Add GATT service to GATT server handle
+ */
 CAResult_t CALEServerAddGattService(JNIEnv *env, jobject bluetoothGattServer,
                                           jobject bluetoothGattService)
 {
@@ -1377,6 +1431,9 @@ CAResult_t CALEServerAddGattService(JNIEnv *env, jobject bluetoothGattServer,
     return CA_STATUS_OK;
 }
 
+/**
+* Connect remote device
+*/
 CAResult_t CALEServerConnect(JNIEnv *env, jobject bluetoothDevice)
 {
     OIC_LOG(DEBUG, TAG, "IN - CALEServerConnect");
@@ -1412,6 +1469,9 @@ CAResult_t CALEServerConnect(JNIEnv *env, jobject bluetoothDevice)
     return CA_STATUS_OK;
 }
 
+/**
+* Disconnect all devices
+*/
 CAResult_t CALEServerDisconnectAllDevices(JNIEnv *env)
 {
     OIC_LOG(DEBUG, TAG, "IN - CALEServerDisconnectAllDevices");
@@ -1449,6 +1509,9 @@ CAResult_t CALEServerDisconnectAllDevices(JNIEnv *env)
     return CA_STATUS_OK;
 }
 
+/**
+ * Disconnect LE to remote device form gatt server.
+ */
 CAResult_t CALEServerDisconnect(JNIEnv *env, jobject bluetoothDevice)
 {
     OIC_LOG(DEBUG, TAG, "IN - CALEServerDisconnect");
@@ -1483,6 +1546,9 @@ CAResult_t CALEServerDisconnect(JNIEnv *env, jobject bluetoothDevice)
     return CA_STATUS_OK;
 }
 
+/**
+ * Close gatt server.
+ */
 CAResult_t CALEServerGattClose(JNIEnv *env, jobject bluetoothGattServer)
 {
     // GATT CLOSE
@@ -1513,6 +1579,9 @@ CAResult_t CALEServerGattClose(JNIEnv *env, jobject bluetoothGattServer)
     return CA_STATUS_OK;
 }
 
+/**
+ * Send data to gatt client.
+ */
 CAResult_t CALEServerSend(JNIEnv *env, jobject bluetoothDevice, jbyteArray responseData)
 {
     OIC_LOG(DEBUG, TAG, "IN - CALEServerSend");
@@ -1544,6 +1613,9 @@ CAResult_t CALEServerSend(JNIEnv *env, jobject bluetoothDevice, jbyteArray respo
     return result;
 }
 
+/**
+ * Initialize GATT server.
+ */
 CAResult_t CALEServerInitialize()
 {
     OIC_LOG(DEBUG, TAG, "IN - CALEServerInitialize");
@@ -2288,6 +2360,9 @@ CAResult_t CALEServerRemoveDevice(JNIEnv *env, jstring address)
     return CA_STATUS_FAILED;
 }
 
+/**
+ * Registers GATT server callback .
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_ca_CaLeServerInterface_caLeRegisterGattServerCallback(JNIEnv *env, jobject obj,
                                                                         jobject callback)
@@ -2301,6 +2376,9 @@ Java_org_iotivity_ca_CaLeServerInterface_caLeRegisterGattServerCallback(JNIEnv *
     CACheckJNIException(env);
 }
 
+/**
+ * Registers callback for bluetooth advertising.
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_ca_CaLeServerInterface_caLeRegisterBluetoothLeAdvertiseCallback(JNIEnv *env,
                                                                                   jobject obj,
@@ -2315,6 +2393,9 @@ Java_org_iotivity_ca_CaLeServerInterface_caLeRegisterBluetoothLeAdvertiseCallbac
     CACheckJNIException(env);
 }
 
+/**
+ * Callback is trigerred when gatt server connection state changes(connect/disconnect).
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_ca_CaLeServerInterface_caLeGattServerConnectionStateChangeCallback(
         JNIEnv *env, jobject obj, jobject device, jint status, jint newState)
@@ -2407,6 +2488,9 @@ Java_org_iotivity_ca_CaLeServerInterface_caLeGattServerConnectionStateChangeCall
     (*env)->DeleteLocalRef(env, jni_remoteAddress);
 }
 
+/**
+ * Callback is trigerred when service is added on gatt server successfully.
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_ca_CaLeServerInterface_caLeGattServerServiceAddedCallback(JNIEnv *env,
                                                                             jobject obj,
@@ -2433,6 +2517,9 @@ Java_org_iotivity_ca_CaLeServerInterface_caLeGattServerCharacteristicReadRequest
     VERIFY_NON_NULL_VOID(data, TAG, "data");
 }
 
+/**
+ * Callback is trigerred when there is some data written on write characterstics.
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_ca_CaLeServerInterface_caLeGattServerCharacteristicWriteRequestCallback(
         JNIEnv *env, jobject obj, jobject device, jbyteArray data,
@@ -2502,6 +2589,10 @@ Java_org_iotivity_ca_CaLeServerInterface_caLeGattServerCharacteristicWriteReques
     (*env)->ReleaseStringUTFChars(env, jni_address, address);
 }
 
+/**
+ * Callback is trigerred notifying that data write is successful .
+ * We can send next packet if any.
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_ca_CaLeServerInterface_caLeGattServerNotificationSentCallback(JNIEnv *env,
                                                                                 jobject obj,
@@ -2584,6 +2675,9 @@ Java_org_iotivity_ca_CaLeServerInterface_caLeGattServerNotificationSentCallback(
 
 }
 
+/**
+ * Callback is trigerred when advertise is success.
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_ca_CaLeServerInterface_caLeAdvertiseStartSuccessCallback(JNIEnv *env,
                                                                            jobject obj,
@@ -2596,6 +2690,9 @@ Java_org_iotivity_ca_CaLeServerInterface_caLeAdvertiseStartSuccessCallback(JNIEn
     OIC_LOG(DEBUG, TAG, "LE Advertise Start Success Callback");
 }
 
+/**
+ * Callback is trigerred when advertise fails.
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_ca_CaLeServerInterface_caLeAdvertiseStartFailureCallback(JNIEnv *env,
                                                                            jobject obj,
@@ -2621,6 +2718,9 @@ Java_org_iotivity_ca_CaLeServerInterface_caLeAdvertiseStartFailureCallback(JNIEn
     }
 }
 
+/**
+ * Callback is trigerred when MTU is changed.
+ */
 JNIEXPORT void JNICALL
 Java_org_iotivity_ca_CaLeServerInterface_caLeGattServerMtuChangedCallback(JNIEnv * env,
                                                                           jobject obj,
index f0a35cd..9bdcb32 100644 (file)
 #include "octhread.h"
 #include "uarraylist.h"
 
+/**
+ * Logging tag for module name
+ */
 #define TAG PCF("OIC_CA_LE_STATE")
 
+/**
+ * Update new state information.
+ */
 CAResult_t CALEUpdateDeviceState(const char* address,
                                  uint16_t state_type,
                                  uint16_t target_state,
@@ -48,6 +54,7 @@ CAResult_t CALEUpdateDeviceState(const char* address,
 
     oc_mutex_lock(deviceListMutex);
 
+    // checks whether address is already present in device list
     if (CALEIsDeviceInList(address, deviceList))
     {
         CALEState_t* curState = CALEGetStateInfo(address, deviceList);
@@ -116,6 +123,9 @@ CAResult_t CALEUpdateDeviceState(const char* address,
     return CA_STATUS_OK;
 }
 
+/**
+ * Check whether the remote address is existed or not.
+ */
 bool CALEIsDeviceInList(const char* remoteAddress,
                         u_arraylist_t *deviceList)
 {
@@ -146,6 +156,9 @@ bool CALEIsDeviceInList(const char* remoteAddress,
     return false;
 }
 
+/**
+ * Remove all device states.
+ */
 CAResult_t CALERemoveAllDeviceState(u_arraylist_t *deviceList,
                                     oc_mutex deviceListMutex)
 {
@@ -170,6 +183,9 @@ CAResult_t CALERemoveAllDeviceState(u_arraylist_t *deviceList,
     return CA_STATUS_OK;
 }
 
+/**
+ * Reset values of device state for all of devices.
+ */
 CAResult_t CALEResetDeviceStateForAll(u_arraylist_t *deviceList,
                                       oc_mutex deviceListMutex)
 {
@@ -197,6 +213,9 @@ CAResult_t CALEResetDeviceStateForAll(u_arraylist_t *deviceList,
     return CA_STATUS_OK;
 }
 
+/**
+ * Remove the device state for a remote device.
+ */
 CAResult_t CALERemoveDeviceState(const char* remoteAddress,
                                  u_arraylist_t *deviceList)
 {
@@ -233,6 +252,9 @@ CAResult_t CALERemoveDeviceState(const char* remoteAddress,
     return CA_STATUS_OK;
 }
 
+/**
+ * Get state information for a remote device.
+ */
 CALEState_t* CALEGetStateInfo(const char* remoteAddress,
                               u_arraylist_t *deviceList)
 {
@@ -261,6 +283,9 @@ CALEState_t* CALEGetStateInfo(const char* remoteAddress,
     return NULL;
 }
 
+/**
+ * Checks whether the remote address has same state with target state.
+ */
 bool CALEIsValidState(const char* remoteAddress,
                       uint16_t state_type,
                       uint16_t target_state,
@@ -309,7 +334,9 @@ bool CALEIsValidState(const char* remoteAddress,
     return false;
 }
 
-
+/**
+ * Set flag into State List.
+ */
 CAResult_t CALESetFlagToState(JNIEnv *env, jstring jni_address, jint state_idx, jboolean flag,
                               u_arraylist_t *deviceList, oc_mutex deviceListMutex)
 {
@@ -359,6 +386,9 @@ CAResult_t CALESetFlagToState(JNIEnv *env, jstring jni_address, jint state_idx,
     return CA_STATUS_OK;
 }
 
+/**
+ * Get flag from State List.
+ */
 jboolean CALEGetFlagFromState(JNIEnv *env, jstring jni_address, jint state_idx,
                               u_arraylist_t *deviceList, oc_mutex deviceListMutex)
 {
@@ -406,6 +436,9 @@ jboolean CALEGetFlagFromState(JNIEnv *env, jstring jni_address, jint state_idx,
     return ret;
 }
 
+/**
+ * Set MTU size for device with address as passed in argument.
+ */
 CAResult_t CALESetMtuSize(const char* address, uint16_t mtuSize,
                           u_arraylist_t *deviceList, oc_mutex deviceListMutex)
 
@@ -435,7 +468,9 @@ CAResult_t CALESetMtuSize(const char* address, uint16_t mtuSize,
     oc_mutex_unlock(deviceListMutex);
     return CA_STATUS_OK;
 }
-
+/**
+ * Get MTU size for device with address as passed in argument.
+ */
 uint16_t CALEGetMtuSize(const char* address, u_arraylist_t *deviceList, oc_mutex deviceListMutex)
 {
     VERIFY_NON_NULL_RET(address, TAG, "address is null", CA_DEFAULT_BLE_MTU_SIZE);
index 704b989..00f4242 100644 (file)
 #include "uarraylist.h"
 #include "caadapterutils.h"
 
+/**
+ * Logging tag for module name
+ */
 #define TAG PCF("OIC_CA_LE_UTILS")
 
+/**
+ * Get UUID(jni object) from UUID(character).
+ */
 jobject CALEGetUuidFromString(JNIEnv *env, const char* uuid)
 {
     VERIFY_NON_NULL_RET(uuid, TAG, "uuid is null", NULL);
@@ -73,6 +79,9 @@ error_exit:
     return NULL;
 }
 
+/**
+ * Get parcel UUID object.
+ */
 jobject CALEGetParcelUuid(JNIEnv *env, jobject uuid)
 {
     VERIFY_NON_NULL_RET(env, TAG, "env is null", NULL);
@@ -106,6 +115,9 @@ error_exit:
     return NULL;
 }
 
+/**
+ * Get parcel UUID object from UUID string value.
+ */
 jobject CALEGetParcelUuidFromString(JNIEnv *env, const char* uuid)
 {
     VERIFY_NON_NULL_RET(env, TAG, "env is null", NULL);
@@ -150,6 +162,9 @@ error_exit:
     return NULL;
 }
 
+/**
+ * Checks blutooth device is bonded or not.
+ */
 bool CALEIsBondedDevice(JNIEnv *env, jobject bluetoothDevice)
 {
     VERIFY_NON_NULL_RET(env, TAG, "env is null", false);
@@ -180,6 +195,9 @@ bool CALEIsBondedDevice(JNIEnv *env, jobject bluetoothDevice)
     }
 }
 
+/**
+ * Get bonded list.
+ */
 jobjectArray CALEGetBondedDevices(JNIEnv *env)
 {
     VERIFY_NON_NULL_RET(env, TAG, "env is null", NULL);
@@ -244,6 +262,9 @@ error_exit:
     return NULL;
 }
 
+/**
+ * Get constants information of bluetooth state-on.
+ */
 jint CALEGetBTStateOnInfo(JNIEnv *env)
 {
     VERIFY_NON_NULL_RET(env, TAG, "env is null", -1);
@@ -271,6 +292,9 @@ jint CALEGetBTStateOnInfo(JNIEnv *env)
     return jni_int_val;
 }
 
+/**
+ * Check this device can be supported as BLE client or server.
+ */
 CAResult_t CALECheckPlatformVersion(JNIEnv *env, uint16_t level)
 {
     jint jni_int_sdk = CALEGetBuildVersion(env);
@@ -283,6 +307,9 @@ CAResult_t CALECheckPlatformVersion(JNIEnv *env, uint16_t level)
     return CA_STATUS_OK;
 }
 
+/**
+ * Get constants information of android.os.Build.VERSION.SDK_INT.
+ */
 jint CALEGetBuildVersion(JNIEnv *env)
 {
     VERIFY_NON_NULL_RET(env, TAG, "env is null", -1);
@@ -311,6 +338,9 @@ jint CALEGetBuildVersion(JNIEnv *env)
     return jni_int_sdk;
 }
 
+/**
+ * Get constants information of android.os.Build.VERSION_CODES.[VersionName].
+ */
 jint CALEGetBuildVersionCodeForName(JNIEnv *env, const char* versionName)
 {
     VERIFY_NON_NULL_RET(env, TAG, "env is null", -1);
@@ -340,6 +370,9 @@ jint CALEGetBuildVersionCodeForName(JNIEnv *env, const char* versionName)
     return jni_int_version;
 }
 
+/**
+ * Get bluetooth adapter state information.
+ */
 jboolean CALEIsEnableBTAdapter(JNIEnv *env)
 {
     VERIFY_NON_NULL_RET(env, TAG, "env is null", JNI_FALSE);
@@ -393,6 +426,9 @@ jboolean CALEIsEnableBTAdapter(JNIEnv *env)
     return jni_isEnable;
 }
 
+/**
+ * Get address from remote device.
+ */
 jstring CALEGetAddressFromBTDevice(JNIEnv *env, jobject bluetoothDevice)
 {
     VERIFY_NON_NULL_RET(env, TAG, "env is null", NULL);
@@ -419,6 +455,9 @@ jstring CALEGetAddressFromBTDevice(JNIEnv *env, jobject bluetoothDevice)
     return jni_address;
 }
 
+/**
+ * Get value from selected constants.
+ */
 jint CALEGetConstantsValue(JNIEnv *env, const char* classType, const char* name)
 {
     VERIFY_NON_NULL_RET(env, TAG, "env", -1);
@@ -447,6 +486,9 @@ jint CALEGetConstantsValue(JNIEnv *env, const char* classType, const char* name)
     return jni_id;
 }
 
+/**
+ * Get bluetooth device object from bluetooth adapter.
+ */
 jobject CALEGetRemoteDevice(JNIEnv *env, jstring address)
 {
     OIC_LOG(DEBUG, TAG, "CALEGetRemoteDevice");
@@ -504,6 +546,9 @@ error_exit:
     return NULL;
 }
 
+/**
+ * Get address from gatt profile object.
+ */
 jstring CALEGetAddressFromGatt(JNIEnv *env, jobject gatt)
 {
     OIC_LOG(DEBUG, TAG, "CALEGetAddressFromGatt");
index aa66da1..0fdbbf6 100644 (file)
@@ -153,6 +153,7 @@ CAResult_t CAAddLEServerInfoToList(LEServerInfoList **serverList,
     VERIFY_NON_NULL(serverList, TAG, "serverList");
     VERIFY_NON_NULL(leServerInfo, TAG, "leServerInfo");
 
+    // Initialize server info list
     LEServerInfoList *node = (LEServerInfoList *) OICCalloc(1, sizeof(LEServerInfoList));
     if (NULL == node)
     {
index 542c2e8..f8c40e6 100644 (file)
 #include "camanagerdevice.h"
 #include "oic_malloc.h"
 
+/**
+ * Logging tag for module name.
+ */
 #define TAG "OIC_CA_MANAGER_DEVICE"
 
+/**
+ * List to store devices for auto connection.
+ */
 static u_arraylist_t *g_deviceACDataList = NULL;
+
+/**
+ * Mutex to synchronize access to the auto connection list.
+ */
 static oc_mutex g_deviceACDataListMutex = NULL;
 static bool g_isBTRecovery = false;
 
+/**
+ * Get address from auto connection list.
+ */
 jstring CAManagerGetLEAddressFromACData(JNIEnv *env, size_t idx)
 {
     OIC_LOG_V(DEBUG, TAG, "CAManagerGetLEAddressFromACData (idx : %d)", idx);
@@ -62,6 +75,9 @@ jstring CAManagerGetLEAddressFromACData(JNIEnv *env, size_t idx)
     return NULL;
 }
 
+/**
+ * Create auto connection list.
+ */
 void CAManagerCreateACDataList()
 {
     OIC_LOG(DEBUG, TAG, "CAManagerCreateACDataList");
@@ -75,6 +91,9 @@ void CAManagerCreateACDataList()
     oc_mutex_unlock(g_deviceACDataListMutex);
 }
 
+/**
+ * Destroy auto connection list.
+ */
 void CAManagerDestroyACDataList()
 {
     OIC_LOG(DEBUG, TAG, "CAManagerDestroyACDataList");
@@ -86,6 +105,9 @@ void CAManagerDestroyACDataList()
     }
 }
 
+/**
+ * Initialize mutex.
+ */
 CAResult_t CAManagerInitMutexVaraibles()
 {
     if (NULL == g_deviceACDataListMutex)
@@ -100,6 +122,9 @@ CAResult_t CAManagerInitMutexVaraibles()
     return CA_STATUS_OK;
 }
 
+/**
+ * Terminate mutex.
+ */
 void CAManagerTerminateMutexVariables()
 {
     if (g_deviceACDataListMutex)
@@ -109,6 +134,9 @@ void CAManagerTerminateMutexVariables()
     }
 }
 
+/**
+ * Create auto connection data for device to be added in list.
+ */
 static CAManagerACData_t *CAManagerCreateACData(jstring jaddress)
 {
     VERIFY_NON_NULL_RET(jaddress, TAG, "jaddress", NULL);
@@ -126,6 +154,9 @@ static CAManagerACData_t *CAManagerCreateACData(jstring jaddress)
     return data;
 }
 
+/**
+ * Check whether target address is already contained in ACData list or not.
+ */
 bool CAManagerIsInACDataList(JNIEnv *env, jstring jaddress)
 {
     VERIFY_NON_NULL_RET(env, TAG, "env", NULL);
@@ -180,6 +211,9 @@ bool CAManagerIsInACDataList(JNIEnv *env, jstring jaddress)
     return false;
 }
 
+/**
+ * Add auto connection data into list.
+ */
 void CAManagerAddACData(JNIEnv *env, jstring jaddress)
 {
     VERIFY_NON_NULL_VOID(env, TAG, "env");
@@ -190,7 +224,7 @@ void CAManagerAddACData(JNIEnv *env, jstring jaddress)
         OIC_LOG(DEBUG, TAG, "new ACdata will be added in List");
         // add CAManagerACData
         jobject gaddress = (*env)->NewGlobalRef(env, jaddress);
-
+        //creating auto connection data
         CAManagerACData_t *data = CAManagerCreateACData(gaddress);
 
         oc_mutex_lock(g_deviceACDataListMutex);
@@ -203,6 +237,9 @@ void CAManagerAddACData(JNIEnv *env, jstring jaddress)
     }
 }
 
+/**
+ * Remove auto connection data from ACData list for selected ble address.
+ */
 CAResult_t CAManagerRemoveACData(JNIEnv *env, jstring jaddress)
 {
     OIC_LOG(DEBUG, TAG, "CAManagerRemoveACData");
@@ -277,6 +314,9 @@ CAResult_t CAManagerRemoveACData(JNIEnv *env, jstring jaddress)
     return CA_STATUS_OK;
 }
 
+/**
+ * Remove auto connection data from ACData list for all devices.
+ */
 CAResult_t CAManagerRemoveAllACData(JNIEnv *env)
 {
     OIC_LOG(DEBUG, TAG, "IN - CAManagerRemoveAllACData");
@@ -315,6 +355,9 @@ CAResult_t CAManagerRemoveAllACData(JNIEnv *env)
     return CA_STATUS_OK;
 }
 
+/**
+ * Get isAutoConnecting flag for the address.
+ */
 CAResult_t CAManagerGetAutoConnectingFlag(JNIEnv *env, jstring jaddress, bool *flag)
 {
     OIC_LOG(DEBUG, TAG, "CAManagerGetAutoConnectingFlag");
@@ -373,6 +416,9 @@ CAResult_t CAManagerGetAutoConnectingFlag(JNIEnv *env, jstring jaddress, bool *f
     return CA_STATUS_FAILED;
 }
 
+/**
+ * Set isAutoConnecting flag for the address.
+ */
 bool CAManagerSetAutoConnectingFlag(JNIEnv *env, jstring jaddress, bool flag)
 {
     OIC_LOG(DEBUG, TAG, "CAManagerSetAutoConnectingFlag");
@@ -431,17 +477,25 @@ bool CAManagerSetAutoConnectingFlag(JNIEnv *env, jstring jaddress, bool flag)
     return false;
 }
 
+/**
+ * Get length of auto connection list.
+ */
 size_t CAManagerGetACDataLength()
 {
     return u_arraylist_length(g_deviceACDataList);
 }
-
+/**
+ * Set BT adapter recovery flag.
+ */
 void CAManagerSetBTRecovery(bool flag)
 {
     g_isBTRecovery = flag;
     OIC_LOG_V(DEBUG, TAG, "BT recovery flag is set to %d", g_isBTRecovery);
 }
 
+/**
+ * Get BT adapter recovery flag.
+ */
 bool CAManagerIsRecoveryFlagSet()
 {
     return g_isBTRecovery;