Syndication Library
Syndication::DataRetriever Class Reference
Abstract baseclass for all data retriever classes. More...
#include <dataretriever.h>

Signals | |
void | dataRetrieved (const QByteArray &data, bool success) |
Public Member Functions | |
DataRetriever () | |
virtual | ~DataRetriever () |
virtual void | abort ()=0 |
virtual int | errorCode () const =0 |
virtual void | retrieveData (const KUrl &url)=0 |
Detailed Description
Abstract baseclass for all data retriever classes.
Subclass this to add a new retrieval algorithm which can then be plugged into the RSS loader.
- See also:
- Loader, FileRetriever, OutputRetriever
Definition at line 36 of file dataretriever.h.
Constructor & Destructor Documentation
Syndication::DataRetriever::DataRetriever | ( | ) |
Default constructor.
Definition at line 16 of file dataretriever.cpp.
Syndication::DataRetriever::~DataRetriever | ( | ) | [virtual] |
Destructor.
Definition at line 20 of file dataretriever.cpp.
Member Function Documentation
virtual void Syndication::DataRetriever::abort | ( | ) | [pure virtual] |
aborts the retrieval process.
Implemented in Syndication::OutputRetriever, and Syndication::FileRetriever.
void Syndication::DataRetriever::dataRetrieved | ( | const QByteArray & | data, | |
bool | success | |||
) | [signal] |
Emit this signal to tell the Loader class that the retrieval process was finished.
- Parameters:
-
data Should contain the retrieved data and will get parsed by the Loader class. success Indicates whether there were any problems during the retrieval process. Pass 'true' to indicate that everything went seamlessy, 'false' to tell the Loader that something went wrong and that the data parameter might contain no or invalid data.
virtual int Syndication::DataRetriever::errorCode | ( | ) | const [pure virtual] |
- Returns:
- An error code which might give a more precise information about what went wrong in case the 'success' flag returned with the dataRetrieved() signal was 'false'. Note that the meaning of the returned integer depends on the actual data retriever.
Implemented in Syndication::OutputRetriever, and Syndication::FileRetriever.
virtual void Syndication::DataRetriever::retrieveData | ( | const KUrl & | url | ) | [pure virtual] |
Retrieve data from the given URL.
This method is supposed to get reimplemented by subclasses. It will be called by the Loader class in case it needs to retrieve the data.
- Parameters:
-
url the URL to retrieve data from
- See also:
- Loader::loadFrom()
Implemented in Syndication::OutputRetriever, and Syndication::FileRetriever.
The documentation for this class was generated from the following files: