RDK-B
dhcp6cApi.h
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's LICENSE file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2016 RDK Management
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 * @file dhcp6cApi.h
21 * @brief For CCSP Component: DHCP6-Client Status
22 *
23 * @description This header file gives the function call prototypes and structure definitions used for the RDK-Broadband DHCP6Client Status abstraction layer.
24 */
25 
26 #ifndef _DHCP6_CLIENT_API_
27 #define _DHCP6_CLIENT_API_
28 
29 /**
30  * @addtogroup DHCPV4C_HAL_APIS
31  * @{
32  */
33 
34 /* ert_dhcp6c_get_info() function */
35 /**
36 * @description Gets the E-Router Info.
37 * @param
38 * pInfo - E-Router Info(elements of structure "dhcp6cInfo_t"), to be returned
39 * @return The status of the operation.
40 * @retval STATUS_SUCCESS if successful.
41 * @retval STATUS_FAILURE if any error is detected
42 *
43 * @execution Synchronous.
44 * @sideeffect None.
45 *
46 * @note This function must not suspend and must not invoke any blocking system
47 * calls. It should probably just send a message to a driver event handler task.
48 *
49 */
50 int ert_dhcp6c_get_info(dhcp6cInfo_t *pInfo);
51 
52 /* ecm_dhcp6c_get_info() function */
53 /**
54 * @description Gets the ECM Info.
55 * @param
56 * pInfo - ECM Info(elements of structure "dhcp6cInfo_t"), to be returned
57 * @return The status of the operation.
58 * @retval STATUS_SUCCESS if successful.
59 * @retval STATUS_FAILURE if any error is detected
60 *
61 * @execution Synchronous.
62 * @sideeffect None.
63 *
64 * @note This function must not suspend and must not invoke any blocking system
65 * calls. It should probably just send a message to a driver event handler task.
66 *
67 */
68 int ecm_dhcp6c_get_info(dhcp6cInfo_t *pInfo);
69 
70 /** @} */ //END OF GROUP DHCPV4C_HAL_APIS
71 #endif
72 
73 
ecm_dhcp6c_get_info
int ecm_dhcp6c_get_info(dhcp6cInfo_t *pInfo)
ert_dhcp6c_get_info
int ert_dhcp6c_get_info(dhcp6cInfo_t *pInfo)