[IOT-1089] Merge remote-tracking branch 'origin/master' into generic-java
[iotivity.git] / resource / csdk / connectivity / api / cautilinterface.h
1 /* ****************************************************************
2  *
3  * Copyright 2016 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 #ifndef CA_UTILS_INTERFACE_H_
22 #define CA_UTILS_INTERFACE_H_
23
24 #include "cacommon.h"
25 #ifdef __JAVA__
26 #include "jni.h"
27 #endif
28 #ifdef __cplusplus
29 extern "C"
30 {
31 #endif
32
33 /**
34  * Callback function type for connection status changes delivery.
35  * @param[out]   info           Remote endpoint information.
36  * @param[out]   isConnected    Current connection status info.
37  */
38 typedef void (*CAConnectionStateChangedCB)(const CAEndpoint_t *info, bool isConnected);
39
40 /**
41  * Callback function type for adapter status changes delivery.
42  * @param[out]   adapter    Transport type information.
43  * @param[out]   enabled    Current adapter status info.
44  */
45 typedef void (*CAAdapterStateChangedCB)(CATransportAdapter_t adapter, bool enabled);
46
47 /**
48  * Register network monitoring callback.
49  * Network status changes are delivered these callback.
50  * @param[in]   adapterStateCB  Adapter state monitoring callback.
51  * @param[in]   connStateCB     Connection state monitoring callback.
52  *
53  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_MEMORY_ALLOC_FAILED
54  */
55 CAResult_t CARegisterNetworkMonitorHandler(CAAdapterStateChangedCB adapterStateCB,
56                                            CAConnectionStateChangedCB connStateCB);
57
58 /**
59  * Unregister network monitoring callback.
60  * Network status changes are delivered these callback.
61  * @param[in]   adapterStateCB  Adapter state monitoring callback.
62  * @param[in]   connStateCB     Connection state monitoring callback.
63  *
64  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_MEMORY_ALLOC_FAILED
65  */
66 CAResult_t CAUnregisterNetworkMonitorHandler(CAAdapterStateChangedCB adapterStateCB,
67                                              CAConnectionStateChangedCB connStateCB);
68
69 /**
70  * Set device to handle for auto connection.
71  * @param[in]   address         LE address to set.
72  *
73  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED.
74  */
75 CAResult_t CASetAutoConnectionDeviceInfo(const char* address);
76
77 /**
78  * Unset device to handle for auto connection.
79  * @param[in]   address         LE address to unset.
80  *
81  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED.
82  */
83 CAResult_t CAUnsetAutoConnectionDeviceInfo(const char* address);
84
85 /**
86  * Set the port number to assign .
87  * @param[in]   adapter     Transport adapter information.
88  * @param[in]   flag        Transport flag information.
89  * @param[in]   port        The port number to use.
90  *
91  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED.
92  */
93 CAResult_t CASetPortNumberToAssign(CATransportAdapter_t adapter,
94                                    CATransportFlags_t flag, uint16_t port);
95
96 /**
97  * Get the assigned port number currently.
98  * @param[in]   adapter     Transport adapter information.
99  * @param[in]   flag        Transport flag information.
100  *
101  * @return  assigned port number information.
102  */
103 uint16_t CAGetAssignedPortNumber(CATransportAdapter_t adapter, CATransportFlags_t flag);
104
105 #ifdef __JAVA__
106 #ifdef __ANDROID__
107 /**
108  * initialize util client for android
109  * @param[in]   env                   JNI interface pointer.
110  * @param[in]   jvm                   invocation inferface for JAVA virtual machine.
111  * @param[in]   context               application context.
112  *
113  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_MEMORY_ALLOC_FAILED
114  */
115 CAResult_t CAUtilClientInitialize(JNIEnv *env, JavaVM *jvm, jobject context);
116 #else
117 /**
118  * initialize util client for android
119  * @param[in]   env                   JNI interface pointer.
120  * @param[in]   jvm                   invocation inferface for JAVA virtual machine.
121  *
122  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_MEMORY_ALLOC_FAILED
123  */
124 CAResult_t CAUtilClientInitialize(JNIEnv *env, JavaVM *jvm);
125 #endif //_ANDROID__
126
127 /**
128  * terminate util client for android
129  * @param[in]   env                   JNI interface pointer.
130  *
131  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_MEMORY_ALLOC_FAILED
132  */
133 CAResult_t CAUtilClientTerminate(JNIEnv *env);
134
135 // BT pairing
136 /**
137  * start discovery for BT device which has iotivity UUID.
138  * @param[in]  env              JNI interface pointer.
139  */
140 CAResult_t CAUtilStartScan(JNIEnv *env);
141
142 /**
143  * stop discovery
144  * @param[in]  env              JNI interface pointer.
145  */
146 CAResult_t CAUtilStopScan(JNIEnv *env);
147
148 /**
149  * bonding between devices.
150  * @param[in]  env              JNI interface pointer.
151  * @param[in]  device           bluetooth device object.
152  */
153 CAResult_t CAUtilCreateBond(JNIEnv *env, jobject device);
154
155 /**
156  * set callback listener of found device.
157  * @param[in]  listener         callback listener
158  */
159 void CAUtilSetFoundDeviceListener(jobject listener);
160
161 /**
162  * set interval time and working count for LE scan.
163  * @param[in]  intervalTime         interval time(Seconds).
164  * @param[in]  workingCount         working cycle for selected interval time.
165  *
166  * @return  ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_MEMORY_ALLOC_FAILED
167  */
168 CAResult_t CAUtilSetLEScanInterval(jint intervalTime, jint workingCount);
169
170 #endif //__JAVA__
171
172 #ifdef __cplusplus
173 } /* extern "C" */
174 #endif //__cplusplus
175
176 #endif /* CA_UTILS_INTERFACE_H_ */
177