Detailed Description

@class KIO::ForwardingWorkerBase forwardingworkerbase.h <KIO/ForwardingWorkerBase>

This class should be used as a base for KIO workers acting as a forwarder to other KIO workers. It has been designed to support only local filesystem like KIO workers.

If the resulting KIO worker should be a simple proxy, you only need to implement the ForwardingWorkerBase::rewriteUrl() method.

For more advanced behavior, the classic KIO worker methods should be reimplemented, because their default behavior in this class is to forward using the ForwardingWorkerBase::rewriteUrl() method.

A possible code snippet for an advanced stat() behavior would look like this in the child class:

WorkerResult ChildProtocol::stat(const QUrl &url)
{
    bool is_special = false;

    // Process the URL to see if it should have
    // a special treatment

    if (is_special) {
        // Handle the URL ourselves
        KIO::UDSEntry entry;
        // Fill entry with values
        statEntry(entry);
        return WorkerResult::pass();
    }
    // Setup the KIO worker internal state if
    // required by ChildProtocol::rewriteUrl()
    return ForwardingWorkerBase::stat(url);
}

Of course in this case, you surely need to reimplement listDir() and get() accordingly.

If you want view on directories to be correctly refreshed when something changes on a forwarded URL, you'll need a companion kded module to emit the KDirNotify Files*() D-Bus signals.

@see ForwardingWorkerBase::rewriteUrl() @author Kevin Ottens <ervin@ipsquad.net> @since 5.101