网管接口概要设计.doc

FLYINGVOICE 文档编号 产品版本 密级 1.00 产品名称： 共 页 网管接口文档 V1.01 北京飞音时代技术有限公司 Flying Voice Technology Limited 修订记录 日期 修订版本 描述 作者 2012-7-30 1.00 初稿完成 伊宝峰 目录 §1. 简介 4 §2. 接口形态 4 §3. 模块基本功能 4 §4. 设计要点 4 §4.1. 程序接口都为字符串形式 4 §4.2. 回调函数 4 §4.3. 信号处理 5 §4.4. 消息传递 5 §5. 接口定义 5 §5.1. 函数列表 5 §5.2. 函数说明及示例： 6 §5.2.1. 回调函数 6 §5.2.2. 状态的获取 6 §5.2.3. 状态的设置 6 §5.2.4. 参数的获取 6 §5.2.5. 参数的设置 7 §5.2.6. 保存设置的参数的flash 7 §5.2.7. 恢复设备为出厂设置 7 §5.2.8. 控制设备重启 7 §5.2.9. 程序及配置的更新, 7 §5.2.10. 记录日志到日志模块中 8 §5.2.11. 数图接口说明 8 简介 本文档主要描述了飞音时代提供的设备管理模块和SNMP程序的接口定义。 接口形态 SNMP网管作为一个独立的进程运行，设备管理模块提供一个动态链接库供SNMP进程以及其它网管模块运行时调用，同时提供一个静态链接库供编译使用。SNMP通过设备管理模块提供的接口对设备进行管理。 在使用这个网管接口时，可能会用到SIGRTMIN至SIGRTMIN+15之间的信号，用于告警和参数同步等事件通知，除非必要，请不要在模块中使用这些信号 模块基本功能 系统参数的读写及保存 系统状态的获取及报警上送 软件和配置文件的下载升级 配置文件的上传 恢复出厂设置 系统重启 设计要点 程序接口都为字符串形式 回调函数 回调函数可以处理以下事件，每个事件可以注册单独的回调函数： 网口link状态变化： “phy_link” wan ip变化（包括了interface的变化）： “wan_interface” 参数变化（包括恢复出厂设置）： “config” 注册状态改变： “register” 呼叫状态改变： “call” 程序升级结束： “upgrade” 重启： “reboot” 信号处理 采用SIGRTMIN之上的信号，共32个可以用，这些信号可以可靠发送，不会丢失。（sigqueue函数可以支持带参数的信号但是uclibc不支持这个函数） 消息传递 因为信号本身就是异步的，程序收到信号后无论是由设备管理库获取相应信息然后通过回调函数传给网管设备，还是直接由网管程序去读取相应信息没有逻辑上的区别，本设计采用第二种方式，回调函数的参数只有注册时指定的事件。 接口定义 函数列表 int dev_manager_event_init(char* processname, char* event, dev_manager_callback_t callback); int dev_manager_status_get(char* name, char* value); int dev_manager_status _set(char* name, char* value); int dev_manager_cfg_get(char* name, char* value); int dev_manager_cfg_set(char* name, char* value); int dev_manager_commit(void); int dev_manager_factory_default(void); int dev_manager_reboot(void); int dev_manager_start_upgrade_fw (char* url) int dev_manager_start_upgrade_profile (char* url) int dev_manager_start_upload_profile (char* url) int dev_manager_log(int priority, const char *text); 所有函数的返回值定义如下 0：success 1：fail 函数说明及示例： 回调函数 回调函数用于通知网管程序有事件发生，具体消息细节需要在回调函数中主动获取。 typedef void (*dev_manager_callback_t)( c