X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=resource%2Fcsdk%2Fconnectivity%2Fsrc%2Fbt_le_adapter%2Ftizen%2Fcableclient.h;h=d4a96fcd9ab62dfecd823bce00dd4be117f1b47a;hb=17c68b2fd1e74586f85e552eeab4e32dc121f8a0;hp=b220a015b5c4ae1decb7876b86f921666a8f0dcd;hpb=8c01dff2c5bc5496f7dc1632c498943ec6ecb015;p=platform%2Fupstream%2Fiotivity.git diff --git a/resource/csdk/connectivity/src/bt_le_adapter/tizen/cableclient.h b/resource/csdk/connectivity/src/bt_le_adapter/tizen/cableclient.h index b220a01..d4a96fc 100644 --- a/resource/csdk/connectivity/src/bt_le_adapter/tizen/cableclient.h +++ b/resource/csdk/connectivity/src/bt_le_adapter/tizen/cableclient.h @@ -46,50 +46,52 @@ /** - * @brief This is the callback which will be called after the characteristic value changes happen. + * This is the callback which will be called after the characteristic + * value changes happen. * - * @param characteristic [IN] The attribute handle of characteristic - * @param value [IN] Value of the characteristics of a service. - * @param valueLen [IN] length of data. - * @param userData [IN] The user data passed from the request function - * @return NONE + * @param[in] characteristic The attribute handle of characteristic. + * @param[in] value Value of the characteristics of a service. + * @param[in] valueLen length of data. + * @param[in] userData The user data passed from the request function. */ void CABleGattCharacteristicChangedCb(bt_gatt_attribute_h characteristic, - unsigned char *value, int valueLen, void *userData); + unsigned char *value, + int valueLen, + void *userData); /** - * @brief This is the callback which will be called after the characteristics changed. + * This is the callback which will be called after the characteristics changed. * - * @param result [IN] result of write value - * @param userData [IN] user context - * - * @return NONE + * @param[in] result result of write value. + * @param[in] userData user context. */ void CABleGattCharacteristicWriteCb(int result, void *userData); /** - * @brief This is the callback which will be called when descriptor of characteristics is found. + * This is the callback which will be called when descriptor of + * characteristics is found. * - * @param result [IN] The result of discovering - * @param format [IN] format of descriptor. - * @param total [IN] The total number of descriptor in a characteristic - * @param descriptor [IN] The attribute handle of descriptor - * @param characteristic [IN] The attribute handle of characteristic - * @param userData [IN] The user data passed from the request function - * @return NONE + * @param[in] result The result of discovering. + * @param[in] format format of descriptor. + * @param[in] total The total number of descriptor in a + * characteristic. + * @param[in] descriptor The attribute handle of descriptor. + * @param[in] characteristic The attribute handle of characteristic. + * @param[in] userData The user data passed from the request function. */ void CABleGattDescriptorDiscoveredCb(int result, unsigned char format, int total, bt_gatt_attribute_h descriptor, bt_gatt_attribute_h characteristic, void *userData); /** - * @brief This is the callback which will be called after the characteristics are discovered by - * bt_gatt_discover_characteristics() + * This is the callback which will be called after the characteristics are + * discovered by bt_gatt_discover_characteristics(). * - * @param result [IN] The result of discovering - * @param inputIndex [IN] The index of characteristics in a service, starts from 0 - * @param total [IN] The total number of characteristics in a service - * @param characteristic [IN] The attribute handle of characteristic - * @param userData [IN] The user data passed from the request function + * @param[in] result The result of discovering. + * @param[in] inputIndex The index of characteristics in a service, + * starts from 0. + * @param[in] total The total number of characteristics in a service. + * @param[in] characteristic The attribute handle of characteristic. + * @param[in] userData The user data passed from the request function. * * @return 0 on failure and 1 on success. */ @@ -97,12 +99,14 @@ bool CABleGattCharacteristicsDiscoveredCb(int result, int inputIndex, int total, bt_gatt_attribute_h characteristic, void *userData); /** - * @brief This is the callback which will be called when we get the primary services repeatedly. + * This is the callback which will be called when we get the primary + * services repeatedly. * - * @param service [IN] The attribute handle of service. Unique identifier for service. - * @param index [IN] The current index of the service - * @param count [IN] Total number of services available in remote device - * @param userData [IN] user data + * @param[in] service The attribute handle of service. Unique identifier + * for service. + * @param[in] index The current index of the service. + * @param[in] count Total number of services available in remote device. + * @param[in] userData user data. * * @return 0 on failure and 1 on success. */ @@ -110,28 +114,26 @@ bool CABleGattPrimaryServiceCb(bt_gatt_attribute_h service, int index, int count void *userData); /** - * @brief This is the callback which will be called whenever there is change in gatt connection - * with server(Connected/Disconnected) - * - * @param result [IN] The result of discovering - * @param connected [IN] State of connection - * @param remoteAddress [IN] Mac address of the remote device in which we made connection. - * @param userData [IN] The user data passed from the request function + * This is the callback which will be called whenever there is change in + * gatt connection with server(Connected/Disconnected) * - * @return NONE + * @param[in] result The result of discovering. + * @param[in] connected State of connection. + * @param[in] remoteAddress Mac address of the remote device in which we + * made connection. + * @param[in] userData The user data passed from the request function. */ void CABleGattConnectionStateChangedCb(int result, bool connected, const char *remoteAddress,void *userData); /** - * @brief This is the callback which will be called when the device discovery state changes. + * This is the callback which will be called when the device discovery + * state changes. * - * @param result [IN] The result of discovering - * @param discoveryState [IN] State of the discovery(FOUND/STARTED/ FINISHED) - * @param discoveryInfo [IN] Remote Device information. - * @param userData [IN] The user data passed from the request function - * - * @return NONE + * @param[in] result The result of discovering. + * @param[in] discoveryState State of the discovery(FOUND/STARTED/ FINISHED). + * @param[in] discoveryInfo Remote Device information. + * @param[in] userData The user data passed from the request function. */ void CABtAdapterLeDeviceDiscoveryStateChangedCb(int result, bt_adapter_le_device_discovery_state_e discoveryState, @@ -139,258 +141,256 @@ void CABtAdapterLeDeviceDiscoveryStateChangedCb(int result, void *userData); /** - * @brief Used to print device information(Util method) - * @param discoveryInfo [IN] Device information structure. - * @return NONE + * Used to print device information(Util method). + * @param[in] discoveryInfo Device information structure. */ void CAPrintDiscoveryInformation(const bt_adapter_le_device_discovery_info_s *discoveryInfo); /** - * @brief This thread will be used to initialize the Gatt Client and start device discovery. - * 1. Set scan parameters - * 2. Setting neccessary callbacks for connection, characteristics changed and discovery. - * 3. Start device discovery - * - * @param data [IN] Currently it will be NULL(no parameter) - * - * @return NONE + * This thread will be used to initialize the Gatt Client and start device + * discovery. + * 1. Set scan parameters. + * 2. Setting neccessary callbacks for connection, characteristics + * changed and discovery. + * 3. Start device discovery. * + * @param[in] data Currently it will be NULL(no parameter). */ void CAStartBleGattClientThread(void *data); /** - * @brief Used to initialize all required mutex variable for Gatt Client implementation. + * Used to initialize all required mutex variable for Gatt Client + * implementation. * - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CAInitGattClientMutexVariables(); /** - * @brief Used to terminate all required mutex variable for Gatt Client implementation. - * @return NONE + * Used to terminate all required mutex variable for Gatt Client implementation. */ void CATerminateGattClientMutexVariables(); /** - * @brief Used to clear NonOICDeviceList - * @return NONE + * Used to clear NonOICDeviceList. */ void CAClearNonOICDeviceList(); /** - * @brief Used to set scan parameter of starting discovery. + * Used to set scan parameter of starting discovery. * - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CABleGattSetScanParameter(); /** - * @brief Used to register required callbacks to BLE platform(connection, discovery, etc). + * Used to register required callbacks to BLE platform(connection, + * discovery, etc). * - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CABleGattSetCallbacks(); /** - * @brief Used to unset all the registerd callbacks to BLE platform - * @return NONE + * Used to unset all the registerd callbacks to BLE platform. */ void CABleGattUnSetCallbacks(); /** - * @brief Used to watch all the changes happening in characteristics of the service. + * Used to watch all the changes happening in characteristics of the service. * - * @param service [IN] The attribute handle of the service. + * @param[in] service The attribute handle of the service. * - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CABleGattWatchCharacteristicChanges(bt_gatt_attribute_h service); /** - * @brief Used to unwatch characteristics changes using bt_gatt_unwatch_characteristic_changes - * @return NONE + * Used to unwatch characteristics changes using + * bt_gatt_unwatch_characteristic_changes(). */ void CABleGattUnWatchCharacteristicChanges(); /** - * @brief Used to start LE discovery for BLE devices + * Used to start LE discovery for BLE devices. * - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CABleGattStartDeviceDiscovery(); /** - * @brief Used to stop LE discovery for BLE devices - * @return NONE + * Used to stop LE discovery for BLE devices. */ void CABleGattStopDeviceDiscovery(); /** - * @brief This is the thread which will be used for making gatt connection with remote devices - * @param remoteAddress [IN] MAC address of remote device to connect - * @return NONE + * This is the thread which will be used for making gatt connection with + * remote devices. + * @param[in] remoteAddress MAC address of remote device to connect. */ void CAGattConnectThread (void *remoteAddress); /** - * @brief Used to do connection with remote device + * Used to do connection with remote device. * - * @param remoteAddress [IN] Remote address inwhich we wants to connect with + * @param[in] remoteAddress Remote address inwhich we wants to connect with. * - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CABleGattConnect(const char *remoteAddress); /** - * @brief Used to do disconnection with remote device - * @param remoteAddress [IN] Remote address inwhich we wants to disconnect with + * Used to do disconnection with remote device. + * @param[in] remoteAddress Remote address inwhich we wants to disconnect with. * - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CABleGattDisConnect(const char *remoteAddress); /** - * @brief This is thread which will be spawned for discovering ble services. Once called discover - * api, then it will be terminated. - * @param remoteAddress [IN] Mac address of the remote device in which we want to search services. - * @return NONE + * This is thread which will be spawned for discovering ble services. Once + * called discover api, then it will be terminated. + * @param[in] remoteAddress Mac address of the remote device in which we + * want to search services. */ void CADiscoverBLEServicesThread (void *remoteAddress); /** - * @brief Used to discover the services that is advertised by Gatt Server asynchrounously. + * Used to discover the services that is advertised by Gatt Server + * asynchronously. * - * @param remoteAddress [IN] MAC address of remote device in which we want to discover the services. + * @param[in] remoteAddress MAC address of remote device in which we want + * to discover the services. * - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CABleGattDiscoverServices(const char *remoteAddress); /** - * @brief This is the thread which will be used for finding characteristic of a service. + * This is the thread which will be used for finding characteristic of a + * service. * - * @param stServiceInfo [IN] Service Information which contains the remote address, service - * handle and characteristic handle. - * @return NONE + * @param[in] stServiceInfo Service Information which contains the remote + * address, service handle and characteristic handle. */ void CADiscoverCharThread(void *stServiceInfo); /** - * @brief Used to discover characteristics of service using bt_gatt_discover_characteristics api. + * Used to discover characteristics of service using + * bt_gatt_discover_characteristics() api. * - * @param service [IN] The attribute handle for service. - * @param remoteAddress [IN] Remote address inwhich we wants to discover characteristics of - * given service handle. - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @param[in] service The attribute handle for service. + * @param[in] remoteAddress Remote address inwhich we wants to discover + * characteristics of given service handle. + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CABleGattDiscoverCharacteristics(bt_gatt_attribute_h service, const char *remoteAddress); /** - * @brief This is the thread which will be used for finding descriptor of characteristic. + * This is the thread which will be used for finding descriptor of + * characteristic. * - * @param stServiceInfo [IN] Service Information which contains the remote address, service - * handle and characteristic handle. - * @return NONE + * @param[in] stServiceInfo Service Information which contains the remote + * address, service handle and characteristic handle. */ void CADiscoverDescriptorThread(void *stServiceInfo); /** - * @brief This is thread which will be used for calling CASetCharacteristicDescriptorValue api. + * This is thread which will be used for calling + * CASetCharacteristicDescriptorValue() api. * - * @param service [IN] The attribute handle for characteristics. - * @param remoteAddress [IN] Remote address inwhich we wants to discover descriptor of given - * char handle. - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @param[in] service The attribute handle for characteristics. + * @param[in] remoteAddress Remote address inwhich we wants to discover + * descriptor of given char handle. + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CABleGattDiscoverDescriptor(bt_gatt_attribute_h service, const char *remoteAddress); /** - * @brief This is thread which will be used for calling CASetCharacteristicDescriptorValue api. + * This is thread which will be used for calling + * CASetCharacteristicDescriptorValue() api. * - * @param stServiceInfo [IN] Service Information which contains the remote address, service - * handle and characteristic handle. - * @return NONE + * @param[in] stServiceInfo Service Information which contains the remote + * address, service handle and characteristic handle. */ void CASetCharacteristicDescriptorValueThread(void *stServiceInfo); /** - * @brief Used to set characteristic descriptor value using - * bt_gatt_set_characteristic_desc_value_request api. - * @param stGattCharDescriptorInfo [IN] Structure which contains char handle and descriptor handle. + * Used to set characteristic descriptor value using + * bt_gatt_set_characteristic_desc_value_request() api. + * @param[in] stGattCharDescriptorInfo Structure which contains char + * handle and descriptor handle. * - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CASetCharacteristicDescriptorValue (stGattCharDescriptor_t *stGattCharDescriptorInfo); /** - * @brief Used to enqueue the message into sender queue using CAAdapterEnqueueMessage and make - * signal to the thread to process. + * Used to enqueue the message into sender queue using + * CAAdapterEnqueueMessage() and make signal to the thread to process. * - * @param remoteEndpoint [IN] Remote device information - * @param data [IN] Data to be sent to remote device - * @param dataLen [IN] Length of data. + * @param[in] remoteEndpoint Remote device information. + * @param[in] data Data to be sent to remote device. + * @param[in] dataLen Length of data.. * - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CABleClientSenderQueueEnqueueMessage (const CAEndpoint_t *remoteEndpoint, - const void *data, uint32_t dataLen); + const uint8_t *data, uint32_t dataLen); /** - * @brief This is the thread which will be used for processing sender queue. - * - * @return NONE + * This is the thread which will be used for processing sender queue. */ void CABleClientSenderQueueProcessor(); /** - * @brief Synchronous function for reading characteristic value. + * Synchronous function for reading characteristic value. * - * @return #CA_STATUS_OK or Appropriate error code - * @retval #CA_STATUS_OK Successful - * @retval #CA_STATUS_INVALID_PARAM Invalid input argumets - * @retval #CA_STATUS_FAILED Operation failed + * @return ::CA_STATUS_OK or Appropriate error code. + * @retval ::CA_STATUS_OK Successful. + * @retval ::CA_STATUS_INVALID_PARAM Invalid input arguments. + * @retval ::CA_STATUS_FAILED Operation failed. */ CAResult_t CALEReadDataFromLEClient(); #endif /* TZ_BLE_CLIENT_H_ */ -