rssCloud cribsheet

Last update: Sunday October 1, 2017; 5:36 PM GMT+0000.

rssCloud cribsheet

What??#
- This is a quick summary of what's in the walkthrough document.#
- We're using the HTTP-POST, not XML-RPC or SOAP. #
Subscribing #
- When you want to subscribe to a feed, use the information in its cloud element. #
- For example, this is what you'll find in the feed for scripting.com.#
  - <cloud domain="rpc.rsscloud.co" port="5337" path="/rsscloud/pleaseNotify" registerProcedure="" protocol="http-post"/>#
- We make a POST request to http://rpc.rsscloud.co:5337/rsscloud/pleaseNotify, with the following params.#
  - notifyProcedure = ""#
  - port = the port we're listening on#
  - params.path = the path you should post to#
  - params.protocol = "http-post"#
  - params.url1 = the URL of the feed that we want to be notified about.#
    - You can also include url2, url3, etc -- to register subscriptions for more than one feed at a time.#
  - params.domain = the machine to be notified when the feed updates. #
    - This is optional, if it's not specified, the notifications go to the machine that made the subscription request. #
- The return value is XML-structured and tells us whether or not the server was able to handle the request.#
Notifying #
- The CMS includes the cloud information describing the server that handles updates. #
- There are two bits of communication here. #
  - 1. The CMS tells the cloud server when the feed has updated.#
    - We construct a url from the bits of data sent in the subscribing request. #
      - http://server:port/path?url=xxx where xxx is the address of the feed that's updating.#
  - 2. The cloud server tells each subscriber that the feed has updated.#
    - Same as in part 1, above.#
Example code in DW's codebase #
- Subscribing is implemented in river2.root, in river2Suite.renewOneSubscription.#
- CMS pinging the cloud server is implemented in radio2.root in radio2Suite.pingRssCloud. (However, it uses XML-RPC to make the call, not HTTP-POST.)#
- The cloud server notifying a subscriber is implemented in rssCloudSuite.notifyOne.#

Posted: Sunday October 1, 2017; 5:04 PM GMT+0000.