Syndication::RSS2::Cloud

Syndication::RSS2::Cloud Class Reference

#include <cloud.h>

Inheritance diagram for Syndication::RSS2::Cloud:

Public Member Functions

 Cloud ()
 
 Cloud (const QDomElement &element)
 
QString debugInfo () const
 
QString domain () const
 
QString path () const
 
int port () const
 
QString protocol () const
 
QString registerProcedure () const
 
- Public Member Functions inherited from Syndication::ElementWrapper
 ElementWrapper ()
 
 ElementWrapper (const ElementWrapper &other)
 
 ElementWrapper (const QDomElement &element)
 
virtual ~ElementWrapper ()
 
QString attribute (const QString &name, const QString &defValue=QString()) const
 
QString attributeNS (const QString &nsURI, const QString &localName, const QString &defValue=QString()) const
 
QString childNodesAsXML () const
 
QString completeURI (const QString &uri) const
 
const QDomElementelement () const
 
QList< QDomElementelementsByTagName (const QString &tagName) const
 
QList< QDomElementelementsByTagNameNS (const QString &nsURI, const QString &tagName) const
 
QString extractElementText (const QString &tagName) const
 
QString extractElementTextNS (const QString &namespaceURI, const QString &localName) const
 
QDomElement firstElementByTagNameNS (const QString &nsURI, const QString &tagName) const
 
bool hasAttribute (const QString &name) const
 
bool hasAttributeNS (const QString &nsURI, const QString &localName) const
 
bool isNull () const
 
ElementWrapperoperator= (const ElementWrapper &other)
 
bool operator== (const ElementWrapper &other) const
 
QString text () const
 
QString xmlBase () const
 
QString xmlLang () const
 

Additional Inherited Members

- Static Public Member Functions inherited from Syndication::ElementWrapper
static QString childNodesAsXML (const QDomElement &parent)
 

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 45 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 17 of file cloud.cpp.

Syndication::RSS2::Cloud::Cloud ( const QDomElement element)
explicit

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

Parameters
elementThe <cloud> element to wrap

Definition at line 21 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 57 of file cloud.cpp.

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

the remote domain

Definition at line 25 of file cloud.cpp.

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

the remote path to connect to

Definition at line 41 of file cloud.cpp.

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

the remote port to connect to

Definition at line 30 of file cloud.cpp.

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

protocol used for publish-subscribe, e.g.

"xml-rpc"

Definition at line 51 of file cloud.cpp.

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

register procedure, e.g.

"myCloud.rssPleaseNotify"

Definition at line 46 of file cloud.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Sep 23 2020 23:03:23 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.