短消息代理(SMPP SMProxy)使用說明書.doc

第一章 概述1 產(chǎn)品概述SMPPSMProxy是符合SMPP3.4協(xié)議的接口，可以同時滿足Unix和WINDOW NT平臺的使用。SMPPSMProxy與SMSC建立TCP連接進行通信，并負責短消息發(fā)送和接收、維護與SMSC的握手、斷連重連等；SMPPSMProxy提供客戶API接口函數(shù)，包括登錄PROXY、退出PROXY、發(fā)送短消息、接受短消息、接受響應信息等。SMPPSMProxy支持多線程并發(fā)使用發(fā)送短消息，SMPPSMProxy和SMSC之間使用的通信協(xié)議是SMPP協(xié)議。2 組網(wǎng)結(jié)構(gòu)SMPPSMProxy就是運行在SP上，負責和SMSC進行SMPP3.4協(xié)議的通訊，要求SP的功能實體向SMSC發(fā)SMPP_SUBMIT消息，由SMSC返回SMPP_DELIVERY消息給SP。3 SMProxy的結(jié)構(gòu)客戶程序調(diào)用到SMPPSMProxy提供的接口函數(shù)實現(xiàn)收發(fā)短消息，SMPPSMProxy實現(xiàn)把客戶程序所發(fā)出的消息按SMPP3.4協(xié)議進行編碼后發(fā)給數(shù)據(jù)增值業(yè)務中心(infoX)，由數(shù)據(jù)增值業(yè)務中心(infoX)發(fā)送給SMC，并通過數(shù)據(jù)增值業(yè)務中心(infoX)接收SMC所響應的消息與主動下發(fā)的消息并進行解碼后，通知客戶程序接收SMC主動下發(fā)的短消息。第二章 SMPP3.4協(xié)議的封裝SMPP協(xié)議封裝在m.smpp.message包中，主要消息如下（1）SMPPEnquireLinkMessage 心跳消息，對應SMPP3.4文檔中的SMPP_ENQUIRE_LINK消息，是SMPPSMProxy與SMSC的心跳消息。（2）SMPPEnquireLinkRespMessage 心跳響應消息，對應SMPP3.4文檔中的SMPP_ENQUIRE_LINK_RESP，是SMPPSMProxy發(fā)送心跳消息后收到的響應消息。（3）SMPPLoginMessage 請求連接消息，對應SMPP3.4文檔中的SMPP_BIND_RECEIVER的消息，是SMPPSMProxy向SMSC發(fā)送的建立邏輯請求連接消息。（4）SMPPLoginRespMessage 請求連接應答消息，對應SMPP3.4文檔中的SMPP_BIND_RECEIVER_RESP的消息，是SMPPSMProxy向SMSC發(fā)送的建立邏輯請求連接后收到的響應消息。（5）SMPPDeliverMessage SMSC下發(fā)短信，對應SMPP3.4文檔中的 SMPP_DELIVER_SM消息，是SMSC下發(fā)給SMPPSMProxy的短消息或者狀態(tài)報告消息。（6）SMPPDeliverRespMessage 下發(fā)短信響應，對應SMPP3.4文檔中的 SMPP_DELIVER_SM_RESP消息，是SMPPSMProxy收到的下發(fā)短信后的響應消息。（7）SMPPSubmitMessage 發(fā)送短信消息，對應SMPP3.4文檔中的 SMPP_SUBMIT_SM消息，是SMPPSMProxy發(fā)送短訊的消息。（8）SMPPSubmitRespMessage 下發(fā)短信的響應，對應SMPP3.4 文檔中的 SMPP_SUBMIT_SM_RESP消息，是SMPPSMProxy發(fā)送短訊的響應消息。（9）SMPPUnbindMessage 終止連接消息，對應SMPP3.4 文檔中的 SMPP_UNBIND消息，是SMSC和SMPPSMProxy終止邏輯連接的消息。（10）SMPPUnbindRespMessage 終止連接的響應消息，對應SMPP3.4 文檔中的 SMPP_UNBIND_RESP消息，是SMSC或SMPPSMProxy收到終止連接后發(fā)送的響應消息。 其中的心跳消息（1，2）、建立邏輯連接的消息（3，4）和終止邏輯連接消息（9，10）只是SMPPSMProxy系統(tǒng)內(nèi)部使用消息，提供給外部的接口中不涉及這六條消息。第三章 SMPPSMProxy使用說明1 SMPPSMProxy提供的接口方法描述1、send【函數(shù)功能】 向SMSC發(fā)送SMPP消息，阻塞直到收到響應或超時?！竞瘮?shù)原型】SMPPMessage send(SMPPMessage message)；【參數(shù)說明】IN message - 發(fā)送的SMPP消息，包括 SMPPSubmitMessage提交短信【處理】調(diào)用這個接口方法，向SMSC發(fā)送Submit命令消息。 如果發(fā)送消息超時或通信異常則拋出異常，需要調(diào)用者捕獲處理?！痉祷刂怠堪l(fā)送SMPPSubmitMessage，返回SMPPSubmitRepMessage；2 close【函數(shù)功能】 向SMSC發(fā)送終止連接SMPP消息，調(diào)用之后連接將永久不可用?！竞瘮?shù)原型】Void close()；【參數(shù)說明】 無【處理】調(diào)用這個接口方法，SMPPSMProxy向SMSC發(fā)送SMPPUnbindMessage消息 如果發(fā)送消息超時或通信異常則拋出異常，需要調(diào)用者捕獲處理?！痉祷刂怠?無3 getConnState【函數(shù)功能】 獲取通訊連接的狀態(tài)方法?！竞瘮?shù)原型】String getConnState()；【參數(shù)說明】 無【處理】調(diào)用這個接口方法，獲取TCP連接狀態(tài)的描述。 如果發(fā)送消息超時或通信異常則拋出異常，需要調(diào)用者捕獲處理?！痉祷刂怠?當前錯誤描述，若連接正常則返回null。2 封裝接口方法的SMPPSMProxy的抽象類SMPPSMProxy在com.huawei.SMProxy的包中，封裝了Send、close、getConnState方法。SMPPSMProxy是一個抽象類，需要被繼承使用。SMPPSMProxy抽象類的框架如下：public class SMPPSMProxy public SMPPSMProxy(Args args) /完成初始化和向SMSC登錄等工作 public SMPPSMProxy(Map args) /完成初始化和向SMSC登錄等工作 /* * 發(fā)送消息，阻塞直到收到響應或超時。 * 返回為收到的消息 * exception PException 超時或通信異常。 */ public SMPPMessage send(SMPPMessage message) /發(fā)送消息 /* * 連接終止的處理，由API使用者實現(xiàn) * SMC連接終止后，需要執(zhí)行動作的接口 */ public void onTerminate() /* * 對收到消息的處理。由API使用者實現(xiàn)。缺省返回成功收到的響應 * param msg 從短消息中心來的消息。 * return 應該回的響應，由API使用者生成。 */ public SMPPMessage onDeliver(SMPPDeliverMessage msg) /* * 終止連接。調(diào)用之后連接將永久不可用。 */ public void close() /* * 提供給業(yè)務層調(diào)用的獲取連接狀態(tài)的方法 */ public String getConnState() /返回連接狀態(tài)的描述 3 使用SMPPSMProxy抽象類可以直接使用SMPPSMProxy類提供的Send、close和getConnState方法但是如果SP有接收SMSC下發(fā)的短信的要求或SMSC斷開連接的時候要求得到事件通知的時候，就必須聲明一個新的類繼承SMPPSMProxy，重載實現(xiàn)onDeliver( )和onTerminate( )。使用例子參見smppdemo實際使用SMPPSMProxy封裝的send、close和getConnState的接口方法的時候，只需要生成SMSender的對象，然后調(diào)用SMSender的send、close和getConnState方法即可。4 配置參數(shù)使用說明SMPPSMProxy需要的配置參數(shù)如下表參數(shù)名稱參數(shù)例值參數(shù)描述host47SMSC主機地址的IP地址port7890SMSC主機開發(fā)的端口號heartbeat-interval10心跳信息發(fā)送間隔時間(單位：秒)reconnect-interval10連接中斷時重連間隔時間(單位：秒)heartbeat-noresponseout5需要重連時，連續(xù)發(fā)出心跳而沒有接收到響應的個數(shù)（單位：個)transaction-timeout10操作超時時間(單位：秒)Debugtruetrue表示屬于調(diào)試狀態(tài)，所有的消息被打印輸出到屏幕，false表示不屬于調(diào)試狀態(tài)，所有的消息不被輸出system-idSPIdentifies the ESME system requesting to bind as a transmitter with the SMSC.passwordThe password may be used by the SMSC to authenticate the ESME requesting to bind.system-typeIdentifies the type of ESME system requesting to bind as a transmitter with the SMSC.addr-ton0Indicates Type of Number of theESME address.If not known set to NULLaddr-npi0Numbering Plan Indicator for ESMEaddress.If not known set to NULL.address-rangeThe ESME address.If not known set to NULL.Interface-version34Indicates the version of the SMPPprotocol supported by the ESME.配置文件可以采用我們提供的XML格式，也可以采用其他格式，只要構(gòu)造的時候能通過Map類型或Arg類型的參數(shù)傳入指定的參數(shù)就可以了。例如可以用java的property文件保存參數(shù)，或?qū)⑴渲煤蚐P的應用程序配置放在一起。下面是以XML格式定義的配置文件app.xml是在SMP