工程中心头端考核pushmailv2产品发布前端介绍

1、 对外文档 深圳市茁壮网络股份有限公司 版权所有 PAGE 15 iPanel.TV InciPaneliPanelPushMail V2 产品发布前端介绍iPanel.TV Inc（ 版本：2PushMail V2 产品发布前端介绍iPanel.TV Inc（ 版本：2.0.0 ）深圳市茁壮网络股份有限公司 版权所有目 录 TOC 1、 消息通道系统结构 PAGEREF _Toc16825 12、 PushMailV2基本功能 PAGEREF _Toc28738 33、 PushMailV2服务端软件部署 PAGEREF _Toc7918 44、 授权控制 PAGEREF _Toc19076

2、 55、 PMP接口功能 PAGEREF _Toc11680 65.1系统连接 PAGEREF _Toc27812 65.2报文格式 PAGEREF _Toc26820 65.2获取系统信息 PAGEREF _Toc12880 65.3获取系统日志 PAGEREF _Toc8084 75.4调整日志级别 PAGEREF _Toc12030 75.5查询消息缓存 PAGEREF _Toc7246 75.6查询连接信息 PAGEREF _Toc24104 85.7新增输出 PAGEREF _Toc9705 85.8查询输出 PAGEREF _Toc26281 85.9修改输出 PAGEREF _T

3、oc23697 95.10删除输出 PAGEREF _Toc4558 95.11启动输出 PAGEREF _Toc12010 95.12停止输出 PAGEREF _Toc23568 95.13新增区域 PAGEREF _Toc22111 95.14查询区域 PAGEREF _Toc29853 105.15修改区域 PAGEREF _Toc31506 105.16删除区域 PAGEREF _Toc27154 105.17启动区域播发 PAGEREF _Toc25640 115.18停止区域播发 PAGEREF _Toc30227 115.19添加消息 PAGEREF _Toc32639 115.

4、20撤销消息 PAGEREF _Toc9896 135.21新增模板 PAGEREF _Toc9235 135.22更新模板 PAGEREF _Toc23436 135.23撤销模板 PAGEREF _Toc19619 145.24查询模板 PAGEREF _Toc32456 145.25更新播发频点描述 PAGEREF _Toc13389 155.26设置消息描述表播发带宽 PAGEREF _Toc23376 156、 错误码 PAGEREF _Toc19773 16消息通道系统结构PushMail DVB 消息通道系统 V2.0 结构如图 1-1 所示。图 1-1 PushMail V2.

5、0 系统结构iPanel PushMail V2消息通道系统是一套端到端系统，用于在DVB-C单向广播网络中实现点对点、点对多点的消息发送等功能。客户端：客户端是整个系统的操作界面业务后台服务器：以WEB服务器方式接受客户端的操作指令，进行系统配置、系统监控、业务数据管理、模板管理、消息播发与排期、分组处理等等操作。数据处理服务器：接收业务后台服务器的各项操作。数据处理服务器周期轮循数据库中是否存在待发消息，若有则提取相应数据、组织消息报文发给消息播发服务器予以播发。（4）消息播发服务器：接收消息报文、模板文件，依据各表、描述符的定义将消息、模板封装成 TS、播发出去。（5）复用调制器：将消息

6、播发服务器输出的 TS 复用到指定频点、调制到 DVB-C 网络中，供终端机顶盒接收。（6）机顶盒：接收网络中的消息内容、模板、分组数据，进行相应解析、处理，依据消息的属性呈现消息内容。客户端可以有多台，基于浏览器界面、通过局域网/专网/城域网/互联网访问业务后台服务器。对于大量用户（客户端）的并发访问，通过路由器或四层网络交换机进行负载均衡。视业务情况，部署一台或多台业务后台服务器，并行运行、处理与PushMessage相关的业务数据与系统操作。各业务后台服务器间不交互信息、状态、数据。数据处理服务器部署的数量依消息业务量而定、可灵活配备，并行运行。各数据处理服务器间不交互信息、状态、数据。

7、消息播发服务器主/备部署，输出相同的TS传送流数据。主/备消息播发服务器间同步系统状态、模板文件（数据）、消息报文、各表周期设置参数等。PushMailV2基本功能支持播发三表MDT消息描述表、消息播发频点描述表MBT、模板表STT；支持点对点、点对多消息发送；消息内容多样性支持（文字、图片、JS等等）；支持消息与业务绑定功能；支持消息内容存盘（写入Flash）功能；播发服务器支持32位、64位linux系统；支持多输出多区域功能；支持UDP和ASI两种输出方式；单个输出带宽支持1K到40Mbps； 消息内容最大支持2K；单个模板文件最大支持1M；支持双机热备；支持日志分级设置；支持输出64个

8、以上，区域64个以上；支持同时播发65534个模板；PushMailV2服务端软件部署详见文档PushMailV2服务端软件部署指南_V2.0.0_2014-01-13.docPMP2.0服务端软件的部署总体步骤如下： 准备硬件、软件环境 安装Linux操作系统（特别注意要安装软件开发的相关软件包，否则不能成功安装驱动程序） 安装驱动程序 安装PMPV2服务端软件（播发服务器） 获取License 启动PMPV2服务端软件 设置自启动授权控制（1）PushMail V2 系统的授权控制放在消息播发服务器环节实现。（2）授权控制采用 HASP HL Pro 软件锁 + 授权文件（license.

9、dat）的方式实现（3）授权文件中包含：软件锁 S/N（作为 License 与软件锁配对唯一性信息） 、授权文件生成时间（年/月/日/时/分/秒） （作为 License 更新判断依据） 、授权类型（试用、正式） 、试用时长（以天为单位） （正式版为“0” ） 、允许的最大区域数、被授权人信息等。（4）若为试用版授权，倒计数时间值写入软件狗 EEPROM 中（每 30 分钟递减 1） 。试用时长分为 5、10、15、30、60 天。试用时间到后，并不结束服务进程的运行，而是不接受任何消息报文。（5）授权文件生成时间要写入软件锁的 EEPROM 中（消息播发服务器启动时，会检查是否有软件锁、

10、授权文件， 以及是否配对， 并判断软件锁 EEPROM 中是否有授权文件生成时间字段，若软件锁为空，则写入；若不为空，则判断是否为更新） 。（6）支持 License 的更新，通过授权文件生成时间来判断（消息播发服务器启动时，会判断授权文件中的生成时间字段的值是否比软件锁 EEPROM 中的值要大，若大则为更新的授权；若等则为同一个授权；若小则报错、退出） 。PMP接口功能5.1系统连接（1）消息播发服务器通过 TCP 套接字（socket）与“客户端”建立命令/消息连接（文件的传送采用 FTP 方式）。（2）消息播发服务器为服务端。（3）命令/消息报文采用网络字节序，长连接模式。（4）消息播

11、发服务器支持多个“客户端”同时连接。5.2报文格式（1）命令/消息报文格式如下：msg_length（4B）+ msg_id（4B）+ msg_handle（4B）+ msg_data（n）（2）报文各部分说明：msg_length：本条消息总长度（不包括自身），以字节为单位。msg_id：消息标识符。不同功能/类型的命令/消息，消息标识符不同。msg_handle：消息句柄，由客户端维护，循环计数，以便客户端识别服务端返回的是哪条命令/消息的处理结果。msg_data：消息的具体数据、命令内容。*当一个 TCP 报文承载不完所有的数据内容时， 则余下的连续 TCP 报文数据段只有 msg_d

12、ata。*返回消息报文格式相同。5.2获取系统信息msg_id = 0 x00000004获取（查询）系统信息命令的 msg_data 为空（没有） ，msg_length = 8，返回消息内容如下：“version number”为消息播发服务器软件（PMP）的版本号，“licensed”是被授权人信息，“sn number”是软件锁的 S/N 号（ID） 。如果 PMP 服务器安装有 ASI 适配卡、并正确加载了驱动，则返回有消息内容中应包含所有插装的 ASI 适配卡的信息，“device”标明适配卡的型号，“card_number”标明卡的序号，“port”标明该适配卡共有多少个ASI

13、OUT 端口可用。5.3获取系统日志msg_id = 0 x00000005获取系统日志的 XML 报文如下：消息报文中需指定要获取的日志级别（“log level” ），取值为：1-错误，2-警告，3-信息。最多取最后的 1000 条日志信息（剩余的日志不读取），如果级别为3，则包含所有级别（1、2、3 级）日志信息；如果级别为2，则包含错误、警告日志信息。返回消息XML报文如下：5.4调整日志级别msg_id = 0 x00000006调整系统日志的 XML 报文如下：日志级别取值为：1-错误，2-警告，3-信息。如当日志级别设为1时，只有出错信息才会被记录入日志文件。通过消息接口调整日志

14、级别，不会存入系统配置文件（只是临时调整），当消息播发服务器重启后，取的是系统配置文件中的值，该调整失效。5.5查询消息缓存msg_id = 0 x00000007查询指定区域消息缓存的 XML 报文如下：返回消息 XML 报文如下：cache_num为指定区域各优先级消息的缓存数。5.6查询连接信息msg_id = 0 x00000008查询系统连接信息命令的 msg_data 为空（没有） ，msg_length = 8，返回消息如下：列出与PMP建立连接的所有“客户端”的 IP。5.7新增输出msg_id = 0 x00000009新增输出命令的 XML 报文如下：输出标识符(“outp

15、ut_id”)取值范围为 1255。输出名称(“name”)为字符串，英文字母、数字09、下划线、中划线，长度不超过32个字符。“m_url”用于指定主服务器输出设备相关参数，若为 ASI 输出，“asi”指定输出类型为ASI，“1”指定第一张 ASI 适配卡，“2”指定端口号为 2；若为 UDP（IP）输出，则其中 “udp” 指定输出类型为 UDP， “” 为目的 IP 地址（支持 UDP 单播、组播），“2005”为端口号，“5”为 TTL。输出带宽（“bandwidth” ）的单位为bps，最小为1000bps（1Kbps），最大为150Mbps。5.8查询输出msg_id = 0 x

16、0000000A查询输出命令的 msg_data 为空（没有） ，msg_length = 8，返回消息如下：列出所有输出。输出状态（“run” ）：true-启动，false-停止 。5.9修改输出msg_id = 0 x0000000B修改指定输出命令的 XML 报文如下：5.10删除输出msg_id = 0 x0000000C删除指定输出命令的 XML 报文如下：5.11启动输出msg_id = 0 x0000000D启动指定输出命令的 XML 报文如下：5.12停止输出msg_id = 0 x0000000E停止指定输出命令的 XML 报文如下：5.13新增区域msg_id = 0 x

17、0000000F新增区域命令的 XML 报文如下：输出标识符（“output_id” ）用于指定该区域要挂靠到那个输出。包标识符（“pid” ）指定该区域消息表输出 PID，取值范围为 08191（为遵循 DVB 相关标准/规范， 实际使用中， 0-PAT、 1-CAT、 16-NIT、 17-SDT/BAT、 18-EIT、 19-RST、 20-TDT/TOT、8191-空包等值不要使用） 。播发码率（“bandwidth” ）单位为 bps，指定该区域消息表总的播发码率。最小为 1Kbps，最大为 40Mbps 。消息描述表（MDT）带宽占用比率（“mdt_used_rate” ）指定

18、MDT 占除 MBT 外的带宽的比率，设置范围为 595（模板表占用剩下的带宽，MDT 与 STT 均不能全部占用剩余的所有带宽） ，以“5”为步长（即，为 5 的整数倍）。5.14查询区域msg_id = 0 x00000010查询区域命令的 msg_data 为空（没有） ，msg_length = 8，返回消息如下：列出所有区域。区域播发状态（ “run” ） ：true-播发 false-停播。5.15修改区域msg_id = 0 x00000011修改指定区域命令的 XML 报文如下：5.16删除区域msg_id = 0 x00000012删除指定区域命令的 XML 报文如下：5.1

19、7启动区域播发msg_id = 0 x00000013启动指定输出命令的 XML 报文如下：5.18停止区域播发msg_id = 0 x00000014启动指定输出命令的 XML 报文如下：5.19添加消息msg_id = 0 x00000015添加消息的 XML 报文如下：一个消息报文中，至少有一条消息的描述，可以有多条消息。即便一条消息没有描述符和或消息内容，XML 报文中也必须有 message_descriptor 和 message_content 标签（其内容为空，没有子标签）消息优先级“priority rate”的取值范围为 15，1 为最高优先级。分组标识符（ “group_

20、id” ）指定其下包含的各条消息的接收者分组，取值范围为 065534（65535 表示填充表、其内无有效消息内容） 。其中， “0”表示点对点消息， “1”表示全网组（所有机顶盒），“2”表示所有标清机顶盒，“3”表示所有高清机顶盒（1、2、3 均为“自然分组” ） 。消息标识符（ “message_id” ）取值范围为 065535，不同消息（批量消息除外）的消息标识符不同，循环累增。消息类型（ “message_type” ）取值范围为 0255。模板标识符（ “style_template_id” ）指定该条消息所引用的模板，取值范围为 165535，其中“65535”表示引用默认模板

21、（通常位于 UI 中） 。（消息） 接收者标识符 （ “receiver_id” ） 用于指定该条消息的接收者， 16 字节 （32 位 BCD码，可用字符为 09、AF，高位补“0” ） （分组消息时其值全为 0） 。接收者标识符类型（ “receiver_id_type” ）指明接收者标识符是 STB ID 还是 CA ID（CA卡号） ， “0”为 STB ID， “1”为 CA ID。消息可见性（ “visibility” ）指明该条消息是否要在终端界面中显示，“1”显示， “0”不显示（ “静默” ） 。（消息显示）持续时间（ “duration_time” ）指明该条消息显示（受可

22、见性控制）多长时间后自行消失，取值范围为 032767，单位为秒，其中，“0”表示该条消息一直显示、需要用户操作（干预） 。存储（ “save” ）属性指定该条消息的内容是否要保存（写 Flash） ， “0”不保存， “1”保存。消息表中可以添加描述符。消息关联描述符（ “message_association_descriptor” ）指定本条消息与哪些业务进行关联。 若无， 则本条消息无关联； 若有， 则只在用户位于指定业务 （收看指定频道）时才显示，如广告。on_id、ts_id、service_id 分别表示确定唯一一个业务的原始网络标识符、传送流标识符、业务标识符。一条消息可以同时

23、与多个业务关联。默认模板描述符 （ “default_style_template_descriptor” ） 指明该条消息所引用的默认模板路径。默认模板只在消息的 style_template_id=65535 时才是必须的，其它值时可以有默认模板描述符、也可以没有。默认模板路径（ “path char” ）为字符串，最长不超过 256 个字符。消息内容（ “message_content” ）为字符串，不能超过 2048 字节（2KB） 。消息内容中若包含特殊字符（比如冒号） ，需用转义字符方式处理。XML 中定义的转义字符列表如下：转义字符序列符号说明 大于& 和号' 单引号

24、引号5.20撤销消息msg_id = 0 x00000016撤销指定消息的 XML 报文如下：消息播发服务器接收到撤销消息的命令后，检查指定区域的消息缓存池中是否存在，若存在则清除该条消息（遍历 5 个优先级的消息缓存池，通过 message_id 识别） 。可以同时撤销多条消息、逐条列出。5.21新增模板msg_id = 0 x00000017新增模板的 XML 报文如下：一条新增模板的消息报文中，可以同时描述多个模板。其中的“ftp_dir”中描述的是上传到消息播发服务器的 FTP 目录的相对路径，如：模板上传 FTP 服务器的目录是/home/ftp/stt（消息播发服务器的系统配置文件

25、 system.xml 中配置），那么消息播发服务器实际取模板文件的路径是/home/ftp/stt/123456/122。“123456”是区域码，“122”是模板标识符。模板的入口文件（entry_file）固定存放于该模板的“相对根目录” 。模板标识符（ “style_template_id” ）取值范围为 065534（65535 为 STT 的填充表，不可用）。其中，“0”固定用来传输分组数据（不能用作消息的模板） 。压缩属性（ “compress” ）指定该模板中的各文件（所有文件）在生成模板表（STT）时，数据内容是否要压缩（Gzip） ，true-压缩，false-不压缩。一个

26、模板最多可以有 65536 个文件，单个文件大小不能超过 1042900 字节。各模板文件的路径深度（相对路径+文件名）不能超过 256 个字符。 5.22更新模板msg_id = 0 x00000018更新模板的 XML 报文如下：一条更新模板的消息报文中，可以同时描述多个模板的更新行为。消息播发服务器收到更新模板命令后，需要重新去读取“ftp_dir”中描述的各文件，并重新生成各对应的模板 TS包、指定模板的版本号递增。5.23撤销模板msg_id = 0 x00000019撤销模板的 XML 报文如下：一条撤销模板的消息报文中，可以同时描述对多个模板的撤销行为。消息播发服务器收到撤销模板命令后，停止指定模板（通过 style_template_id 描述）的播发（重新组织 STT 的数据、TS 包）。5.24查询模板msg_id = 0 x0000001A查询指定区域在播模板列表的 XML 报文如下：返回消息 XML 报文如下：5.25更新播发频点描述msg_id = 0 x