akregator/src/librss

RSS::DataRetriever Class Reference

Abstract baseclass for all data retriever classes. More...

#include <loader.h>

Inheritance diagram for RSS::DataRetriever:
RSS::FileRetriever RSS::OutputRetriever

List of all members.

Signals

void dataRetrieved (const TQByteArray &data, bool success)

Public Member Functions

 DataRetriever ()
virtual ~DataRetriever ()
virtual void retrieveData (const KURL &url)=0
virtual int errorCode () const =0
virtual void abort ()=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 35 of file loader.h.


Constructor & Destructor Documentation

DataRetriever::DataRetriever (  ) 

Default constructor.

Definition at line 30 of file loader.cpp.

DataRetriever::~DataRetriever (  )  [virtual]

Destructor.

Definition at line 34 of file loader.cpp.


Member Function Documentation

void RSS::DataRetriever::dataRetrieved ( const TQByteArray &  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 RSS::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 RSS::FileRetriever, and RSS::OutputRetriever.

virtual void RSS::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.

See also:
Loader::loadFrom()

Implemented in RSS::FileRetriever, and RSS::OutputRetriever.


The documentation for this class was generated from the following files: