协议开发 中移动CMPP2.0协议API
云网(jimzj@21cn.om)
前段时间，一直忙于公司的短信接口的开发；虽然总是忙，但还是很有收获的。从短信开接口的开发中也碰到不少问题，相信和我一样，大家在开发网关接口时也会有不少问题会碰到的：比如，采用移动提供的API出错，不同的编码，计费拔测，接收问题等。其实对于自己的上层领导来说，他所要的是结果，致于开发过程中你所遇到的各种问题都是自己去解决的，不懂就上网找，或者说问一下有这方面开发经验的朋友或同学。正是由于不同的开发人员在做CMPP（移动）协议或者是SGIP（联通）、SMGP（小灵通）协议时所碰到的问题相信有很大一部分是一样的，在这里我就把我开发过程中的一些碰到的问题和经验写出来，希望对准备开发短信网关协议的开发人员有一定的帮助，同时也希望大家如果有更好的经验也可以贴出来，这样可以使大家在开发上都会轻松一些。不过大家也可以到这个网站。可以说我也是从上面学到不少东西，在这先感谢各位贴出自己经验的朋友。
说了这么多费话，下面还是转入正题了。下面说主要以中移动的CMPP2.0协议来说明，还会说到API的开发的问题，希望对于想自己开发API的朋友也有一定帮助。
对开手上还没有CMPP协议的朋友，可以到上面说的那个网站去下载，可以以直接到（广州移动）上面下载。对于广州移动所用的是华为的短信网关，在接入是移动方面提供了网关二次开发的API，不过相信用过华为提供的API的人总会是有苦说不出，在这里我也不再多用评论，因为最初时间比较紧迫，所以也用过这个API的，但最终还是自已去开发了。
移动梦网和联通在信都是构建在有中国特色的短信网关部件基础上的，亚信为中国移动设计的CMPP协议规范，中国联通的SGIP规范都是为这个短信网关提供的互联网接口标准，可以看出二者都是借鉴GSM SMPP协议的两种简化版。
CMPP提供了基于TCP的长连接接口和短连接接口标准，SGIP提供了基于TCP和HTTP/TCP的短连接接口标准。CMPP中的短信网关为TCP服务器，通过接收SP发起的TCP连接来发送MT/MO/Report/Resp等消息。SGIP中发送MT/MTResp时是短信网关为TCP服务器，发送MO/MOResp/Report/ReportResp时短信网关作为TCP客户端。
长连接接口
通信双方以客户-服务器方式建立TCP连接，用于双方信息的相互提交。当信道上没有数据传输时，通信双方应每隔时间C发送链路检测包以维持此连接，当链路检测包发出超过时间T后未收到响应，应立即再发送链路检测包，再连续发送N-1次后仍未得到响应则断开此连接。
接口
通信双方以客户-服务器方式建立TCP连接，应答与请求在同一个连接中完成。系统采用客户/服务器模式，操作以客户端驱动方式发起连接请求，完成一次操作后关闭此连接。
设计CMPP 协议API模块，要考虑以下几个问题：
1、 链路检测。类似链路检测的长连接维持机制，为每个连接，在最后一个消息的处理结束前，重新启动一个60秒（可以自定义时间长短）的定时器。如果期间有消息来往，停止定时器，处理完消息后，继续启动定时器。如果60秒超时，重新启动定时器，连续三次超时，关闭这个链接，重新启动建立过程
2、 超时重发和差错重发。超时重发的原理是发送每个MT消息后，启动一个60秒的定时器，等待网关返回应答。如果超时，继续发送，连续3次都超时都没有应答，关闭连接，启动链路恢复过程。并返回一个发送超时的信息给调用这个API的用户接口。差错重发是接受到错误的应答，并且这个错误是由对等通信双方的协议层产生的，那么重新发送这条消息。
3、 滑动窗口控制流量。可以实现流量控制和有效的负载均衡。滑动窗口大小为16条消息。采用异步方式，一次发送16（称动建议值）条消息，并等待应答，每成功一个应答，窗口缩小，然后再从缓存取一个发送，填满窗口。但为了保证每一个发送的直接回应，可以只设置滑动窗口大小为1条消息，这样调用API的客户端程序可以直接得到发送的回应结果。方便客户端程序的自由的自动重发机制。
4、 消息重复处理。缓存当前所接收到的消息编号，保证所收到的消不能是回转重复。这个编号要靠短信网关来控制唯一性。当然，自已发送的数据包也要保证在一个链接段内时唯一的，这样才能保证数据的正确性。
5、 短信网关消息接收缓存。如要采用回调函数的方法传送接收信息给调用API的客户端程序，可以不考虑接收缓存，而采用API缓存方式接收时，要注意控制接收的量，以保证信息处理的及时性。
6、 有序控制。是保障先来的消息，先发送出去，后来的后发，严格地保障先后顺序。是通过序列号和滑动窗口来保障的。实际应用中，倒是不那么严格地关注顺序发送问题。
上面说了这么多都是一些技术结构上的问题，并没有实际到开发中的问题。其实做为一个开发人员，首先要做好的就是整个架构搭建的问题，代码实现是其次。因为有了好的架构，实现起来并不是很难（对于经常开发项目的开发人员来说），可以说是磨刀不误砍柴功。下面结给API的开发来说一下CMPP协议的开发。
其实说到API的开发，也只是包装了一个通讯协议。让上层用户可以不用去知道详细的协议解释，而专注于自己的业务模块。
对于CMPP2.0协议，要用的指令也就8个，相对来说并不是很复杂
CMPP_CONNECT =0x00000001; // 请求连接
CMPP_CONNECT_RESP =0x80000001; // 请求连接应答
CMPP_TERMINATE =0x00000002; // 终止连接
CMPP_TERMINATE_RESP =0x80000002; // 终止连接应答
CMPP_SUBMIT =0x00000004; // 提交短信
CMPP_SUBMIT_RESP =0x80000004; // 提交短信应答
CMPP_DELIVER =0x00000005; // 短信下发
CMPP_DELIVER_RESP =0x80000005; // 下发短信应答
CMPP_QUERY =0x00000006; // 短信状态查询
CMPP_QUERY_RESP =0x80000006; // 短信状态查询应答
CMPP_CANCEL =0x00000007; // 删除短信
CMPP_CANCEL_RESP =0x80000007; // 删除短信应答
CMPP_ACTIVE_TEST =0x00000008; // 激活测试
CMPP_ACTIVE_TEST_RESP =0x80000008; // 激活测试应答
实现CMPP协议模块也就是实现上面的8个指令就可以了。按照上面说的设计模式，同进结合API开发来说一下协议的实现。
对于API对外的接口，一般的定义格式如下：
extern "C" __declspec( dllexport ) int WINAPI ActiveTest()
接下来就是实现接口的功能：
一、建立SOCKET连接
struct sockaddr_in _socaddr ;
_socaddr.sin_family = AF_INET;
_socaddr.sin_port = htons( _port );
_socaddr.sin_addr.s_addr = inet_addr( _ismg );
return connect( _soc, (struct sockaddr *)&_socaddr, sizeof( _socaddr ));
致于设置发送超时，接收超时还有阻塞或非阻塞的接收模式，可以自己根据需要去设置不同的目标值。
二、登录短信网关服务器
按CMPP协议，主要的部分是就是AuthenticatorSource = MD5（Source_Addr+9 字节的0 +shared secret+timestamp），MD5算法在网上可以直接找到源程序，不必要自己重新去写这个内容。这部分内容相对比较简单就不在这里再写出来了。
//计算单向HASH函数的值
strcpy( authsrc, _spid ) ;
char * pos = authsrc + strlen( _spid ) + 9 ; //9 字节的0
strcpy( pos, _passwd ) ;
pos += strlen( _passwd );
strcpy( pos, _timestamp( timestr )); //时间戳
pos += strlen( timestr );
ctx.update(( unsigned char * )authsrc, (int)( pos - authsrc ));
ctx.finalize();
ctx.raw_digest( msg->digest ); //复制转换成MD5的字符串到发送数据中
三、提交短信息
相对于登录来说，提交短信也不会很复杂。只是简单的把客户端程序提交过来的数据复制到发送窗口，发送并等待网关回应的状态就可以了，当然也可以在接收到用户的数据前作一些适当的如：手机号码是否全数字，定时发送或存活时间是否正确等的判断。
//要注意的就是可变的用户数据与保留字段的内容：
memcpy( _pkg->data, &msg, sizeof( CMPP_SUBMIT ));
//将最后8个字节的保留数据拷贝到适当的位置
memcpy(
( _pkg->data + nsize - sizeof( msg.reserve ) - sizeof( CMPP_HEAD )),
msg.reserve,
sizeof( msg.reserve ));
四、接收短信息和状态
接收短信后有两种处理方式，
1、 采用回调函数的方式：
这种方式相对于API来说比较简单，只要定义一下接口函数就可以了，客户端程序在初始化时，传入回调函数的函数指针，当API接收到短信网关下发（DELIVER）的短信时，调用函数指针把相关参数据传递给客户端。不必要考虑队列或其它细节的问题。
如下我在API中定义的回调函数：
typedef int ( WINAPI * TProcGetDeliver )(
char * msgid,
unsigned char * destnumber,
unsigned char * serviceid,
unsigned char tppid,
unsigned char tpudhi,
unsigned char msgfmt,
unsigned char * srcnumber,
unsigned char delivery,
unsigned char msglen,
unsigned char * msgcontent,
unsigned char * reserve,
unsigned char * stat,
unsigned char * submittime,
unsigned char * donetime ) ;
而在API对外接口中只要定义一个参数作为传送函数指针就可以了：如下：
extern "C" __declspec( dllexport ) int WINAPI IFInitInterface( char *ismg, unsigned short port, TProcGetDeliver fCltGetDeliver );
fCltGetDeliver 就是用户传递过来的回调函数指针，在调用时，直接采用参数开式用调用就可以了。如下所示：
err = _fCltGetDeliver ( (char * )&_msgid,
_msg->destnumber,
_msg->serviceid,
_msg->tppid,
_msg->tpudhi,
_msg->msgfmt,
_msg->srcnumber,
_msg->delivery,
_msg->msglen,
_msg->msgcontent,
_msg->reserve,
_stat,
_submittime,
_donetime
) ;
这样所接收到的所有参数就顺利传递到客户端了。
2、 调用API的客户端程序定时检测并从缓冲队列中拾取方式：
对于队列的方式，API内部必需自己建立一个缓冲队列。这个队列对于安全来说，必须是线程安全的（可以用临界区来保护），接收到一个下发信息时，数据暂时保存入队列中：
int nl = sizeof( CMPP_HEAD ) + sizeof( CMPP_DELIVER ) ;
_pushrecqueue( _recpkg, nl ) ;
下面是_pushrecqueue函数；
void WINAPI _pushrecqueue( void * inval, int nl )
{
char * _queval = new char[ nl + 1 ] ;
memset( _queval, 0, sizeof( nl + 1 )) ;
memcpy( _queval, inval, nl ) ;
_queue._push( _queval ) ;
}
为了保证数据最大安全性，不要接收到过多的数据进入队列。放入队列的数据就等待用户用API接口过来取走就可以了，其相关接口与回调函的参数相差不多，在这里就不多作说明，只要说明一下可以提供一个接口，可以让客户端可以检测队列中是否有可以接收的数据：
extern "C" __declspec( dllexport ) int WINAPI HasDeliver() ;
这检是否取数据就由客户端去作判断了。待续......
