NetworkFactory Class Reference

Network-related functionality. More...

#include <networkfactory.h>

Collaboration diagram for NetworkFactory:

Static Public Member Functions
static QString	networkErrorText (QNetworkReply::NetworkError error_code)
	Gets human readable text for given network error. More...
static QNetworkReply::NetworkError	downloadFile (const QString &url, int timeout, QByteArray &output, bool protected_contents=false, const QString &username=QString(), const QString &password=QString())
	Performs SYNCHRONOUS download of file with given URL and given timeout. More...

Detailed Description

Network-related functionality.

Definition at line 40 of file networkfactory.h.

Member Function Documentation

QNetworkReply::NetworkError NetworkFactory::downloadFile ( const QString &  url, int  timeout, QByteArray &  output, bool  protected_contents = false, const QString &  username = QString(), const QString &  password = QString()  )

static

Performs SYNCHRONOUS download of file with given URL and given timeout.

Parameters

url	Url.
timeout	Download timeout.
output	Output to store data to.
protected_contents	Is destination URL protected?
username	Username.
password	Password.

Returns

Returns indication of network status after the donwload finished.

Definition at line 112 of file networkfactory.cpp.

                                                                                      {
  // Original asynchronous behavior of QNetworkAccessManager
  // is replaced by synchronous behavior in order to make
  // process of downloading of a file easier to understand.

  // Make necessary variables.
  SilentNetworkAccessManager manager;
  QEventLoop loop;
  QTimer timer;
  QNetworkRequest request;
  QNetworkReply *reply;
  QObject originatingObject;

  // Set credential information as originating object.
  originatingObject.setProperty("protected", protected_contents);
  originatingObject.setProperty("username", username);
  originatingObject.setProperty("password", password);
  request.setOriginatingObject(&originatingObject);

  // Set url for this reques.
  request.setUrl(url);

  // Create necessary connections.
  // TODO: Edited, maybe remove this line.
  QObject::connect(qApp, SIGNAL(aboutToQuit()), &loop, SLOT(quit()));
  QObject::connect(&timer, SIGNAL(timeout()), &loop, SLOT(quit()));
  QObject::connect(&manager, SIGNAL(finished(QNetworkReply*)), &loop, SLOT(quit()));

  forever {
    // This timer fires just ONCE.
    timer.setSingleShot(true);

    // Try to open communication channel.
    reply = manager.get(request);

    // Start the timeout timer.
    timer.start(timeout);

    // Enter the event loop.
    loop.exec();

    // At this point one of two things happened:
    //  a) file download was completed,
    //  b) communication timed-out.

    if (timer.isActive()) {
      // Download is complete because timer is still running.
      timer.stop();
    }
    else {
      if (reply != NULL) {
        delete reply;
        reply = NULL;
      }

      // Timer already fired. Download is NOT successful.
      return QNetworkReply::TimeoutError;
    }

    // In this phase, some part of downloading process is completed.
    QUrl redirection_url = reply->attribute(QNetworkRequest::RedirectionTargetAttribute).toUrl();

    if (redirection_url.isValid()) {
      // Communication indicates that HTTP redirection is needed.
      // Setup redirection URL and download again.
      request.setUrl(redirection_url);

      delete reply;
      reply = NULL;
    }
    else {
      // No redirection is indicated. Final file is obtained
      // in our "reply" object.
      break;
    }
  }

  // Read the data into output buffer.
  output = reply->readAll();

  QNetworkReply::NetworkError reply_error = reply->error();

  qDebug("File '%s' fetched with status '%s' (code %d).",
         qPrintable(url),
         qPrintable(networkErrorText(reply_error)),
         reply_error);

  // Delete needed stuff and exit.
  if (reply != NULL) {
    delete reply;
    reply = NULL;
  }

  return reply_error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

QString NetworkFactory::networkErrorText ( QNetworkReply::NetworkError  error_code )

static

Gets human readable text for given network error.

Parameters

error_code

Returns

Returns human readable text for given network error.

Definition at line 48 of file networkfactory.cpp.

                                                                             {
  switch (error_code) {
    case QNetworkReply::ProtocolUnknownError:
    case QNetworkReply::ProtocolFailure:
      //: Network status.
      return tr("protocol error");

    case QNetworkReply::HostNotFoundError:
      //: Network status.
      return tr("host not found");

    case QNetworkReply::RemoteHostClosedError:
    case QNetworkReply::ConnectionRefusedError:
      //: Network status.
      return tr("connection refused");

    case QNetworkReply::TimeoutError:
    case QNetworkReply::ProxyTimeoutError:
      //: Network status.
      return tr("connection timed out");

    case QNetworkReply::SslHandshakeFailedError:
      //: Network status.
      return tr("SSL handshake failed");

    case QNetworkReply::ProxyConnectionClosedError:
    case QNetworkReply::ProxyConnectionRefusedError:
      //: Network status.
      return tr("proxy server connection refused");

    case QNetworkReply::TemporaryNetworkFailureError:
      //: Network status.
      return tr("temporary failure");

    case QNetworkReply::AuthenticationRequiredError:
      //: Network status.
      return tr("authentication failed");

    case QNetworkReply::ProxyAuthenticationRequiredError:
      //: Network status.
      return tr("proxy authentication required");

    case QNetworkReply::ProxyNotFoundError:
      //: Network status.
      return tr("proxy server not found");

    case QNetworkReply::NoError:
      //: Network status.
      return tr("success");

    case QNetworkReply::UnknownContentError:
      //: Network status.
      return tr("uknown content");

    case QNetworkReply::ContentNotFoundError:
      //: Network status.
      return tr("content not found");

    default:
      //: Network status.
      return tr("unknown error");
  }
}

Here is the caller graph for this function:

---

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

• networkfactory.h
• networkfactory.cpp