• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

syndication/rss2

Syndication::RSS2::Cloud

Syndication::RSS2::Cloud Class Reference

Cloud information for an RSS channel. More...

#include <cloud.h>

Inherits ElementWrapper.

List of all members.

Public Member Functions

 Cloud (const QDomElement &element)
 Cloud ()
QString debugInfo () const
QString domain () const
QString path () const
int port () const
QString protocol () const
QString registerProcedure () const

Detailed Description

Cloud information for an RSS channel.

It specifies a web service that supports the rssCloud interface which can be implemented in HTTP-POST, XML-RPC or SOAP 1.1. Its purpose is to allow processes to register with a cloud to be notified of updates to the channel, implementing a lightweight publish-subscribe protocol for RSS feeds.

Example:

Domain="rpc.sys.com", port="80", path="/RPC2" registerProcedure="myCloud.rssPleaseNotify" protocol="xml-rpc"

In this example, to request notification on the channel it appears in, you would send an XML-RPC message to rpc.sys.com on port 80, with a path of /RPC2. The procedure to call is myCloud.rssPleaseNotify.

For more information on the rssCloud interface see http://blogs.law.harvard.edu/tech/soapMeetsRss#rsscloudInterface

(Note: This explanation was taken from http://blogs.law.harvard.edu/tech/rss )

Author:
Frank Osterfeld

Definition at line 59 of file cloud.h.


Constructor & Destructor Documentation

Syndication::RSS2::Cloud::Cloud (  ) 

Default constructor, creates a null object, for which isNull() is true.

Definition at line 31 of file cloud.cpp.

Syndication::RSS2::Cloud::Cloud ( const QDomElement &  element  )  [explicit]

Creates a Cloud object wrapping a <cloud> XML element.

Parameters:
element The <cloud> element to wrap

Definition at line 35 of file cloud.cpp.


Member Function Documentation

QString Syndication::RSS2::Cloud::debugInfo (  )  const

Returns a description of the object for debugging purposes.

Returns:
debug string

Definition at line 72 of file cloud.cpp.

QString Syndication::RSS2::Cloud::domain (  )  const

the remote domain

Definition at line 39 of file cloud.cpp.

QString Syndication::RSS2::Cloud::path (  )  const

the remote path to connect to

Definition at line 56 of file cloud.cpp.

int Syndication::RSS2::Cloud::port (  )  const

the remote port to connect to

Definition at line 44 of file cloud.cpp.

QString Syndication::RSS2::Cloud::protocol (  )  const

protocol used for publish-subscribe, e.g.

"xml-rpc"

Definition at line 66 of file cloud.cpp.

QString Syndication::RSS2::Cloud::registerProcedure (  )  const

register procedure, e.g.

"myCloud.rssPleaseNotify"

Definition at line 61 of file cloud.cpp.


The documentation for this class was generated from the following files:
  • cloud.h
  • cloud.cpp

syndication/rss2

Skip menu "syndication/rss2"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • File List
  • Class Members

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal