ms_http_helper_progress.hpp

/*
##############################################################################
# file: ms_http_helper_progress.hpp                                                 #
# 'msparser' toolkit                                                         #
# Hold information about the progress of an internet file transfer           #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2024 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
 * @(#)$Source: parser/inc/ms_http_helper_progress.hpp $
 * @(#)$Revision: 391e7298502ad6bbe2132c2290996c0b12ee8c2b | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
 * @(#)$Date: 2024-02-01 09:55:20 +0000 $
##############################################################################
 */
 
#ifndef MS_HTTP_HELPER_PROGRESS_HPP
#define MS_HTTP_HELPER_PROGRESS_HPP
 
#include <memory>
#include <string>
 
namespace msparser_internal {
    class ms_http_helper_progress_impl;
}
 
namespace matrix_science
{
 
    class MS_MASCOTRESFILE_API ms_http_helper_progress
    {
        public:
            ms_http_helper_progress();
 
            ~ms_http_helper_progress();
 
            ms_http_helper_progress(const ms_http_helper_progress &src);
 
            ms_http_helper_progress(ms_http_helper_progress &parentProgress, double proportionOffset, UINT64 byteOffset, double scale);
 
#ifndef SWIG
            ms_http_helper_progress& operator=(const ms_http_helper_progress &right);
#endif
 
            void copyFrom(const ms_http_helper_progress * right);
 
            void setAbort();
            
            bool isAbortSet() const;
            
            bool isStarted() const;
 
            UINT64 getCurrentBytes() const;
            UINT64 current() const { return getCurrentBytes(); } // Deprecated and undocumented - not a normal Parser function name
 
            UINT64 getTotalBytes() const;
            UINT64 total() const { return getTotalBytes(); } // Deprecated and undocumented - not a normal Parser function name
            
            double getProportion() const;
            double proportion() const { return getProportion(); } // Deprecated and undocumented - not a normal Parser function name
            
            bool isComplete() const;
 
            bool hasParent() const;
 
        protected:
            ms_http_helper_progress(msparser_internal::ms_http_helper_progress_impl*);
 
        private:
            std::unique_ptr<msparser_internal::ms_http_helper_progress_impl> pImpl_;
 
        friend class ms_http_helper;
        friend class ms_http_client_search;
    };
     // end of http_client_group
} // namespace matrix_science
 
#endif // MS_HTTP_HELPER_PROGRESS_HPP
 
/*------------------------------- End of File -------------------------------*/