Syndication::RSS2::Cloud

Search for usage in LXR

Syndication::RSS2::Cloud Class Reference

#include <cloud.h>

Inherits Syndication::ElementWrapper.

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
 

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

◆ Cloud() [1/2]

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

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

Definition at line 16 of file cloud.cpp.

◆ Cloud() [2/2]

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

◆ debugInfo()

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.

◆ domain()

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

the remote domain

Definition at line 26 of file cloud.cpp.

◆ path()

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

the remote path to connect to

Definition at line 42 of file cloud.cpp.

◆ port()

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

the remote port to connect to

Definition at line 31 of file cloud.cpp.

◆ protocol()

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

protocol used for publish-subscribe, e.g.

"xml-rpc"

Definition at line 52 of file cloud.cpp.

◆ registerProcedure()

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

register procedure, e.g.

"myCloud.rssPleaseNotify"

Definition at line 47 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-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:14:15 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.