libzypp  15.28.6
zypp::parser::ws::WebpinResultFileReader Class Reference

Read packages and repository search result data from from webpin web search results. More...

#include <WebpinResultFileReader.h>

Classes

class  Impl
 

Public Types

typedef function< bool(const
zypp::ws::WebpinResult &)> 
ProcessWebpinResult
 Callback definition. More...
 

Public Member Functions

 WebpinResultFileReader (const Pathname &result_file, const ProcessWebpinResult &callback)
 Constructor. More...
 
 ~WebpinResultFileReader ()
 Dtor. More...
 

Private Attributes

RW_pointer< Impl,
rw_pointer::Scoped< Impl > > 
_pimpl
 

Friends

std::ostream & operator<< (std::ostream &str, const WebpinResultFileReader &obj)
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &str, const WebpinResultFileReader &obj)
 

Detailed Description

Read packages and repository search result data from from webpin web search results.

For each result, a WebpinResult is prepared and _callback is called with the object passed in.

The _callback is provided on construction.

WebpinResultFileReader reader(repo_file,
bind( &SomeClass::callbackfunc, &SomeClassInstance, _1, _2 ) );

Definition at line 46 of file WebpinResultFileReader.h.

Member Typedef Documentation

Callback definition.

First parameter is a WebpinResult object.

Return false from the callback to get a AbortRequestException to be thrown and the processing to be cancelled.

Definition at line 58 of file WebpinResultFileReader.h.

Constructor & Destructor Documentation

zypp::parser::ws::WebpinResultFileReader::WebpinResultFileReader ( const Pathname &  result_file,
const ProcessWebpinResult callback 
)

Constructor.

Creates the reader and start reading.

Parameters
result_fileValid result XML file from Webpin
callbackCallback that will be called for each repository.
progressOptional progress function.
See Also
ProgressData
Exceptions
AbortRequestExceptionIf the callback returns false
ExceptionIf a error occurs at reading / parsing

Definition at line 110 of file WebpinResultFileReader.cc.

zypp::parser::ws::WebpinResultFileReader::~WebpinResultFileReader ( )

Dtor.

Definition at line 116 of file WebpinResultFileReader.cc.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  str,
const WebpinResultFileReader obj 
)
friend

Definition at line 119 of file WebpinResultFileReader.cc.

std::ostream & operator<< ( std::ostream &  str,
const WebpinResultFileReader obj 
)
related

Stream output

Definition at line 119 of file WebpinResultFileReader.cc.

Member Data Documentation

RW_pointer<Impl,rw_pointer::Scoped<Impl> > zypp::parser::ws::WebpinResultFileReader::_pimpl
private

Definition at line 81 of file WebpinResultFileReader.h.


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