upgrade gatt connection performence
[platform/upstream/iotivity.git] / resource / csdk / connectivity / src / bt_le_adapter / android / caleclient.h
1 /* ****************************************************************
2  *
3  * Copyright 2014 Samsung Electronics All Rights Reserved.
4  *
5  *
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  ******************************************************************/
20
21 /**
22  * @file
23  * This file contains the APIs for BT LE communications.
24  */
25 #ifndef CA_LECLIENT_H_
26 #define CA_LECLIENT_H_
27
28 #include "cacommon.h"
29 #include "cathreadpool.h"
30 #include "uarraylist.h"
31 #include "jni.h"
32
33 #ifdef __cplusplus
34 extern "C"
35 {
36 #endif
37
38 static const uint16_t GATT_ERROR = 133;
39
40 static const uint16_t STATE_CHARACTER_SET = 2;
41 static const uint16_t STATE_CHARACTER_UNSET = 1;
42 static const uint16_t STATE_CHARACTER_NO_CHANGE = 0;
43
44 static const uint16_t STATE_SEND_NONE = 0;
45 static const uint16_t STATE_SEND_SUCCESS = 1;
46 static const uint16_t STATE_SEND_FAILED = 2;
47
48 static const jint STATE_CONNECTED = 2;
49 static const jint STATE_DISCONNECTED = 0;
50
51 typedef struct le_state_info
52 {
53     char address[CA_MACADDR_SIZE];
54     jint connectedState;
55     uint16_t notificationState;
56     uint16_t sendState;
57 } CALEState_t;
58
59 /**
60  * Callback to be notified on reception of any data from remote devices.
61  * @param[in]  address                MAC address of remote device.
62  * @param[in]  data                   Data received from remote device.
63  * @pre  Callback must be registered using CALESetCallback(CAPacketReceiveCallback callback)
64  */
65 typedef void (*CAPacketReceiveCallback)(const char *address, const uint8_t *data);
66
67 /**
68  * initialize JNI object.
69  */
70 void CALEClientJniInit();
71
72 /**
73  * set context of application.
74  */
75 void CALEClientJNISetContext();
76
77 /**
78  * create interface object and initialize the object.
79  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
80  */
81 CAResult_t CALEClientCreateJniInterfaceObject();
82
83 /**
84  * initialize client for BLE.
85  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
86  */
87 CAResult_t CALEClientInitialize();
88
89 /**
90  * terminate client for BLE.
91  */
92 void CALEClientTerminate();
93
94 /**
95  * destroy interface object and terminate the interface.
96  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
97  */
98 CAResult_t CALEClientDestroyJniInterface();
99
100 /**
101  * for destroy sending routine.
102  * @param[in]   env                   JNI interface pointer.
103  * @param[in]   gatt                  Gatt profile object.
104  */
105 void CALEClientSendFinish(JNIEnv *env, jobject gatt);
106
107 /**
108  * send data for unicast (interface).
109  * @param[in]   address               remote address.
110  * @param[in]   data                  data for transmission.
111  * @param[in]   dataLen               data length.
112  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
113  */
114 CAResult_t CALEClientSendUnicastMessage(const char *address, const uint8_t *data,
115                                         const uint32_t dataLen);
116
117 /**
118  * send data for multicast (interface).
119  * @param[in]   data                  data for transmission.
120  * @param[in]   dataLen               data length.
121  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
122  */
123 CAResult_t CALEClientSendMulticastMessage(const uint8_t *data, const uint32_t dataLen);
124
125 /**
126  * start unicast server.
127  * @param[in]   address               remote address.
128  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
129  */
130 CAResult_t CALEClientStartUnicastServer(const char *address);
131
132 /**
133  * start multicast server (start discovery).
134  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
135  */
136 CAResult_t CALEClientStartMulticastServer();
137
138 /**
139  * stop unicast server.
140  */
141 void CALEClientStopUnicastServer();
142
143 /**
144  * stop multicast server (stop discovery).
145  */
146 void CALEClientStopMulticastServer();
147
148 /**
149  * set this callback for receiving data packets from peer devices.
150  * @param[in]   callback              callback to be notified on reception of
151  *                                    unicast/multicast data packets.
152  */
153 void CALEClientSetCallback(CAPacketReceiveCallback callback);
154
155 /**
156  * waiting to get scanned device from BT Platform.
157  * if there is no scanned device in the list.
158  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
159  */
160 CAResult_t CALEClientIsThereScannedDevices();
161
162 /**
163  * send data for unicast (implement).
164  * @param[in]   address               remote address.
165  * @param[in]   data                  data for transmission.
166  * @param[in]   dataLen               data length.
167  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
168  */
169 CAResult_t CALEClientSendUnicastMessageImpl(const char *address, const uint8_t *data,
170                                             const uint32_t dataLen);
171
172 /**
173  * send data for multicast (implement).
174  * @param[in]   env                   JNI interface pointer.
175  * @param[in]   data                  data for transmission.
176  * @param[in]   dataLen               data length.
177  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
178  */
179 CAResult_t CALEClientSendMulticastMessageImpl(JNIEnv *env, const uint8_t *data,
180                                               const uint32_t dataLen);
181
182 /**
183  * check whether it is connected or not with remote address.
184  * @param[in]   address               remote address.
185  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
186  */
187 CAResult_t CALECheckSendState(const char* address);
188
189 /**
190  * send data to remote device.
191  * if it isn't connected yet. connect LE before try to send data.
192  * @param[in]   env                   JNI interface pointer.
193  * @param[in]   device                bluetooth device object.
194  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
195  */
196 CAResult_t CALEClientSendData(JNIEnv *env, jobject device);
197
198 /**
199  * get address from bluetooth gatt object.
200  * @param[in]   env                   JNI interface pointer.
201  * @param[in]   gatt                  Gatt profile object.
202  * @return  bluetooth address.
203  */
204 jstring CALEClientGetAddressFromGattObj(JNIEnv *env, jobject gatt);
205
206 /**
207  * get remote address from bluetooth socket object.
208  * @param[in]   env                   JNI interface pointer.
209  * @param[in]   bluetoothSocketObj    bluetooth socket.
210  * @return  bluetooth address.
211  */
212 jstring CALEClientGetRemoteAddress(JNIEnv *env, jobject bluetoothSocketObj);
213
214 /**
215  * close gatt.
216  * @param[in]   env                   JNI interface pointer.
217  * @param[in]   bluetoothGatt         gatt profile object.
218  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
219  */
220 CAResult_t CALEClientGattClose(JNIEnv *env, jobject bluetoothGatt);
221
222 /**
223  * start to scan whole bluetooth devices (interface).
224  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
225  */
226 CAResult_t CALEClientStartScan();
227
228 /**
229  * start to scan whole bluetooth devices (implement).
230  * @param[in]   env                   JNI interface pointer.
231  * @param[in]   callback              callback to receive device object by scanning.
232  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
233  */
234 CAResult_t CALEClientStartScanImpl(JNIEnv *env, jobject callback);
235
236 /**
237  * start to scan target bluetooth devices for service uuid (implement).
238  * @param[in]   env                   JNI interface pointer.
239  * @param[in]   uuids                 target UUID.
240  * @param[in]   callback              callback to receive device object by scanning.
241  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
242  */
243 CAResult_t CALEClientStartScanWithUUIDImpl(JNIEnv *env, jobjectArray uuids,
244                                            jobject callback);
245
246 /**
247  * get uuid object.
248  * @param[in]   env                   JNI interface pointer.
249  * @param[in]   uuid                  uuid.
250  * @return  uuid object.
251  */
252 jobject CALEClientGetUUIDObject(JNIEnv *env, const char *uuid);
253
254 /**
255  * stop scan (interface).
256  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
257  */
258 CAResult_t CALEClientStopScan();
259
260 /**
261  * set ble scanning flag.
262  * @param[in]   flag        scan flag.
263  */
264 void CALEClientSetScanFlag(bool flag);
265
266 /**
267  * stop scan (implement).
268  * @param[in]   env                   JNI interface pointer.
269  * @param[in]   callback              callback to receive device object by scanning.
270  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
271  */
272 CAResult_t CALEClientStopScanImpl(JNIEnv *env, jobject callback);
273
274 /**
275  * set auto connect flag for connectGatt API.
276  * @param[in]   flag        auto connect flag.
277  */
278 void CALEClientSetAutoConnectFlag(jboolean flag);
279
280 /**
281  * get auto connect flag.
282  * @return  current auto connect flag;
283  */
284 jboolean CALEClientGetAutoConnectFlag();
285
286 /**
287  * connect to gatt server hosted.
288  * @param[in]   env                   JNI interface pointer.
289  * @param[in]   bluetoothDevice       bluetooth Device object.
290  * @param[in]   autoconnect           whether to directly connect to the remote device(false) or
291  *                                     to automatically connect as soon as the remote device
292  *                                     becomes available.
293  * @return  gatt object
294  */
295 jobject CALEClientConnect(JNIEnv *env, jobject bluetoothDevice, jboolean autoconnect);
296
297 /**
298  * disconnect to gatt server by a target device.
299  * @param[in]   env                   JNI interface pointer.
300  * @param[in]   bluetoothGatt         Gatt profile object.
301  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
302  */
303 CAResult_t CALEClientDisconnect(JNIEnv *env, jobject bluetoothGatt);
304
305 /**
306  * disconnect to gatt server by whole devices.
307  * @param[in]   env                   JNI interface pointer.
308  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
309  */
310 CAResult_t CALEClientDisconnectAll(JNIEnv *env);
311
312 /**
313  * disconnect to gatt server by selected address.
314  * @param[in]   env                   JNI interface pointer.
315  * @param[in]   remoteAddress         remote address.
316  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
317  */
318 CAResult_t CALEClientDisconnectforAddress(JNIEnv *env, jstring remoteAddress);
319
320 /**
321  * start discovery server.
322  * @param[in]   env                   JNI interface pointer.
323  * @param[in]   bluetoothGatt         Gatt profile object.
324  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
325  */
326 CAResult_t CALEClientDiscoverServices(JNIEnv *env, jobject bluetoothGatt);
327
328 /**
329  * call CALESetValueAndWriteCharacteristic when connection is successful.
330  * @param[in]   env                   JNI interface pointer.
331  * @param[in]   gatt                  Gatt profile object.
332  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
333  */
334 CAResult_t CALEClientWriteCharacteristic(JNIEnv *env, jobject gatt);
335
336 /**
337  * create GattCharacteristic and call CALEClientWriteCharacteristicImpl
338  * for request to write gatt characteristic.
339  * @param[in]   env                   JNI interface pointer.
340  * @param[in]   gatt                  Gatt profile object.
341  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
342  */
343 CAResult_t CALESetValueAndWriteCharacteristic(JNIEnv *env, jobject gatt);
344
345 /**
346  * request to write gatt characteristic.
347  * @param[in]   env                   JNI interface pointer.
348  * @param[in]   bluetoothGatt         Gatt profile object.
349  * @param[in]   gattCharacteristic    characteristic object that contain data to send.
350  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
351  */
352 CAResult_t CALEClientWriteCharacteristicImpl(JNIEnv *env, jobject bluetoothGatt,
353                                              jobject gattCharacteristic);
354
355 /**
356  * request to read gatt characteristic.
357  * @param[in]   env                   JNI interface pointer.
358  * @param[in]   bluetoothGatt         Gatt profile object.
359  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
360  */
361 CAResult_t CALEClientReadCharacteristic(JNIEnv *env, jobject bluetoothGatt);
362
363 /**
364  * enable notification for a target device.
365  * @param[in]   env                   JNI interface pointer.
366  * @param[in]   bluetoothGatt         Gatt profile object.
367  * @param[in]   characteristic        Characteristic object.
368  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
369  */
370 CAResult_t CALEClientSetCharacteristicNotification(JNIEnv *env, jobject bluetoothGatt,
371                                                   jobject characteristic);
372
373 /**
374  * create gatt characteristic object.
375  * @param[in]   env                   JNI interface pointer.
376  * @param[in]   bluetoothGatt         Gatt profile object.
377  * @param[in]   data                  for make Characteristic with data.
378  * @return  Gatt Characteristic object.
379  */
380 jobject CALEClientCreateGattCharacteristic(JNIEnv *env, jobject bluetoothGatt, jbyteArray data);
381
382 /**
383  * get gatt service.
384  * @param[in]   env                   JNI interface pointer.
385  * @param[in]   bluetoothGatt         Gatt profile object.
386  * @param[in]   characterUUID         for make BluetoothGattCharacteristic object.
387  * @return  Gatt Service.
388  */
389 jobject CALEClientGetGattService(JNIEnv *env, jobject bluetoothGatt, jstring characterUUID);
390
391 /**
392  * get value from characteristic.
393  * @param[in]   env                   JNI interface pointer.
394  * @param[in]   characteristic        Characteristic object.
395  * @return  value in characteristic.
396  */
397 jbyteArray CALEClientGetValueFromCharacteristic(JNIEnv *env, jobject characteristic);
398
399 /**
400  * create UUID List.
401  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
402  */
403 CAResult_t CALEClientCreateUUIDList();
404
405 /**
406  * set UUID to descriptor.
407  * @param[in]   env                   JNI interface pointer.
408  * @param[in]   bluetoothGatt         Gatt profile object.
409  * @param[in]   characteristic        Characteristic object.
410  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
411  */
412 CAResult_t CALEClientSetUUIDToDescriptor(JNIEnv *env, jobject bluetoothGatt,
413                                          jobject characteristic);
414
415 /**
416  * add device object to scan device list.
417  * @param[in]   env                   JNI interface pointer.
418  * @param[in]   device                bluetooth device object.
419  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
420  */
421 CAResult_t CALEClientAddScanDeviceToList(JNIEnv *env, jobject device);
422
423 /**
424  * check whether the device exist in list or not.
425  * @param[in]   env                   JNI interface pointer.
426  * @param[in]   remoteAddress         remote address.
427  * @return  true or false.
428  */
429 bool CALEClientIsDeviceInScanDeviceList(JNIEnv *env, const char *remoteAddress);
430
431 /**
432  * remove all devices in scan device list.
433  * @param[in]   env                   JNI interface pointer.
434  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
435  */
436 CAResult_t CALEClientRemoveAllScanDevices(JNIEnv *env);
437
438 /**
439  * remove target device in scan device list.
440  * @param[in]   env                   JNI interface pointer.
441  * @param[in]   remoteAddress         remote address.
442  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
443  */
444 CAResult_t CALEClientRemoveDeviceInScanDeviceList(JNIEnv *env, jstring remoteAddress);
445
446 /**
447  * add gatt object to gatt object list.
448  * @param[in]   env                   JNI interface pointer.
449  * @param[in]   gatt                  Gatt profile object.
450  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
451  */
452 CAResult_t CALEClientAddGattobjToList(JNIEnv *env, jobject gatt);
453
454 /**
455  * check whether the gatt object exist in list or not.
456  * @param[in]   env                   JNI interface pointer.
457  * @param[in]   remoteAddress         remote address.
458  * @return  true or false.
459  */
460 bool CALEClientIsGattObjInList(JNIEnv *env, const char *remoteAddress);
461
462 /**
463  * get the gatt object.
464  * @param[in]   env                   JNI interface pointer.
465  * @param[in]   remoteAddress         remote address.
466  * @return  gatt object.
467  */
468 jobject CALEClientGetGattObjInList(JNIEnv *env, const char* remoteAddress);
469
470 /**
471  * remove all gatt objects in gatt object list.
472  * @param[in]   env                   JNI interface pointer.
473  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
474  */
475 CAResult_t CALEClientRemoveAllGattObjs(JNIEnv *env);
476
477 /**
478  * remove target device in gatt object list.
479  * @param[in]   env                   JNI interface pointer.
480  * @param[in]   gatt                  Gatt profile object.
481  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
482  */
483 CAResult_t CALEClientRemoveGattObj(JNIEnv *env, jobject gatt);
484
485 /**
486  * remove gatt object of target device for address in gatt object list.
487  * @param[in]   env                   JNI interface pointer.
488  * @param[in]   gatt                  Gatt profile object.
489  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
490  */
491 CAResult_t CALEClientRemoveGattObjForAddr(JNIEnv *env, jstring addr);
492
493 /**
494  * get ble address from Bluetooth device.
495  * @param[in]   env                   JNI interface pointer.
496  * @param[in]   bluetoothDevice       Bluetooth device.
497  * @return  ble address.
498  */
499 jstring CALEClientGetLEAddressFromBTDevice(JNIEnv *env, jobject bluetoothDevice);
500
501 /**
502  * update new state information.
503  * @param[in]   address               remote address.
504  * @param[in]   connectedState        connection state.
505  * @param[in]   notificationState     whether characteristic notification already set or not.
506  * @param[in]   sendState             whether sending was success or not.
507  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
508  */
509 CAResult_t CALEClientUpdateDeviceState(const char* address, uint32_t connectedState,
510                                        uint16_t notificationState, uint16_t sendState);
511
512 /**
513  * add new state to state list.
514  * @param[in]   state                 new state.
515  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
516  */
517 CAResult_t CALEClientAddDeviceStateToList(CALEState_t* state);
518
519 /**
520  * check whether the remote address is existed or not.
521  * @param[in]   address               remote address.
522  * @return  true or false.
523  */
524 bool CALEClientIsDeviceInList(const char *remoteAddress);
525
526 /**
527  * remove all device states.
528  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
529  */
530 CAResult_t CALEClientRemoveAllDeviceState();
531
532 /**
533  * remove the device state for a remote device.
534  * @param[in]   remoteAddress         remote address.
535  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
536  */
537 CAResult_t CALEClientRemoveDeviceState(const char* remoteAddress);
538
539 /**
540  * get state information for a remote device.
541  * @param[in]   remoteAddress         remote address.
542  * @return  CALEState_t.
543  */
544 CALEState_t* CALEClientGetStateInfo(const char* remoteAddress);
545
546 /**
547  * check whether the remote address is connected or not.
548  * @param[in]   remoteAddress         remote address.
549  * @return  true or false.
550  */
551 bool CALEClientIsConnectedDevice(const char* remoteAddress);
552
553 /**
554  * check whether the remote address set CharacteristicNotification or not.
555  * @param[in]   remoteAddress         remote address.
556  * @return  true or false.
557  */
558 bool CALEClientIsSetCharacteristic(const char* remoteAddress);
559
560 /**
561  * create scan device list.
562  */
563 void CALEClientCreateDeviceList();
564
565 /**
566  * update the counter which data is sent to remote device.
567  * @param[in]   env                   JNI interface pointer.
568  */
569 void CALEClientUpdateSendCnt(JNIEnv *env);
570
571 /**
572  * initialize mutex.
573  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
574  */
575 CAResult_t CALEClientInitGattMutexVaraibles();
576
577 /**
578  * terminate mutex.
579  */
580 void CALEClientTerminateGattMutexVariables();
581
582 /**
583  * set send finish flag.
584  * @param[in]   flag        finish flag.
585  */
586 void CALEClientSetSendFinishFlag(bool flag);
587
588 /**
589  * close the connection of the profile proxy to the Service.
590  * @param[in]   env                   JNI interface pointer.
591  * @param[in]   gatt                  gatt profile object.
592  * @return  ::CA_STATUS_OK or ERROR CODES (::CAResult_t error codes in cacommon.h).
593  */
594 CAResult_t CALEClientCloseProfileProxy(JNIEnv *env, jobject gatt);
595
596 /**
597  * connect to GATT Server hosted by this device.
598  * @param[in]   env                   JNI interface pointer.
599  * @param[in]   bluetoothDevice       bluetooth device object.
600  * @param[in]   autoconnect           connect as soon as the device becomes avaiable(true).
601  * @return  gatt profile object
602  */
603 jobject CALEClientGattConnect(JNIEnv *env, jobject bluetoothDevice, jboolean autoconnect);
604
605 #ifdef __cplusplus
606 } /* extern "C" */
607 #endif
608
609 #endif /* CA_LECLIENT_H_ */