NIM CPP SDK  4.1.0
Windows(PC) SDK 开发手册(C++ 封装层)

概述

Windows(PC) SDK对外暴露的是C接口,为了让桌面开发者更加方便快捷的接入SDK,我们基于C接口封装了C++ SDK,既可以让开发者方便直观的调用接口使用云信的服务,也可以供基于C接口开发的的开发者作为参考。

开发准备

可以通过官网下载SDK以及Demo源码,SDK包含C接口API文件和C++封装层的API文件及项目文件。

SDK内容

SDK不提供debug版本的动态链接库供开发者调试,如果遇到问题请联系技术支持或在线客服。

快速接入SDK

前往Windows(PC) SDK Getting Started

SDK C++封装层类讲解

SDK C++封装层代码在nim_cpp_sdk\下,主要封装了以下核心类:

此外,每个类都包含一个对应Helper文件,如nim_cpp_client.h对应nim_client_helper.h,主要包含接口需要的辅助方法和数据结构的定义。

接入SDK C++封装层

添加SDK C++封装层

在nim_cpp_sdk\nim_sdk_cpp_vs2010下包含nim_sdk_cpp_lib.vcxproj项目文件,该工程是基于Visual Studio 2010开发,开发者可以通过解决方案右键添加已有项目将该项目文件添加到自己的工程,如果开发者已有解决方案的开发环境高于VS2010,请在导入的同时升级SDK项目,导入后编辑需要引用到SDK API的项目,在属性-通用属性-框架和引用中添加SDK项目为新的引用。当然开发者也可以仅仅将提供的SDK静态库添加到自己的工程,但是这里还是建议开发者将源码引入到自己的工程,方便扩展和调试。

添加所需的第三方库

SDK C++项目文件依赖第三方库jsoncpp,我们随包提供了基于vs2010编译的jsoncpp_d.lib和jsoncpp.lib(nim_cpp_sdk\nim_sdk_cpp_vs2010\libs),同时为了方便vs其他版本的开发者使用,也附带了jsoncpp的源码(nim_cpp_sdk\nim_sdk_cpp_vs2010\third_party),开发者可以根据需要编译不同版本的json库(解决方案文件在nim_cpp_sdk\nim_sdk_cpp_vs2010\third_party\jsoncpp\makefiles\msvc2010),编译第三方库的时候要注意属性-C/C++/代码生成选项卡中的运行库要与主程序的运行库保持一致。

当然,开发者也可以使用自己熟悉的json有关的第三方库,如果使用其他第三方库,需要手工调整C++ SDK源码中引用到jsoncpp对象的代码。

添加完第三方库后,还需要设置工程属性中,C/C++-常规中,附加包含目录添加第三方库的头文件路径(nim_cpp_sdk\nim_sdk_cpp_vs2010\third_party\jsoncpp\include),这样方便在代码中包含json所需的头文件。

导入后注意调整平台工作集(属性-配置属性-常规),运行库(属性-配置属性-C/C++),附加包含目录(属性-配置属性-C/C++-常规),附加依赖项/附加库目录(属性-配置属性-库管理器)等。