summaryrefslogtreecommitdiff
path: root/include/net_connection_private.h
blob: cc8825f8eec8a3707daca02b6000a75a067d56b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/*
 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License. 
 */



#ifndef __NET_CONNECTION_PRIVATE_H__        /* To prevent inclusion of a header file twice */
#define __NET_CONNECTION_PRIVATE_H__

#include <net_connection.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef struct _connection_handle_s
{
	connection_cb				callback;
	void					*user_data;
}connection_handle_s;


/**
 * @internal
 * @brief same as number of callbacks in connection_event_callbacks_s
 */
typedef enum
{
	LAST_DATACALL_DURATION,
	LAST_SENT_DATA_SIZE,
	LAST_RECEIVED_DATA_SIZE,
	TOTAL_DATACALL_DURATION,
	TOTAL_SENT_DATA_SIZE,
	TOTAL_RECEIVED_DATA_SIZE,
	LAST_WIFI_DATACALL_DURATION,
	LAST_WIFI_SENT_DATA_SIZE,
	LAST_WIFI_RECEIVED_DATA_SIZE,
	TOTAL_WIFI_DATACALL_DURATION,
	TOTAL_WIFI_SENT_DATA_SIZE,
	TOTAL_WIFI_RECEIVED_DATA_SIZE,

}stat_request_e;


/**
 * @brief Registers the callback to be invoked for Connection Open Response.
 * @details
 *
 *       Applications MUST call this API if they want to get the async response of connection_open() API.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @param[in] callback    Pointer to function of type (connection_cb).
 * @param[in] user_data   User data param provided by application. 
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed successfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create
 *
 * @par Example
 * @ref CONNECTION_MANAGER_EXAMPLE_1
 ******************************************************************************************/
int connection_set_open_response_cb(connection_h handle, connection_cb callback, void *user_data);

/**
 * @brief Deregisters callback for Connection Open Response.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed successfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create, #connection_set_open_response_cb
 *
******************************************************************************************/
int connection_unset_open_response_cb(connection_h handle);

/**
 * @brief Registers the callback to be invoked for Connection Close Response.
 *
 * @details
 *       Applications MUST call this API if they want to get the async response of connection_close() API.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @param[in] callback    Pointer to function of type (connection_cb).
 * @param[in] user_data   User data param provided by application.
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed successfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create
 * @par Example
 * @ref CONNECTION_MANAGER_EXAMPLE_1
 *
******************************************************************************************/
int connection_set_close_response_cb(connection_h handle, connection_cb callback, void *user_data);

/**
 * @brief Deregisters the callback for Connection Close Response.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed successfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create, #connection_set_close_response_cb
 *
******************************************************************************************/
int connection_unset_close_response_cb(connection_h handle);

/**
 * @brief Registers the callback to be invoked when the data connection get suspended by the network.
 *
 * @details
 *       Applications MUST call this API if they want to get notified of network suspend indications.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @param[in] callback    Pointer to function of type (connection_cb).
 * @param[in] user_data   User data param provided by application. 
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed successfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create
 *
******************************************************************************************/
int connection_set_suspend_indication_cb(connection_h handle, connection_cb callback, void *user_data);

/**
 * @brief Deregisters the callback for suspend indications.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed unsuccessfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create, #connection_set_suspend_indication_cb
 *
******************************************************************************************/
int connection_unset_suspend_indication_cb(connection_h handle);

/**
* @brief Registers the callback to be invoked when a suspended data connection gets resumed by the network.
 *
 * @details
 *       Applications MUST call this API if they want to get notified of network resume indications.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @param[in] callback    Pointer to function of type (connection_cb).
 * @param[in] user_data   User data param provided by application.
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed unsuccessfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create
 *
******************************************************************************************/
int connection_set_resume_indication_cb(connection_h handle, connection_cb callback, void *user_data);

/**
 * @brief Deregisters the callback for resume indications.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed successfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create, #connection_set_resume_indication_cb
 *
******************************************************************************************/
int connection_unset_resume_indication_cb(connection_h handle);

/**
 * @brief Registers the callback to be invoked network status changes.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @param[in] callback    Pointer to function of type (connection_cb).
 * @param[in] user_data   User data param provided by application. 
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed successfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create
 *
******************************************************************************************/
int connection_set_network_status_indication_cb(connection_h handle, connection_cb callback, void *user_data);

/**
 * @brief Deregisters the callback for network status change indications.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed successfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create, #connection_set_network_status_indication_cb
 *
******************************************************************************************/
int connection_unset_network_status_indication_cb(connection_h handle);

/**
 * @brief Registers the callback to be invoked IP Address changes.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @param[in] callback    Pointer to function of type (connection_cb).
 * @param[in] user_data   User data param provided by application. 
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed successfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create
 *
******************************************************************************************/
int connection_set_ip_changed_cb(connection_h handle, connection_cb callback, void *user_data);

/**
 * @brief Deregisters the callback for IP changed indications.
 *
 * @param[in] handle      Handle received as a result of connection_create() API.
 * @return 0 on success, otherwise negative error value.
 * @retval CONNECTION_ERROR_NONE - the operation has completed successfully.
 * @retval TIZEN_ERROR_INVALID_PARAMETER - handle is invalid or callback is null
 * @pre #connection_create, #connection_set_ip_changed_cb
 *
******************************************************************************************/
int connection_unset_ip_changed_cb(connection_h handle);


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif