FxNANetworkReply.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 "../UI/FxUISignal.h"
#include "../Core/FxUIByteArray.h"
#include "../Core/FxUIVariant.h"
#include "../Core/FxUIUrl.h"
#include "FxNANetworkRequest.h"
 
#include <cstddef>
#include <vector>
#include <utility>
 
using CFxNAByteArray = CFxUIByteArray;
template <typename T>
using CFxNAList = std::vector<T>;
template< typename T1, typename T2 >
using CFxNAPair = std::pair< T1, T2 >;
using CFxNAString = CFxUIString;
using CFxNAVariant = CFxUIVariant;
using CFxNAUrl = CFxUIUrl;

class COMMONUI_API CFxNANetworkReply : public CFxUIObject
{
public:
    enum NetworkError
    {
        NoError = 0, 
 
        // network layer errors [relating to the destination server] (1-99):
        ConnectionRefusedError = 1, 
        RemoteHostClosedError, 
        HostNotFoundError, 
        TimeoutError, 
        OperationCanceledError, 
        SslHandshakeFailedError, 
        TemporaryNetworkFailureError, 
        NetworkSessionFailedError, 
        BackgroundRequestNotAllowedError, 
        TooManyRedirectsError, 
        InsecureRedirectError, 
        UnknownNetworkError = 99, 
 
        // proxy errors (101-199):
        ProxyConnectionRefusedError = 101, 
        ProxyConnectionClosedError, 
        ProxyNotFoundError, 
        ProxyTimeoutError, 
        ProxyAuthenticationRequiredError, 
        UnknownProxyError = 199, 
 
        // content errors (201-299):
        ContentAccessDenied = 201, 
        ContentOperationNotPermittedError, 
        ContentNotFoundError, 
        AuthenticationRequiredError, 
        ContentReSendError, 
        ContentConflictError, 
        ContentGoneError, 
        UnknownContentError = 299, 
 
        // protocol errors
        ProtocolUnknownError = 301, 
        ProtocolInvalidOperationError, 
        ProtocolFailure = 399, 
 
        // Server side errors (401-499)
        InternalServerError = 401, 
        OperationNotImplementedError, 
        ServiceUnavailableError, 
        UnknownServerError = 499 
    };

    CFxNANetworkReply() = delete;

    explicit CFxNANetworkReply( FxNativeHandle nativeReply );

    CFxNANetworkReply( std::nullptr_t ) = delete;

    ~CFxNANetworkReply();

    void setRequest( const CFxNANetworkRequest& request );

    const CFxNANetworkRequest& request() const;

    bool isFinished() const;

    bool isRunning() const;

    NetworkError error() const;

    CFxNAString errorString() const;

    long long bytesAvailable() const;

    CFxNAByteArray readAll();

    long long pos() const;

    bool seek( long long pos );

    CFxNAVariant attribute( CFxNANetworkRequest::Attribute code ) const;

    CFxNAVariant header( CFxNANetworkRequest::KnownHeaders header ) const;

    bool hasRawHeader( const CFxNAByteArray& headerName ) const;

    CFxNAByteArray rawHeader( const CFxNAByteArray& headerName ) const;

    CFxNAList< CFxNAByteArray > rawHeaderList() const;

    CFxNAUrl url() const;
 
    typedef CFxNAPair< CFxNAByteArray, CFxNAByteArray > RawHeaderPair;
    const CFxNAList< RawHeaderPair >& rawHeaderPairs() const;
 
    // Slots

    void abort();
 
    // Signals

    CFxUISignal<void( long long bytesReceived, long long bytesTotal )>& downloadProgress();

    CFxUISignal<void( long long bytesSent, long long bytesTotal )>& uploadProgress();

    CFxUISignal<void( void )>& encrypted();

    CFxUISignal<void( NetworkError )>& error();

    CFxUISignal<void( void )>& finished();
 
    //...
};