Communicator概要设计

Communicator概要设计版本日期内容/修改V0.06/13/2016草稿1 结构LOG接收线程：Communicator将各客户端发送过来的LOG存放到数据库中。LOG上传线程：Communicator从数据库中取出LOG发送到管理平台。文件下载线程：Communicator从管理平台下载文件，需要创建两个下载线程，分别用来下载Config/Policy和其他文件。文件上传线程：Communicator向管理平台上传文件。配置组件：配置服务器连接超时时间、LOG上传间隔、一次上传条数、MD校验错重传次数、日志等级。日志组件：记录Communicator模块的日志。2 流程Communicator通过libcurl实现向Server发送/请求数据。2.1 注册2.2 同步请求2.3 异步请求2.3.1 下载文件2.3.2 上传文件2.3.3 上传LOG3 接口3.1 ComSetWorkingDir/* * 功能描述：设置工作路径，如果同一目录下的多个进程都需要初始化Communicator，需要在每个进程中设置不同的工作路径，工作路径必须存在 * 参数： * dir: 工作路径 */int ComSetWorkingDir(const std:string& dir)；3.2 ComInitByKey/* * 功能描述：自动下载证书 * 参数： * connConfig: 请求证书所需要的内容(包括ClientType、ip、port、key等) * configDir: config文件放置路径，生成的证书默认也放在这个路径下 * param: Callback参数，均为可选参数ComCallbackFunc uploadFileCallback：上传文件callback函数 ComCallbackFunc downloadFileCallback： 下载文件callback函数 int uploadFileRetryCnt：上传文件失败重传次数 int downloadFileRetryCnt： 下载文件失败重传次数 * response: 返回的操作结果 */int ComInitByKey(const std:string& connConfig, const std:string& configDir, COM_CALLBACK& param, std:string& /*out*/ response);3.3 ComInitByConfig/* * 功能描述：通过从Server前端导出的配置文件初始化Communicator * 参数： * configPath: 配置文件路径 * param: Callback参数，均为可选参数ComCallbackFunc uploadFileCallback：上传文件callback函数 ComCallbackFunc downloadFileCallback： 下载文件callback函数 int uploadFileRetryCnt：上传文件失败重传次数 int downloadFileRetryCnt： 下载文件失败重传次数 */int ComInitByConfig(const std:string& configPath, COM_CALLBACK& param);3.4 ComRegister/* * 功能描述：客户端向Server注册 * 参数： * data: 注册信息 * response: 返回的操作结果 */int ComRegister(const std:string& data, std:string& /*out*/ response) const;3.5 ComHeartbeat/* * 功能描述：客户端向Server发送心跳 * 参数： * data: 心跳信息 * response: 返回的操作结果 */int ComHeartbeat(const std:string& data, std:string& /*out*/ response) const;3.6 ComSendRequest/* * 功能描述：通用请求接口 * 参数： * url: 请求url，Communicator提供宏定义，客户端传入 * requestType: 请求类型 REQUEST_TYPE_GET/REQUEST_TYPE_POST * data: 待请求的数据 * response: 返回的操作结果 */int ComSendRequest(const std:string& url, REQUEST_TYPE requestType, const std:string& data, std:string& /*out*/ response);3.7 ComDownloadFile/* * 功能描述：异步文件下载接口 * 参数： * param: 下载文件参数 std:string url：请求url，必要 std:string data：忽略 std:string filePath：下载文件目标路径，必要 std:string md5：忽略 */int ComDownloadData(COM_REQ_PARAM& param);3.8 ComUploadFile/* * 功能描述：异步文件上传接口 * 参数： * param: 下载文件参数 std:string url：请求url，必要 std:string data：忽略 std:string filePath：上传文件路径，必要 std:string md5：文件MD5，可选 */int ComUploadFile(COM_REQ_PARAM& param);3.9 ComUploadLog/* * 功能描述：异步LOG上传接口 * 参数： * strUrl: 请求url，Communicator提供宏定义，客户端传入 * strData: LOG数据 */int ComUploadLog(const std:string& strUrl, const std:string strData);3.10 ComSingleStringToWide/* * 功能描述：将string转为wstring */static std:wstring ComSingleStringToWide(const std:string &singleString);3.11 ComUtf8StringToWide/* * 功能描述：将utf8 string转为wstring */static std:wstring ComUtf8StringToWide(const std:string &utf8String);3.12 ComWideToSingleString/* * 功能描述：将wstring转为string */static std:string ComWideToSingleString(const