Changes between Version 45 and Version 46 of Notifications


Ignore:
Timestamp:
Dec 10, 2009, 7:38:00 PM (15 years ago)
Author:
romw
Comment:

Updates

Legend:

Unmodified
Added
Removed
Modified
  • Notifications

    v45 v46  
    22
    33= BOINC Notification System =
    4 
    54As the number of projects increase it becomes increasingly difficult for volunteers to keep track of any relevant news a project publishes.  Volunteers may only check project websites once in a blue moon.  A system is needed to keep the volunteers engaged with a project.
    65
     
    3029
    3130== Feeds ==
    32 
    3331When a volunteer attaches to a project, one or more notification feeds become available to them.  These feeds are published using the [http://www.rssboard.org/rss-2-0 RSS 2.00 specification].
    3432
    3533Example feeds a project may wish to expose are:
    36  * Project news ({{{http://<project_url>/rss_main.php}}})
    37  * Project personalization feed (welcome message, useful links, milestones)
    38  * Scientist blogs
     34 * Project Notifications ({{{http://<project_url>/notify_rss.php}}})
     35* Scientist blogs
    3936 * Administrator blogs
    40  * Private Messages
    41  * Forum threads that a volunteer is monitoring
    42  * A whole forum to answer questions or to deal with problems as they arise.
    4337
    4438=== Request ===
    45 
    46 Example:
    47 {{{
    48 http://www.example.com/rss_main.php
    49 http://www.example.com/forum_pm_rss.php?auth=4ebd3e5fd8a88f48ed708f04f81fefb7
    50 http://www.example.com/forum_pm_rss.php?auth=4ebd3e5fd8a88f48ed708f04f81fefb7&guid=blah&action=read
     39Example:
     40{{{
     41http://www.example.com/notify_rss.php
     42http://www.example.com/notify_rss.php?auth=4ebd3e5fd8a88f48ed708f04f81fefb7
    5143}}}
    5244
     
    5547|| auth || <null> || Authenticator of the volunteer requesting the feed data. NOTE: For private feeds no information should be provided without the full authenticator. Weak authenticators should be treated as though no authenticator has been provided.||
    5648|| last_guid || <null> || The last guid received by the client.||
    57 || guid || <null> || The GUID in which an action should be preformed on. ||
    58 || action || <null> || Which action should be recorded. (Read, Deleted) ||
    5949
    6050=== Response ===
    61 
    6251Example:
    6352{{{
     
    7261        <pubDate>Sun, 29 Sep 2002 19:59:01 GMT</pubDate>
    7362        <guid>http://www.example.com/2</guid>
    74         <param_1>64</param_1>
     63        <boinc_param_1>64</boinc_param_1>
    7564    </item>
    7665</channel>
     
    8271|| pubDate || <scheduler reply time> || RFC 822 representation of the scheduler reply time ||
    8372|| guid || <null> || Unique message ID prefixed with the master URL of the project ||
    84 || param_1 || <null> || Optional parameter for the item description ||
    85 || param_2 || <null> || Optional parameter for the item description ||
    86 || param_3 || <null> || Optional parameter for the item description ||
    87 || param_4 || <null> || Optional parameter for the item description ||
    88 || param_5 || <null> || Optional parameter for the item description ||
     73|| boinc_param_1 … boinc_param_x || <null> || Optional parameter(s) for the item description ||
    8974
    9075'''NOTE''': While on face value the inclusion of the GUID to the client software might seem overkill, it serves two important purposes.
     
    9378
    9479== Feed List ==
    95 
    9680The feed list is published to the client software as part of the client parse-able project preferences.
    9781
     
    10286<notification_feeds>
    10387    <feed>
    104         <url>http://www.example.com/rss_main.php</url>
    105         <name>Project News</name>
     88        <url>http://www.example.com/notify_rss.php</url>
     89        <name>Project Notifications</name>
    10690        <update>86400</update>
    10791    </feed>
    10892    <feed>
    109         <url>http://www.example.com/forum_pm_rss.php</url>
    110         <name>Private Messages</name>
     93        <url>http://www.example.com/science_blog_rss.php</url>
     94        <name>Science Blog</name>
    11195        <update>86400</update>
    112         <private />
    11396    </feed>
    11497</notification_feeds>
     
    121104|| update || 86400 || Number of seconds in between updates ||
    122105|| last_update || 0 || The epoch time of the last successful update ||
    123 || private || false || Should the authenticator be provided to the feed ||
    124106|| application_only || false || Feed is used by an application and should not be shown in BOINC Manager or the BOINC Screen saver. ||
    125107
     
    188170
    189171=== Feed List ===
    190 
    191172Feeds will be added and removed from the feed list at the end of a scheduler operation.
    192173
     
    196177
    197178=== Feeds ===
    198 
    199179Periodically the client will loop through the feed list and download a feed update.  The feed update will be stored in a temporary file and any new items will be added to and old items will be deleted from the existing feed list.
    200180
     
    206186
    207187=== Feed Storage ===
    208 
    209188All data related to the notification system will be stored in a directory off of the main data directory.
    210189