FxNetworkAccessManager.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2023 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "DDKERNEL.h"
#include "FxString.h"
 
#include <QtCore/QObject>
#include <QtNetwork/QNetworkRequest>
 
#include "FxPragmaPush.h"
 
class QNetworkReply;
class QNetworkProxy;
 
class DDKERNEL_API CFxNetworkReply
{
public:
    CFxNetworkReply();
    virtual ~CFxNetworkReply();
 
    virtual void finishedRequest( QNetworkReply* ) = 0;
 
    virtual void downloadProgress( qint64 bytesReceived, qint64 bytesTotal ) = 0;
 
};
 
class DDKERNEL_API CFxNetworkAccessManager : public QObject
{
    Q_OBJECT
 
public:
    struct Parameter
    {
        Parameter() 
        {}
 
        Parameter(const CFxString &key, const QByteArray& data) : sKey(key), sData(data)
        {}
 
        CFxString   sKey;
        QByteArray  sData;
    };
 
    typedef std::vector< Parameter > ParametersList;
 
    struct AccessData
    {
        AccessData()
            : replyInterface(0)
            , bBlocking(false)
            , bIgnoreTimeout(false)
            , bGet(false)
            , bIgnoreProxyAndAuthentication(false)
            , bNotDefaultContentType( false )
            , bRetry(true)
        {}
 
        AccessData(
            CFxNetworkReply* reply,
            const QNetworkRequest& req,
            bool blocking = false,
            bool bIgnoreProxyAndAuthentication = false,
            bool bNotDefaultType = false )
            : replyInterface(reply)
            , request(req)
            , bBlocking(blocking)
            , bIgnoreTimeout(false)
            , bGet(false)
            , bIgnoreProxyAndAuthentication( bIgnoreProxyAndAuthentication )
            , bNotDefaultContentType( bNotDefaultType )
            , bRetry(true)
        {}
 
        CFxNetworkReply* replyInterface;
 
        QNetworkRequest request;
 
        ParametersList  lParameters;
 
        bool bBlocking;
 
        bool bIgnoreTimeout;
 
        bool bGet;
 
        bool bIgnoreProxyAndAuthentication;
 
        bool bNotDefaultContentType;
 
        bool bRetry;
 
        QByteArray qOverrideParameters;
    };
 
    CFxNetworkAccessManager();
    virtual ~CFxNetworkAccessManager();
    
    virtual QNetworkReply* post( const AccessData& data ) = 0;
 
    virtual QNetworkReply* get( const AccessData& data ) = 0;
 
    virtual QNetworkProxy proxy() = 0;
 
    virtual void setProxy(const QNetworkProxy& proxy) = 0;
 
    virtual bool findProxyServer() = 0;
 
    virtual int showDialog() = 0;
 
    virtual void setUseSystemProxyConfiguration( bool enable ) = 0;
    virtual bool usesSystemProxyConfiguration() = 0;
 
    virtual QMetaObject::Connection connectToProxyUpdated( std::function<void( QNetworkProxy )> slot ) = 0;
};
 
#include "FxPragmaPop.h"