libzypp
17.25.6
|
Handle access to a medium. More...
#include <MediaAccess.h>
Classes | |
class | FileProvider |
Helper class that provides file on construction and cleans up on destruction. More... | |
Public Types | |
typedef intrusive_ptr< MediaAccess > | Ptr |
typedef intrusive_ptr< const MediaAccess > | constPtr |
Public Member Functions | |
MediaAccess () | |
constructor More... | |
void | open (const Url &url, const Pathname &preferred_attach_point="") |
open url. More... | |
bool | isOpen () const |
True if media is open. More... | |
bool | downloads () const |
Hint if files are downloaded or not. More... | |
std::string | protocol () const |
Used Protocol if media is opened, otherwise 'unknown'. More... | |
Url | url () const |
Url if media is opened, otherwise empty. More... | |
void | close () |
close url More... | |
void | attach (bool next=false) |
Use concrete handler to attach the media. More... | |
bool | isAttached () const |
True if media is attached. More... | |
bool | hasMoreDevices () const |
virtual void | getDetectedDevices (std::vector< std::string > &devices, unsigned int &index) const |
Fill in a vector of detected ejectable devices and the index of the currently attached device within the vector. More... | |
Pathname | localRoot () const |
Return the local directory that corresponds to medias url, no matter if media isAttached or not. More... | |
Pathname | localPath (const Pathname &pathname) const |
Short for 'localRoot() + pathname', but returns an empty pathname if media is not open. More... | |
void | disconnect () |
Use concrete handler to disconnect the media. More... | |
void | release (const std::string &ejectDev="") |
Use concrete handler to release the media. More... | |
void | provideFile (const Pathname &filename, const ByteCount &expectedFileSize) const |
Use concrete handler to provide file denoted by path below 'attach point'. More... | |
void | releaseFile (const Pathname &filename) const |
Remove filename below attach point IFF handler downloads files to the local filesystem. More... | |
void | provideDir (const Pathname &dirname) const |
Use concrete handler to provide directory denoted by path below 'attach point' (not recursive!). More... | |
void | provideDirTree (const Pathname &dirname) const |
Use concrete handler to provide directory tree denoted by path below 'attach point' (recursive!!). More... | |
void | releaseDir (const Pathname &dirname) const |
Remove directory tree below attach point IFF handler downloads files to the local filesystem. More... | |
void | releasePath (const Pathname &pathname) const |
Remove pathname below attach point IFF handler downloads files to the local filesystem. More... | |
void | setDeltafile (const Pathname &filename) const |
set a deltafile to be used in the next download More... | |
void | dirInfo (std::list< std::string > &retlist, const Pathname &dirname, bool dots=true) const |
Return content of directory on media via retlist. More... | |
void | dirInfo (filesystem::DirContent &retlist, const Pathname &dirname, bool dots=true) const |
Basically the same as dirInfo above. More... | |
bool | doesFileExist (const Pathname &filename) const |
check if a file exists More... | |
virtual | ~MediaAccess () |
Destructor. More... | |
virtual std::ostream & | dumpOn (std::ostream &str) const |
Overload to realize std::ostream & operator<<. More... | |
void | getFile (const Url &from, const Pathname &to) |
Get file from location at specified by URL and copy it to destination. More... | |
![]() | |
ReferenceCounted () | |
Default ctor. More... | |
ReferenceCounted (const ReferenceCounted &rhs) | |
Copy ctor. More... | |
virtual | ~ReferenceCounted () |
Dtor. More... | |
ReferenceCounted & | operator= (const ReferenceCounted &) |
Assignment. More... | |
unsigned | refCount () const |
Return reference counter value. More... | |
void | ref () const |
Add a reference. More... | |
void | unref () const |
Release a reference. More... | |
Private Member Functions | |
AttachedMedia | attachedMedia () const |
bool | isSharedMedia () const |
void | resetParentId () |
bool | dependsOnParent () const |
bool | dependsOnParent (MediaAccessId parentId, bool exactIdMatch) const |
Private Attributes | |
MediaHandler * | _handler |
handler for 'physical' media == 0 if not open More... | |
Static Private Attributes | |
static const Pathname | _noPath |
Friends | |
class | MediaManager |
class | MediaManager_Impl |
Additional Inherited Members | |
![]() | |
static void | add_ref (const ReferenceCounted *ptr_r) |
Called by zypp::intrusive_ptr to add a reference. More... | |
static void | release (const ReferenceCounted *ptr_r) |
Called by zypp::intrusive_ptr to add a reference. More... | |
![]() | |
virtual void | ref_to (unsigned) const |
Trigger derived classes after refCount was increased. More... | |
virtual void | unref_to (unsigned) const |
Trigger derived classes after refCount was decreased. More... | |
![]() | |
void | intrusive_ptr_add_ref (const ReferenceCounted *ptr_r) |
intrusive_ptr hook to add_ref. More... | |
void | intrusive_ptr_release (const ReferenceCounted *ptr_r) |
intrusive_ptr hook to release. More... | |
std::ostream & | operator<< (std::ostream &str, const ReferenceCounted &obj) |
Stream output. More... | |
Handle access to a medium.
The concrete MediaHandler for a certain url is created on open and deleted on @close.
The inteface here basically checks whether the handler exists, then forwards the request to MediaHandler.
Definition at line 50 of file MediaAccess.h.
Definition at line 53 of file MediaAccess.h.
typedef intrusive_ptr<const MediaAccess> zypp::media::MediaAccess::constPtr |
Definition at line 54 of file MediaAccess.h.
zypp::media::MediaAccess::MediaAccess | ( | ) |
constructor
Definition at line 53 of file MediaAccess.cc.
|
virtual |
Destructor.
Definition at line 59 of file MediaAccess.cc.
|
private |
Definition at line 69 of file MediaAccess.cc.
|
private |
Definition at line 76 of file MediaAccess.cc.
|
private |
Definition at line 83 of file MediaAccess.cc.
|
private |
Definition at line 89 of file MediaAccess.cc.
|
private |
Definition at line 95 of file MediaAccess.cc.
void zypp::media::MediaAccess::open | ( | const Url & | url, |
const Pathname & | preferred_attach_point = "" |
||
) |
open url.
If preferred_attach_point is given, try to use it as attach point.
Caution: The medium can choose a different attach point. Only getAttachPoint() knows the real attach point.
MediaException |
Definition at line 104 of file MediaAccess.cc.
|
inline |
True if media is open.
Definition at line 100 of file MediaAccess.h.
bool zypp::media::MediaAccess::downloads | ( | ) | const |
Hint if files are downloaded or not.
Definition at line 210 of file MediaAccess.cc.
std::string zypp::media::MediaAccess::protocol | ( | ) | const |
Used Protocol if media is opened, otherwise 'unknown'.
Definition at line 201 of file MediaAccess.cc.
Url zypp::media::MediaAccess::url | ( | ) | const |
Url if media is opened, otherwise empty.
Definition at line 221 of file MediaAccess.cc.
void zypp::media::MediaAccess::close | ( | ) |
void zypp::media::MediaAccess::attach | ( | bool | next = false | ) |
Use concrete handler to attach the media.
next | try next available device in turn until end of device list is reached (for media which are accessible through multiple devices like cdroms). |
MediaException |
Definition at line 255 of file MediaAccess.cc.
bool zypp::media::MediaAccess::isAttached | ( | ) | const |
bool zypp::media::MediaAccess::hasMoreDevices | ( | ) | const |
Definition at line 271 of file MediaAccess.cc.
|
virtual |
Fill in a vector of detected ejectable devices and the index of the currently attached device within the vector.
The contents of the vector are the device names (/dev/cdrom and such).
devices | vector to load with the device names |
index | index of the currently used device in the devices vector |
Definition at line 278 of file MediaAccess.cc.
Pathname zypp::media::MediaAccess::localRoot | ( | ) | const |
Return the local directory that corresponds to medias url, no matter if media isAttached or not.
Files requested will be available at 'localRoot() + filename' or better 'localPath( filename )'.
If media is not open an empty pathname is returned.
Definition at line 296 of file MediaAccess.cc.
Short for 'localRoot() + pathname', but returns an empty pathname if media is not open.
Files provided will be available at 'localPath(filename)'.
Definition at line 307 of file MediaAccess.cc.
void zypp::media::MediaAccess::disconnect | ( | ) |
Use concrete handler to disconnect the media.
This is useful for media which e.g. holds open a connection to a server like FTP. After calling disconnect() the media object still is valid and files are present.
After calling disconnect() it's not possible to call provideFile() or provideDir() anymore.
MediaException |
Definition at line 316 of file MediaAccess.cc.
void zypp::media::MediaAccess::release | ( | const std::string & | ejectDev = "" | ) |
Use concrete handler to release the media.
ejectDev | Device to eject. None if empty. |
MediaException |
Definition at line 326 of file MediaAccess.cc.
void zypp::media::MediaAccess::provideFile | ( | const Pathname & | filename, |
const ByteCount & | expectedFileSize | ||
) | const |
Use concrete handler to provide file denoted by path below 'attach point'.
Filename is interpreted relative to the attached url and a path prefix is preserved.
cached | If cached is set to true, the function checks, if the file already exists and doesn't download it again if it does. Currently only the existence is checked, no other file attributes. |
checkonly | If this and 'cached' are set to true only the existence of the file is checked but it's not downloaded. If 'cached' is unset an errer is returned always. |
MediaException |
Definition at line 339 of file MediaAccess.cc.
void zypp::media::MediaAccess::releaseFile | ( | const Pathname & | filename | ) | const |
Remove filename below attach point IFF handler downloads files to the local filesystem.
Never remove anything from media.
MediaException |
Definition at line 359 of file MediaAccess.cc.
void zypp::media::MediaAccess::provideDir | ( | const Pathname & | dirname | ) | const |
Use concrete handler to provide directory denoted by path below 'attach point' (not recursive!).
'dirname' is interpreted relative to the attached url and a path prefix is preserved.
MediaException |
Definition at line 372 of file MediaAccess.cc.
void zypp::media::MediaAccess::provideDirTree | ( | const Pathname & | dirname | ) | const |
Use concrete handler to provide directory tree denoted by path below 'attach point' (recursive!!).
'dirname' is interpreted relative to the attached url and a path prefix is preserved.
MediaException |
Definition at line 382 of file MediaAccess.cc.
void zypp::media::MediaAccess::releaseDir | ( | const Pathname & | dirname | ) | const |
Remove directory tree below attach point IFF handler downloads files to the local filesystem.
Never remove anything from media.
MediaException |
Definition at line 392 of file MediaAccess.cc.
void zypp::media::MediaAccess::releasePath | ( | const Pathname & | pathname | ) | const |
Remove pathname below attach point IFF handler downloads files to the local filesystem.
Never remove anything from media.
If pathname denotes a directory it is recursively removed. If pathname is empty or '/' everything below the attachpoint is recursively removed.
MediaException |
Definition at line 401 of file MediaAccess.cc.
void zypp::media::MediaAccess::setDeltafile | ( | const Pathname & | filename | ) | const |
set a deltafile to be used in the next download
Definition at line 349 of file MediaAccess.cc.
void zypp::media::MediaAccess::dirInfo | ( | std::list< std::string > & | retlist, |
const Pathname & | dirname, | ||
bool | dots = true |
||
) | const |
Return content of directory on media via retlist.
If dots is false entries starting with '.' are not reported.
The request is forwarded to the concrete handler, which may atempt to retieve the content e.g. via 'readdir'
Caution: This is not supported by all media types. Be prepared to handle E_not_supported_by_media.
MediaException |
Definition at line 411 of file MediaAccess.cc.
void zypp::media::MediaAccess::dirInfo | ( | filesystem::DirContent & | retlist, |
const Pathname & | dirname, | ||
bool | dots = true |
||
) | const |
Basically the same as dirInfo above.
The content 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.
Caution: This is not supported by all media types. Be prepared to handle E_not_supported_by_media.
MediaException |
Definition at line 424 of file MediaAccess.cc.
check if a file exists
Asserted that url is a file and not a dir.
MediaException |
Definition at line 437 of file MediaAccess.cc.
|
virtual |
Overload to realize std::ostream & operator<<.
Reimplemented from zypp::base::ReferenceCounted.
Definition at line 447 of file MediaAccess.cc.
Get file from location at specified by URL and copy it to destination.
from | Source URL |
to | Destination file name |
MediaException |
Definition at line 456 of file MediaAccess.cc.
|
friend |
Definition at line 66 of file MediaAccess.h.
|
friend |
Definition at line 67 of file MediaAccess.h.
|
staticprivate |
Definition at line 58 of file MediaAccess.h.
|
private |
handler for 'physical' media == 0 if not open
Definition at line 64 of file MediaAccess.h.