zypp::media::MediaDIR Class Reference

Implementation class for DIR MediaHandler. More...

#include <MediaDIR.h>

Inheritance diagram for zypp::media::MediaDIR:

zypp::media::MediaHandler List of all members.

Public Member Functions

 MediaDIR (const Url &url_r, const Pathname &attach_point_hint_r)
virtual ~MediaDIR ()

Protected Member Functions

virtual void attachTo (bool next=false)
 Call concrete handler to attach the media.
virtual void releaseFrom (bool eject)
 Call concrete handler to release the media.
virtual void getFile (const Pathname &filename) const
 Call concrete handler to provide file below attach point.
virtual void getDir (const Pathname &dirname, bool recurse_r) const
 Call concrete handler to provide directory content (not recursive!) below attach point.
virtual void getDirInfo (std::list< std::string > &retlist, const Pathname &dirname, bool dots=true) const
 Call concrete handler to provide a content list of directory on media via retlist.
virtual void getDirInfo (filesystem::DirContent &retlist, const Pathname &dirname, bool dots=true) const
 Basically the same as getDirInfo above.
virtual bool getDoesFileExist (const Pathname &filename) const
 check if a file exists

Detailed Description

Implementation class for DIR MediaHandler.

See also:
MediaHandler

Definition at line 28 of file MediaDIR.h.


Constructor & Destructor Documentation

zypp::media::MediaDIR::MediaDIR const Url url_r,
const Pathname attach_point_hint_r
 

Definition at line 42 of file MediaDIR.cc.

References zypp::Url::getHost(), MIL, and ZYPP_THROW.

virtual zypp::media::MediaDIR::~MediaDIR  )  [inline, virtual]
 

Definition at line 47 of file MediaDIR.h.

References zypp::media::MediaHandler::release().


Member Function Documentation

void zypp::media::MediaDIR::attachTo bool  next = false  )  [protected, virtual]
 

Call concrete handler to attach the media.

Asserted that not already attached, and attachPoint is a directory.

Parameters:
next try next available device in turn until end of device list is reached (for media which are accessible through multiple devices like cdroms).
Exceptions:
MediaException 

Implements zypp::media::MediaHandler.

Definition at line 65 of file MediaDIR.cc.

References zypp::media::MediaHandler::attachPoint(), zypp::media::MediaHandler::getRealPath(), zypp::filesystem::PathInfo::isDir(), zypp::media::MediaHandler::setAttachPoint(), zypp::media::MediaHandler::url(), and ZYPP_THROW.

void zypp::media::MediaDIR::releaseFrom bool  eject  )  [protected, virtual]
 

Call concrete handler to release the media.

If eject is true, and the media is used in one handler instance only, physically eject the media (i.e. CD-ROM).

Asserted that media is attached.

Exceptions:
MediaException 

Implements zypp::media::MediaHandler.

Definition at line 120 of file MediaDIR.cc.

void zypp::media::MediaDIR::getFile const Pathname filename  )  const [protected, virtual]
 

Call concrete handler to provide file below attach point.

Default implementation provided, that returns whether a file is located at 'localRoot + filename'.

Asserted that media is attached.

Exceptions:
MediaException 

Implements zypp::media::MediaHandler.

Definition at line 133 of file MediaDIR.cc.

References zypp::media::MediaHandler::getFile().

void zypp::media::MediaDIR::getDir const Pathname dirname,
bool  recurse_r
const [protected, virtual]
 

Call concrete handler to provide directory content (not recursive!) below attach point.

Return E_not_supported_by_media if media does not support retrieval of directory content.

Default implementation provided, that returns whether a directory is located at 'localRoot + dirname'.

Asserted that media is attached.

Exceptions:
MediaException 

Implements zypp::media::MediaHandler.

Definition at line 145 of file MediaDIR.cc.

References zypp::media::MediaHandler::getDir().

void zypp::media::MediaDIR::getDirInfo std::list< std::string > &  retlist,
const Pathname dirname,
bool  dots = true
const [protected, virtual]
 

Call concrete handler to provide a content list of directory on media via retlist.

If dots is false entries starting with '.' are not reported.

Return E_not_supported_by_media if media does not support retrieval of directory content.

Default implementation provided, that returns the content of a directory at 'localRoot + dirnname' retrieved via 'readdir'.

Asserted that media is attached and retlist is empty.

Exceptions:
MediaException 

Implements zypp::media::MediaHandler.

Definition at line 158 of file MediaDIR.cc.

References zypp::media::MediaHandler::getDirInfo().

void zypp::media::MediaDIR::getDirInfo filesystem::DirContent retlist,
const Pathname dirname,
bool  dots = true
const [protected, virtual]
 

Basically the same as getDirInfo above.

The content list is returned as filesystem::DirContent, which includes name and filetype of each directory entry. Retrieving the filetype usg. requires an additional stat call for each entry, thus it's more expensive than a simple readdir.

Asserted that media is attached and retlist is empty.

Exceptions:
MediaException 

Implements zypp::media::MediaHandler.

Definition at line 172 of file MediaDIR.cc.

References zypp::media::MediaHandler::getDirInfo().

bool zypp::media::MediaDIR::getDoesFileExist const Pathname filename  )  const [protected, virtual]
 

check if a file exists

Asserted that url is a file and not a dir.

Exceptions:
MediaException 

Implements zypp::media::MediaHandler.

Definition at line 178 of file MediaDIR.cc.

References zypp::media::MediaHandler::getDoesFileExist().


The documentation for this class was generated from the following files:
Generated on Thu Apr 24 02:25:10 2008 for zypp by  doxygen 1.4.6