订阅的作用

简单点来讲就是保持上下级域之间的目录结构、设备状态保持一致。举个小例子：这边有两台sip服务器A和B，A和B通过国标对接，B把资源推送给A，A订阅B域的系统ID，B上的一个摄像头原来在线的，现在离线了，那么B就会通知A，我这儿有个摄像头离线了，然后A也让B将推送过来的这个摄像头离线，此外每当B上的设备离线，上线，增加，删除，目录更新时，都会向A发送通知。

订阅方式（详细见IETF RFC 3265）

监控推送消息站内存吗_xml


国标标准定义了以下几种订阅方式：

1）A订阅B的系统ID------最常用的

释：B 域检测到直属目录和下级域的目录变更事件时应向 A 域发送通知消息;

2）A订阅B的下级域系统ID

释：B 域检测到对应此ID 的下级系统范围内的目录变更事件时应向 A 域发送通知消息;

3）A订阅B的行政区划编码

释：B 域检测到属于此行政区划的目录变更事件时应向 A 域发送通知消息

4）A订阅B的设备ID

释：B 域检测到该设备及其下属子设备发生目录变更事件时应向A 域发送通知消息;

5）A订阅B的上报业务分组ID，虚拟组织ID

释：B 域检测到该业务分组、 虚拟组织下属虚拟组织、 设备发生目录变更事件时应向 A 域发送通知消息

4. 刷新订阅

A 域在初始订阅成功之后, 应在过期之前向 B 域发送刷新订阅消息, 进行订阅状态维护。

刷新订阅消息与初始订阅消息属于同一会话, 并且 Expire 头域值大于0.

初始化订阅时，Expire头域值国标定义可以配置，默认为600s。

5. 取消订阅（两种方式：主动和被动）

主动： A订阅B，A主动取消订阅。取消订阅请求应与初始订阅请求属于同一会话, 并且 Expire 头域值为0

被动： A订阅B，B 域可通过发送subscription-state 头域为terminated 的 NOTIFY 消息主动结束订阅, NOTIFY消息体可为空, 订阅方接收到该消息后回复200 OK 响应。

信令流程

监控推送消息站内存吗_初始化_02


命令流程描述如下:

1: 订阅域向被订阅域发送初始订阅SUBSCRIBE 消息, 订阅目的域的目录变更事件, 消息头域中使用 Event 头域描述订阅事件, 消息体中携带订阅的详细参数, 使用 Expire 头域指定订阅过期时间;

2: 被订阅域设备收到订阅消息后, 向订阅域发送200 OK 响应;

3: 对于初始订阅操作, 被订阅域立即发送 NOTIFY 消息携带离线及其他异常状态设备目录,消息头域中使用 Event 头域描述订 阅事件;

4: 订阅域收到 NOTIFY 消息后回复200 OK 响应;

5: 被订阅域目录变更后, 通过 NOTIFY 消息将变更事件通知订阅域, 消息头域中使用 Event头域描述订阅事件;

6: 订阅域收到 NOTIFY 消息后回复200 OK 响应;

7: 订阅域在过期之前向被订阅域发送刷新订阅 SUBSCRIBE 消息, 订阅目的域的目录变更事件, 消息头域中使用 Event 头域描述订 阅事件, 消息体中携带订阅的详细参数, 使用 Expire 头域指定订阅过期时间;

8: 被订阅域设备收到订阅消息后, 向订阅域发送200 OK 响应;

9: 被订阅域目录变更后, 通过 NOTIFY 消息将变更事件通知订阅域, 消息头域中使用 Event头域描述订阅事件;

10: 订阅域收到 NOTIFY 消息后回复200 OK 响应;

11: 订阅域向被订阅域发送取消订阅SUBSCRIBE 消息, 消息头域中使用 Event 头域描述订阅事件, 消息体中携带订阅的详细参数,Expire 头域值为0;

12: 被订阅域设备收到订阅消息后, 向订阅域发送200 OK 响应, 取消向订阅域发送目录变更通知消息。

A发送初始订阅消息订阅B的目录时Expires头域携带订阅过期时间，默认是600s，该时间应可配置。A在订阅过期时间到来之前订阅域应该刷新订阅。B在过期时间到来时若未收到刷新订阅的消息，则移除A的订阅状态。
刷新订阅消息的初始订阅消息属于同一个会话，会话ID应该一致。

实例分析

例一

第一步：SUBSCRIBE消息

监控推送消息站内存吗_离线_03


第三步：NOTIFY消息，初始订阅上报离线及异常设备状态

监控推送消息站内存吗_监控推送消息站内存吗_04


第五步： NOTIFY消息暂时没抓，后期补上

第七步：刷新订阅是比较难抓的，有机会抓来展示

第九步：后期补上

第11步：来看下主动取消吧，被动取消有机会可以的话，补上，因为DZ在做的时候是先取消的订阅，在订阅的，所以这边的CALL-id和订阅的CALL-ID不一致

监控推送消息站内存吗_初始化_05

例二

服务器A（192.168.0.33）订阅海康NVR（192.168.0.64）目录

一、A初始订阅

监控推送消息站内存吗_离线_06


二、NVR回复200 ok然后回复NOTIFY消息

（这个消息截图与初始化截图的是两个不同时间内获得的，所以有会话不一致，实际上同一个流程notify的会话ID和初始订阅的是一样的）

监控推送消息站内存吗_xml_07


监控推送消息站内存吗_离线_08


服务器回复200 OK（这个流程也是不同时间跑的，所以会话ID与初始化订阅抓包截图的不一样，实际上应该是一致的）

监控推送消息站内存吗_监控推送消息站内存吗_09


三、订阅刷新的抓包

监控推送消息站内存吗_离线_10


回复200 OK

监控推送消息站内存吗_xml_11


由初始化订阅和订阅刷新可知，会话ID是要保持一致的，若刷新注册使用不同的ID在exoisp中创建刷新信息会出现错误码-6（NOFOUND）。

四、demo

1、初始化订阅

char rsp_xml_body[4096];
osip_message_t *rsp_msg = NULL;
char sour_call[128] = {0};
char dest_call[128] = {0};


sprintf(sour_call, "sip:%s@%s:%d", deviceInfo.server_id, deviceInfo.server_ip,deviceInfo.server_port);
sprintf(dest_call, "sip:%s@%s:%d", deviceInfo.ipc_id, deviceInfo.ipc_ip, deviceInfo.ipc_port);


eXosip_subscription_build_initial_subscribe(g_context_eXosip, &rsp_msg, dest_call, sour_call, NULL, "Catalog", 600);
snprintf(rsp_xml_body, 4096, "<?xml version=\"1.0\"?>\r\n"
"<Query>\r\n"
"<CmdType>Catalog</CmdType>\r\n"
"<SN>%s</SN>\r\n"
"<DeviceID>%s</DeviceID>\r\n"
"</Query>\r\n",
"25",
deviceInfo.ipc_id
);


osip_message_set_body(rsp_msg, rsp_xml_body, strlen(rsp_xml_body));
osip_message_set_content_type(rsp_msg, "Application/MANSCDP+xml");


eXosip_lock(g_context_eXosip);
eXosip_subscription_send_initial_request(g_context_eXosip, rsp_msg);
eXosip_unlock(g_context_eXosip);

2、会话id保存

//发送成功之后NVR回复200 OK，在这个200 OK 的event处理流程中需要保存会话ID用于刷新注册
case EXOSIP_SUBSCRIPTION_ANSWERED:
{
     m_SubCatalogId = g_event->did;  //保存会话ID
}break;

3、刷新订阅

{
    //refresh
    osip_message_t * sub = NULL;
    char rsp_xml_body[1024];
    memset(rsp_xml_body,0,1024);
    
    eXosip_lock(this->g_context_eXosip);
    int ret = eXosip_subscription_build_refresh_request(this->g_context_eXosip, this->m_SubCatalogId, &sub); /* 使用保存下来的会话ID */
    if(ret != OSIP_SUCCESS)
    {
      LOG_DEBUG << "eXosip_subscription_build_refresh_request FAILE! Error code: " << ret;
      return;
    }

    snprintf(rsp_xml_body, 1024, "<?xml version=\"1.0\"?>\r\n"
        "<Query>\r\n"
        "<CmdType>Catalog</CmdType>\r\n"
        "<SN>%s</SN>\r\n"
        "<DeviceID>%s</DeviceID>\r\n"
        "</Query>\r\n",
        "25",
        deviceInfo.ipc_id
        );

        osip_message_set_body(sub, rsp_xml_body, strlen(rsp_xml_body));
        osip_message_set_content_type(sub, "Application/MANSCDP+xml");

    ret = eXosip_subscription_send_refresh_request(this->g_context_eXosip, this->m_SubCatalogId, sub);
    eXosip_unlock(this->g_context_eXosip);
    if(ret != OSIP_SUCCESS)
    {
      LOG_DEBUG << "eXosip_subscription_send_refresh_request FAILE! Error code: " << ret;
      return;
    }
    LOG_DEBUG << "eXosip_subscription_send_refresh_request Success !!! ";
}

订阅消息与通知消息体（国标规范）

订阅消息消息体示例如下:

< ? xml version="1.0" ?>
<Query>
< ! -- 命令类型: 目录订阅(必选) -->
<CmdType>Catalog</CmdType>
< ! -- 命令序列号(必选) -->
<SN> 命令序列号</SN>
< ! -- 订阅的系统/行政区划/设备/业务分组/虚拟组织编码(必选) -->
<DeviceID> 订阅编码</ DeviceID>
</Query>

通知消息消息体示例如下, 增加/更新目录通知消息中Item 的字段参数应遵循 A.2.1g) 的规定:

< ? xml version="1.0" ?>
<Notify>
< ! -- 命令类型: 目录订阅(必选) -->
<CmdType>Catalog</CmdType>
< ! -- 命令序列号(必选) -->
<SN> 命令序列号</SN>
< ! -- 订阅的系统/行政区划/设备/业务分组/虚拟组织编码(必选) -->
<DeviceID> 订阅编码</DeviceID>
< ! -- 通知消息中SumNum 取值与 DeviceList 中 Num 取值相同(必选) -->
<SumNum>2</SumNum>

<DeviceList Num="2">



<Item>
< ! -- 状态改变的系统/设备/行政区划编码(必选) -->
<DeviceID> 编码1</DeviceID>
< ! -- 状态改变事件 ON: 上线, OFF: 离线, VLOST: 视频丢失,DEFECT: 故障,
ADD: 增加,DEL: 删除,UPDATE: 更新(必选) -->
<Event>OFF</Event>
</Item>


<Item>

< ! -- 状态改变的系统/设备/行政区划编码(必选) -->
<DeviceID> 编码n</DeviceID>
< ! -- 状态改变事件 ON: 上线, OFF: 离线, VLOST: 视频丢失,DEFECT: 故障,
ADD: 增加,DEL: 删除,UPDATE: 更新(必选) -->
<Event>ADD</Event>
<Name>IPC_天山视频</Name>
< Manufacturer>XXX</Manufacturer>
< Model>1.0</Model>
<Owner>0</Owner>
<CivilCode>650102</CivilCode>
<Address>axy</Address>
<Parental>0</Parental>
<RegisterWay>1</RegisterWay>
<Secrecy>0</Secrecy>
<Status>ON</Status>
</Item>
</DeviceList>
</Notify