diff -r 000000000000 -r 6474c204b198 media/webrtc/signaling/src/sipcc/include/config_api.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/media/webrtc/signaling/src/sipcc/include/config_api.h Wed Dec 31 06:09:35 2014 +0100 @@ -0,0 +1,120 @@ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#ifndef _CONFIG_API_H_ +#define _CONFIG_API_H_ + +#include "cc_types.h" + + +/** + * configFetchReq + * + * This function tells the config manager to fetch the CTL file + * and then fetch the config from the CUCM. It is expected that + * this will result in processing of + * the config file after the config managers response is received. + * + * The response received for this request is asynchronous and + * should be handled via event provided by config manager. + * The CCAPI_Config_reponse api needs to be called for the + * handling of the response to the fetch request + * + */ +void configFetchReq(int device_handle); + +/** + * configParserError + * + * Notify the config manager that the config file has an error + * and a new config file needs to be downloaded. + * + * The error could be XML format error or minimum config not being + * present in the config file. It is expected that + * this will result in processing of + * the config file after the config managers response is received. + * + */ +void configParserError(void); + +/** + * When called this function should register with CUCM without prior device file download. + */ +void CCAPI_Start_response(int device_handle, const char *device_name, const char *sipUser, const char *sipPassword, const char *sipDomain); + +/** + * Inform application that pSipcc stack has receive a NOTIFY message of event + * type "service-control" and action=apply-config. The arguments passed to this + * function contains the parameter values received in the message. + * + * @param config_version [in] latest version stamp of phone configuration. + * @param dial_plan_version [in] latest version stamp of the dial plan. + * @param fcp_version [in] latest version stamp of feature policy control. + * @param cucm_result [in] action taken by the cucm for the changes applied by the + * user to the phone configuration. cucm result could be + * @li "no_change" - the new phone configuration changes do not impact Unified CM, + * @li "config_applied" - The Unified CM Administration applied the + * configuration changes dynamically without requiring phone to re-register, + * @li "reregister_needed" - The Unified CM Administration applied the + * configuration changes and required the phone to re-register to make them + * effective. + * @param load_id [in] - firmware image name that phone should be running with + * @param inactive_load_id [in] - firmware image name that phone should be in inactive partition. + * @param load_server [in] - address of load server to download the firmware + * image load_id. + * @param log_server [in] - log server address where error report need to be + * sent. Error report, for example, could be related to image download failure + * or phone configuration file download failure. + * @param ppid [in] whether peer to peer upgrade is available + * @return void + */ +void configApplyConfigNotify(cc_string_t config_version, + cc_string_t dial_plan_version, + cc_string_t fcp_version, + cc_string_t cucm_result, + cc_string_t load_id, + cc_string_t inactive_load_id, + cc_string_t load_server, + cc_string_t log_server, + cc_boolean ppid); + +/** + * dialPlanFetchReq + * + * This function tells the get file request service to fetch the latest dial + * plan from the CUCM. + * + * @param device_handle [in] handle of the device, the response is for + * @param dialPlanFileName [in] the name of dialplan file to retrieve + * @return cc_boolean indicating success/failure + * + */ +cc_boolean dialPlanFetchReq(int device_handle, char* dialPlanFileName); + +/** + * fcpFetchReq + * + * This function tells the get file request service to fetch the latest fcp + * file from the CUCM. + * + * @param device_handle [in] handle of the device, the response is for + * @param dialPlanFileName [in] the name of fcp file to retrieve +* @return cc_boolean indicating success/failure + * + */ +cc_boolean fcpFetchReq(int device_handle, char* fcpFileName); + + +cc_boolean CCAPI_Config_set_server_address(const char *ip_address); +cc_boolean CCAPI_Config_set_transport_udp(const cc_boolean is_udp); +cc_boolean CCAPI_Config_set_local_voip_port(const int port); +cc_boolean CCAPI_Config_set_remote_voip_port(const int port); +int CCAPI_Config_get_local_voip_port(); +int CCAPI_Config_get_remote_voip_port(); +const char* CCAPI_Config_get_version(); +cc_boolean CCAPI_Config_set_p2p_mode(const cc_boolean is_p2p); +cc_boolean CCAPI_Config_set_sdp_mode(const cc_boolean is_sdp); +cc_boolean CCAPI_Config_set_avp_mode(const cc_boolean is_rtpsavpf); + +#endif /* _CONFIG_API_H_ */