libzypp  17.31.11
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
zyppng::AttachMediaItem Class Reference

#include </home/abuild/rpmbuild/BUILD/libzypp-17.31.11/zypp-media/ng/private/provideitem_p.h>

Inheritance diagram for zyppng::AttachMediaItem:
Inheritance graph
[legend]

Public Member Functions

 ~AttachMediaItem ()
 
SignalProxy< void(const zyppng::expected< AttachedMediaInfo * > &) > sigReady ()
 
ProvidePromiseRef< Provide::MediaHandle > promise ()
 
- Public Member Functions inherited from zyppng::ProvideItem
 ProvideItem (ProvidePrivate &parent)
 
 ~ProvideItem ()
 
virtual void released ()
 
State state () const
 
SignalProxy< void(ProvideItem &item, State oldState, State newState)> sigStateChanged ()
 
ProvidePrivate & provider ()
 
virtual bool canRedirectTo (ProvideRequestRef startedReq, const zypp::Url &url)
 
const std::optional< ItemStats > & currentStats () const
 
const std::optional< ItemStats > & previousStats () const
 
virtual std::chrono::steady_clock::time_point startTime () const
 
virtual std::chrono::steady_clock::time_point finishedTime () const
 
void pulse ()
 
virtual zypp::ByteCount bytesExpected () const
 

Static Public Member Functions

static AttachMediaItemRef create (const std::vector< zypp::Url > &urls, const ProvideMediaSpec &request, ProvidePrivate &parent)
 

Protected Member Functions

 AttachMediaItem (const std::vector< zypp::Url > &urls, const ProvideMediaSpec &request, ProvidePrivate &parent)
 
void initialize () override
 
void finishReq (ProvideQueue &queue, ProvideRequestRef finishedReq, const ProvideMessage &msg) override
 
void cancelWithError (std::exception_ptr error) override
 
void finishWithSuccess (AttachedMediaInfo &medium)
 
expected< zypp::media::AuthData > authenticationRequired (ProvideQueue &queue, ProvideRequestRef req, const zypp::Url &effectiveUrl, int64_t lastTimestamp, const std::map< std::string, std::string > &extraFields) override
 
void onMasterItemReady (const zyppng::expected< AttachedMediaInfo *> &result)
 
virtual void finishReq (ProvideQueue &queue, ProvideRequestRef finishedReq, const ProvideMessage &msg)
 
virtual void finishReq (ProvideQueue *queue, ProvideRequestRef finishedReq, const std::exception_ptr excpt)
 
- Protected Member Functions inherited from zyppng::ProvideItem
virtual ItemStats makeStats ()
 
virtual void informalMessage (ProvideQueue &, ProvideRequestRef req, const ProvideMessage &msg)
 
virtual void cacheMiss (ProvideRequestRef req)
 
virtual void finishReq (ProvideQueue *queue, ProvideRequestRef finishedReq, const std::exception_ptr excpt)
 
bool safeRedirectTo (ProvideRequestRef startedReq, const zypp::Url &url)
 
void redirectTo (ProvideRequestRef startedReq, const zypp::Url &url)
 
virtual bool enqueueRequest (ProvideRequestRef request)
 
bool dequeue ()
 
void updateState (const State newState)
 
void setFinished ()
 

Private Attributes

Signal< void(const zyppng::expected< AttachedMediaInfo * > &)> _sigReady
 
bool _promiseCreated = false
 
connection _masterItemConn
 
std::vector< zypp::Url > _mirrorList
 
ProvideMediaSpec _initialSpec
 
ProvideQueue::Config::WorkerType _workerType = ProvideQueue::Config::Invalid
 
ProvidePromiseWeakRef< Provide::MediaHandle > _promise
 
MediaDataVerifierRef _verifier
 

Additional Inherited Members

- Public Types inherited from zyppng::ProvideItem
enum  State {
  Uninitialized, Pending, Downloading, Processing,
  Cancelling, Finalizing, Finished
}
 
- Protected Attributes inherited from zyppng::ProvideItem
ProvideRequestRef _runningReq
 

Detailed Description

Item attaching and verifying a medium

Definition at line 171 of file provideitem_p.h.

Constructor & Destructor Documentation

◆ ~AttachMediaItem()

zyppng::AttachMediaItem::~AttachMediaItem ( )

Definition at line 812 of file provideitem.cc.

◆ AttachMediaItem()

zyppng::AttachMediaItem::AttachMediaItem ( const std::vector< zypp::Url > &  urls,
const ProvideMediaSpec &  request,
ProvidePrivate &  parent 
)
protected

Definition at line 806 of file provideitem.cc.

Member Function Documentation

◆ create()

AttachMediaItemRef zyppng::AttachMediaItem::create ( const std::vector< zypp::Url > &  urls,
const ProvideMediaSpec &  request,
ProvidePrivate &  parent 
)
static

Definition at line 1098 of file provideitem.cc.

◆ sigReady()

SignalProxy< void(const zyppng::expected< AttachedMediaInfo * > &)> zyppng::AttachMediaItem::sigReady ( )

Definition at line 1103 of file provideitem.cc.

◆ promise()

ProvidePromiseRef< Provide::MediaHandle > zyppng::AttachMediaItem::promise ( )

Definition at line 817 of file provideitem.cc.

◆ initialize()

void zyppng::AttachMediaItem::initialize ( )
overrideprotectedvirtual

Called by the controller when the item is supposed to start fetching / processing

Implements zyppng::ProvideItem.

Definition at line 828 of file provideitem.cc.

◆ finishReq() [1/3]

void zyppng::AttachMediaItem::finishReq ( ProvideQueue &  queue,
ProvideRequestRef  finishedReq,
const ProvideMessage &  msg 
)
overrideprotectedvirtual

Request was finished by the queue Base implementation handles redirect, metalink and error messages. If a different message is received, cancelWithError is called.

A subclass has to overload this function to handle success messages

Reimplemented from zyppng::ProvideItem.

Definition at line 1108 of file provideitem.cc.

◆ cancelWithError()

void zyppng::AttachMediaItem::cancelWithError ( std::exception_ptr  error)
overrideprotectedvirtual

Cancels all running requests and immediately moves to error state

Implements zyppng::ProvideItem.

Definition at line 1042 of file provideitem.cc.

◆ finishWithSuccess()

void zyppng::AttachMediaItem::finishWithSuccess ( AttachedMediaInfo &  medium)
protected

Definition at line 1002 of file provideitem.cc.

◆ authenticationRequired()

expected< zypp::media::AuthData > zyppng::AttachMediaItem::authenticationRequired ( ProvideQueue &  queue,
ProvideRequestRef  req,
const zypp::Url &  effectiveUrl,
int64_t  lastTimestamp,
const std::map< std::string, std::string > &  extraFields 
)
overrideprotectedvirtual

Request needs authentication data, the function is supposed to return the AuthData to use for the response, or an error The default implementation simply uses the given URL to look for a Auth match in the zypp::media::CredentialManager.

Reimplemented from zyppng::ProvideItem.

Definition at line 1181 of file provideitem.cc.

◆ onMasterItemReady()

void zyppng::AttachMediaItem::onMasterItemReady ( const zyppng::expected< AttachedMediaInfo *> &  result)
protected

Definition at line 1073 of file provideitem.cc.

◆ finishReq() [2/3]

void zyppng::ProvideItem::finishReq
protected

Request was finished by the queue Base implementation handles redirect, metalink and error messages. If a different message is received, cancelWithError is called.

A subclass has to overload this function to handle success messages

Definition at line 190 of file provideitem.cc.

◆ finishReq() [3/3]

void zyppng::ProvideItem::finishReq
protected

Request was finished with a error The base implementation simply calls cancelWithError

Note
queue is allowed to be a nullptr here

Definition at line 382 of file provideitem.cc.

Member Data Documentation

◆ _sigReady

Signal< void( const zyppng::expected<AttachedMediaInfo *> & )> zyppng::AttachMediaItem::_sigReady
private

Definition at line 195 of file provideitem_p.h.

◆ _promiseCreated

bool zyppng::AttachMediaItem::_promiseCreated = false
private

Definition at line 196 of file provideitem_p.h.

◆ _masterItemConn

connection zyppng::AttachMediaItem::_masterItemConn
private

Definition at line 197 of file provideitem_p.h.

◆ _mirrorList

std::vector<zypp::Url> zyppng::AttachMediaItem::_mirrorList
private

Definition at line 198 of file provideitem_p.h.

◆ _initialSpec

ProvideMediaSpec zyppng::AttachMediaItem::_initialSpec
private

Definition at line 199 of file provideitem_p.h.

◆ _workerType

ProvideQueue::Config::WorkerType zyppng::AttachMediaItem::_workerType = ProvideQueue::Config::Invalid
private

Definition at line 200 of file provideitem_p.h.

◆ _promise

ProvidePromiseWeakRef<Provide::MediaHandle> zyppng::AttachMediaItem::_promise
private

Definition at line 201 of file provideitem_p.h.

◆ _verifier

MediaDataVerifierRef zyppng::AttachMediaItem::_verifier
private

Definition at line 202 of file provideitem_p.h.

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