FxNANetworkRequest.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 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 "../FxCommonFramework.h"
#include "../UI/FxUIObject.h"
#include "../Core/FxUIByteArray.h"
#include "../Core/FxUIVariant.h"
#include "../Core/FxUIUrl.h"
 
using CFxNAByteArray = CFxUIByteArray;
template< typename T >
using CFxNAList = std::vector< T >;
using CFxNAUrl = CFxUIUrl;
using CFxNAVariant = CFxUIVariant;
 
class CFxNANetworkRequestImpl;
 
#if defined( Q_OS_IOS )
    typedef void* FxNetworkRequestHandle;
#elif defined( Q_OS_ANDROID )
    // TODO implementation
    typedef CFxJavaHandle* FxNetworkRequestHandle;
#else
    #if defined(XENON)
    // TODO implementation
    typedef void* FxNetworkRequestHandle;
    #else
    class QNetworkRequest;
    typedef QNetworkRequest* FxNetworkRequestHandle;
    #endif
#endif

class COMMONUI_API CFxNANetworkRequest
{
public:

    enum KnownHeaders
    {
        ContentTypeHeader, 
        ContentLengthHeader, 
        LocationHeader, 
        LastModifiedHeader, 
        CookieHeader, 
        SetCookieHeader, 
        ContentDispositionHeader,  
        UserAgentHeader, 
        ServerHeader 
    };

    enum Attribute
    {
        HttpStatusCodeAttribute, 
        HttpReasonPhraseAttribute, 
        RedirectionTargetAttribute, 
        ConnectionEncryptedAttribute, 
        CacheLoadControlAttribute, 
        CacheSaveControlAttribute, 
        SourceIsFromCacheAttribute, 
        DoNotBufferUploadDataAttribute, 
        HttpPipeliningAllowedAttribute, 
        HttpPipeliningWasUsedAttribute, 
        CustomVerbAttribute, 
        CookieLoadControlAttribute, 
        AuthenticationReuseAttribute, 
        CookieSaveControlAttribute, 
        MaximumDownloadBufferSizeAttribute, // internal 
        DownloadBufferAttribute, // internal
        SynchronousRequestAttribute,   // internal
        BackgroundRequestAttribute, 
        SpdyAllowedAttribute, 
        SpdyWasUsedAttribute, 
        EmitAllUploadProgressSignalsAttribute, 
        FollowRedirectsAttribute, 
        HTTP2AllowedAttribute, 
        HTTP2WasUsedAttribute, 
        OriginalContentLengthAttribute, 
        RedirectPolicyAttribute, 
 
        User = 1000, 
        UserMax = 32767 
    };

    explicit CFxNANetworkRequest( const CFxNAUrl& url = CFxNAUrl() );

    CFxNANetworkRequest( const CFxNANetworkRequest& other );

    CFxNANetworkRequest& operator=( const CFxNANetworkRequest& other );

    ~CFxNANetworkRequest();
 
    void setHandle( FxNetworkRequestHandle handle );
    FxNetworkRequestHandle getHandle() const;

    void setHeader( CFxNANetworkRequest::KnownHeaders header, const CFxNAVariant& value );

    CFxNAVariant header( CFxNANetworkRequest::KnownHeaders header ) const;

    void setRawHeader( const CFxNAByteArray& headerName, const CFxNAByteArray& headerValue );

    CFxNAVariant rawHeader( const CFxNAByteArray& headerName ) const;

    CFxNAList< CFxNAByteArray > rawHeaderList() const;

    void setUrl( const CFxNAUrl& url );

    CFxNAUrl url() const;
 
    void setRequestTimeout( int timeoutMs );

    int requestTimeout() const;
 
private:
    CFxNANetworkRequestImpl *m_pImpl;
    FxNetworkRequestHandle m_pHandle;
 
    //...
};