首頁 > 開發(fā)者中心 > SDK使用說明 |
SDK使用說明
一、SDK的主要功能
SDK的主要功能是在軟件上實(shí)現(xiàn)各種客戶端軟件或硬件設(shè)備的云端接入,使得它們之間可以互相一對一或一對多地發(fā)送透明數(shù)據(jù)包。
二、使用SDK的主要目的
避開各種高難或繁瑣通信技術(shù)細(xì)節(jié)開發(fā),如TCP/IP通信、數(shù)據(jù)打包、協(xié)議封裝及解釋、心跳檢測、斷線重連等,快速實(shí)現(xiàn)開發(fā)者想要的數(shù)據(jù)通信功能。
三、SDK接口API 說明
整個SDK只有5個API接口函數(shù),只要簡單調(diào)用這5個API函數(shù),即可實(shí)現(xiàn)客戶端之間的透明數(shù)據(jù)發(fā)送功能。這5個API接口函數(shù)如下:
這個函數(shù)用于對SDK進(jìn)行一些簡單的初始化操作,設(shè)定服務(wù)器地址信息、設(shè)定數(shù)據(jù)、事件、日志的回調(diào)接口函數(shù)。
2、登錄信息設(shè)置函數(shù)(SetLogin)
設(shè)定登錄云端時要用到的ID號及登錄密碼。
調(diào)用這個函數(shù)后,SDK就會自動執(zhí)行云端連接和登錄功能,并在登錄成功后一直保持在線,掉線后自動重新連接,收到透明數(shù)據(jù)包時通過回調(diào)函數(shù)回傳給外部應(yīng)用程序。
調(diào)用這個函數(shù)后,SDK會斷開與云端的網(wǎng)絡(luò)連接,并且不再自動重連。
5、數(shù)據(jù)發(fā)送函數(shù)(SendPack)
當(dāng)需要向其它設(shè)備、其它客戶端、應(yīng)用服務(wù)器發(fā)送數(shù)據(jù)時,就調(diào)用這個函數(shù)。可以在這個函數(shù)中設(shè)置一個接收者清單,一次性把數(shù)據(jù)包發(fā)送給多個設(shè)備、客戶端、應(yīng)用服務(wù)器。這個函數(shù)內(nèi)部已經(jīng)實(shí)現(xiàn)了數(shù)據(jù)包的正確性校驗(yàn)和數(shù)據(jù)包的完整性校驗(yàn),對方收到的數(shù)據(jù)包會與發(fā)送方發(fā)送的完全一樣,不用再考慮數(shù)據(jù)正確性及TCP分包拼包問題。
四、API調(diào)用流程
第一步:調(diào)用SdkInit函數(shù)進(jìn)行SDK初始化。
第二步:調(diào)用SetLogin函數(shù)設(shè)置登錄信息。
第三步:調(diào)用StartSDK函數(shù)啟動SDK。
完成上面三步后,SDK就已經(jīng)與云端建立通信連接了,這時如果要發(fā)送數(shù)據(jù),就調(diào)用SendPack函數(shù)進(jìn)行發(fā)送,當(dāng)收到數(shù)據(jù)時,會通過TonRecvCallback回調(diào)函數(shù)進(jìn)行回調(diào)通知。如果要斷開與云端的網(wǎng)絡(luò)連接,調(diào)用StopSDK函數(shù)即可。
五、不同編程語言API接口定義
|