Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KIO::NetAccess Class Reference

Provides a synchronous interface to io jobs. More...

#include <netaccess.h>

List of all members.

Static Public Methods

bool download (const KURL &src, QString &target)
void removeTempFile (const QString &name)
bool upload (const QString &src, const KURL &target)
bool copy (const KURL &src, const KURL &target)
bool dircopy (const KURL &src, const KURL &target)
bool exists (const KURL &url)
bool exists (const KURL &url, bool source)
bool stat (const KURL &url, KIO::UDSEntry &entry)
bool del (const KURL &url)
bool mkdir (const KURL &url, int permissions=-1)
QString mimetype (const KURL &url)
QString lastErrorString ()

Detailed Description

Provides a synchronous interface to io jobs.

Net Transparency, formerly provided by kfmlib, but now done with KIO::Job.

This class isn't meant to be used as a class but only as a simple namespace for static functions, though an instance of the class is built for internal purposes. Whereas a KIO::Job is asynchronous, meaning that the developer has to connect slots for it, KIO::NetAccess provides synchronous downloads and uploads, as well as temporary file creation and removal.

Port to kio done by David Faure, faure@kde.org

Definition at line 52 of file netaccess.h.

Member Function Documentation

bool KIO::NetAccess::copy (  const KURL &    src,
const KURL &    target
)  [static]
 

Alternative method for copying over the network. Overwrite is false, so this will fail if target exists.

This one takes two URLs and is a direct equivalent of KIO::file_copy (not KIO::copy!).

bool KIO::NetAccess::del (  const KURL &    url )  [static]
 

Deletes a file or a directory in an synchronous way.

This is a convenience function for KIO::del (it saves creating a slot and testing for the job result).

Parameters:
url  The file or directory to delete.
Returns:
true on success, false on failure.

bool KIO::NetAccess::dircopy (  const KURL &    src,
const KURL &    target
)  [static]
 

Alternative method for copying over the network. Overwrite is false, so this will fail if target exists.

This one takes two URLs and is a direct equivalent of KIO::copy!.

bool KIO::NetAccess::download (  const KURL &    src,
QString &    target
)  [static]
 

Downloads a file from an arbitrary URL (src) to a temporary file on the local filesystem (target).

If the argument for target is an empty string, download will generate a unique temporary filename in /tmp. Since target is a reference to QString you can access this filename easily. Download will return true if the download was successful, otherwise false.

Special case: If the URL is of kind file:, then no downloading is processed but the full filename is returned in target. That means you have to take care about the target argument. (This is very easy to do, please see the example below.)

Download is synchronous. That means you can use it like this, (assuming u is a string which represents a URL and your application has a loadFile() function): 

 QString tmpFile;
 if( KIO::NetAccess::download( u, tmpFile ) )
 {
   loadFile( tmpFile );
   KIO::NetAccess::removeTempFile( tmpFile );
   }

Of course, your user interface will still process exposure/repaint events during the download.

Parameters:
src  URL Reference to the file to download.
target  String containing the final local location of the file. If you insert an empty string, it will return a location in a temporary spot.

bool KIO::NetAccess::exists (  const KURL &    url,
bool    source
)  [static]
 

Overloaded version of exists A stat() can have two meanings. Either we want to read from this URL, or to check if we can write to it. First case is "source", second is "dest". It is necessary to know what the StatJob is for, to tune the kioslave's behaviour (e.g. with FTP) Tests whether a URL exists.

Parameters:
url  the url we are testing
source  if true, we want to read from that URL. If false, we want to write to it.

bool KIO::NetAccess::exists (  const KURL &    url )  [static]
 

Tests whether a URL exists.

This is a convenience function for KIO::stat (it saves creating a slot and testing for the job result).

Parameters:
url  the url we are testing

QString KIO::NetAccess::lastErrorString (    )  [inline, static]
 

Returns the error string for the last job, in case it failed.

Definition at line 220 of file netaccess.h.

QString KIO::NetAccess::mimetype (  const KURL &    url )  [static]
 

Determines the mimetype of a given URL.

This is a convenience function for KIO::mimetype. You should call this only when really necessary. KMimeType::findByURL can determine extension a lot faster, but less reliably for remote files. Only when findByURL() returns unknown (application/octet-stream) then this one should be used.

Parameters:
url  The URL whose mimetype we are interested in.
Returns:
The mimetype name.

bool KIO::NetAccess::mkdir (  const KURL &    url,
int    permissions = -1
)  [static]
 

Creates a directory in a synchronous way.

This is a convenience function for KIO::mkdir (it saves creating a slot and testing for the job result).

Parameters:
url  The directory to create.
Returns:
true on success, false on failure.

void KIO::NetAccess::removeTempFile (  const QString &    name )  [static]
 

Removes the specified file if and only if it was created by KIO::NetAccess as a temporary file for a former download.

Note: This means that if you created your temporary with KTempFile, use KTempFile::unlink() or KTempFile::setAutoDelete() to have it removed.

Parameters:
name  Path to temporary file to remove. May not be empty.

bool KIO::NetAccess::stat (  const KURL &    url,
KIO::UDSEntry &    entry
)  [static]
 

Tests whether a URL exists and return information on it.

This is a convenience function for KIO::stat (it saves creating a slot and testing for the job result).

Parameters:
url  The URL we are testing.
entry  The result of the stat. Iterate over the list of atoms to get hold of name, type, size, etc., or use KFileItem.

bool KIO::NetAccess::upload (  const QString &    src,
const KURL &    target
)  [static]
 

Uploads file src to URL target.

Both must be specified, unlike download. Note that this is assumed to be used for saving a file over the network, so overwriting is set to true. This is not the case with copy.

Parameters:
src  URL Referencing the file to upload.
target  URL containing the final location of the file.

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:33 2003 for kdelibs by doxygen1.2.18