首页 > 开发者中心 > SDK使用说明

SDK使用说明


一、SDK的主要功能

SDK的主要功能是在软件上实现各种客户端软件或硬件设备的云端接入,使得它们之间可以互相一对一或一对多地发送透明数据包。


二、使用SDK的主要目的

避开各种高难或繁琐通信技术细节开发,如TCP/IP通信、数据打包、协议封装及解释、心跳检测、断线重连等,快速实现开发者想要的数据通信功能。


三、SDK接口API 说明

整个SDK只有5个API接口函数,只要简单调用这5个API函数,即可实现客户端之间的透明数据发送功能。这5个API接口函数如下:

1、SDK初始化函数(SdkInit)

这个函数用于对SDK进行一些简单的初始化操作,设定服务器地址信息、设定数据、事件、日志的回调接口函数。

2、登录信息设置函数(SetLogin)

设定登录云端时要用到的ID号及登录密码。

3、SDK启动函数(StartSDK)

调用这个函数后,SDK就会自动执行云端连接和登录功能,并在登录成功后一直保持在线,掉线后自动重新连接,收到透明数据包时通过回调函数回传给外部应用程序。

4、SDK停止函数(StopSDK)

调用这个函数后,SDK会断开与云端的网络连接,并且不再自动重连。

5、数据发送函数(SendPack)

当需要向其它设备、其它客户端、应用服务器发送数据时,就调用这个函数。可以在这个函数中设置一个接收者清单,一次性把数据包发送给多个设备、客户端、应用服务器。这个函数内部已经实现了数据包的正确性校验和数据包的完整性校验,对方收到的数据包会与发送方发送的完全一样,不用再考虑数据正确性及TCP分包拼包问题。

四、API调用流程

第一步:调用SdkInit函数进行SDK初始化。

第二步:调用SetLogin函数设置登录信息。

第三步:调用StartSDK函数启动SDK。

完成上面三步后,SDK就已经与云端建立通信连接了,这时如果要发送数据,就调用SendPack函数进行发送,当收到数据时,会通过TonRecvCallback回调函数进行回调通知。如果要断开与云端的网络连接,调用StopSDK函数即可。

五、不同编程语言API接口定义

1、C语言/C++语言

2、Pascal语言(delphi)

3、Java语言(Android)

4、Object-C语言(IOS)