[asterisk-dev] [Code Review] 3723: RLS: NOTIFY generation + structural refactor

[Mark Michelson]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/3723/
-----------------------------------------------------------

(Updated Aug. 6, 2014, 10:26 p.m.)


Review request for Asterisk Developers.


Changes
-------

Change where the module is reffed/unreffed when allocating/destroying subscription trees.


Bugs: ASTERISK-23869
    https://issues.asterisk.org/jira/browse/ASTERISK-23869


Repository: Asterisk


Description
-------

This adds NOTIFY support for resource list subscriptions. The way this works is as follows:

When an initial SUBSCRIBE arrives and the subscription tree is built, all leaf nodes are called into in order to generate their initial NOTIFY bodies and store these on their respective subscription nodes.

Sending a NOTIFY requires traversing the tree. List subscriptions will generate a multipart/related body with an RLMI part and parts corresponding to the leaves of the list (at least they will eventually. ASTERISK-23867 involves doing this part). Single-resource subscriptions read the stored body on the subscription and uses that to populate the NOTIFY body.

Leaf nodes in the subscription tree, when they have a state change occur, call ast_sip_subscription_notify(), as they previously did. ast_sip_subscription_notify() creates the NOTIFY body for the subscription and stores that on the subscription in the body_text ast_str field. The subscription tree is then told to send a NOTIFY if no batching is enabled or to start a batched NOTIFY if batching is enabled.

When a resource resubscribes or terminates their subscription, a NOTIFY is now automatically generated by the pubsub core instead of calling into subscription handlers. The NOTIFY is built the same way as previously, using stored NOTIFY bodies on the subscription. This NOTIFY can also cause batched notification, when the timer fires, not to actually send their batch since it would be redundant.

You'll notice the code has been refactored slightly, and a new struct, sip_subscription_tree, has invaded res_pjsip_pubsub. This is because, as I was separating the "real" and "virtual" parts of ast_sip_subscriptions out, I realized that I essentially had two distinct structures. Thus, I separated the real/meta/base elements of a subscription into the sip_subscription_tree, and the resource-specific parts into the ast_sip_subscription struct. sip_subscription_tree is used more heavily in the pubsub core now, whereas ast_sip_subscription acts as a handle for subscription handlers to use plus a repository for resource-specific data.


Diffs (updated)
-----

  /team/group/rls/res/res_pjsip_pubsub.c 420264 
  /team/group/rls/res/res_pjsip_mwi.c 420264 
  /team/group/rls/res/res_pjsip_exten_state.c 420264 
  /team/group/rls/include/asterisk/res_pjsip_pubsub.h 420264 

Diff: https://reviewboard.asterisk.org/r/3723/diff/


Testing
-------

With this set of changes, I'm still not able to perform RLS-specific tests since there is still no method of generating multipart/related or RLMI bodies. However, with these changes, I did run the gamut of subscription tests in the testsuite and they all pass. This at least means that there are no detectable regressions at this point.


Thanks,

Mark Michelson

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20140806/eb2a0b5a/attachment.html>