NetworkTransfer.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/NetworkTransfer.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_NetworkTransfer_h
#define __PCL_NetworkTransfer_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/Control.h>
#include <pcl/UIObject.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS NetworkTransfer : public UIObject
{
public:
 
   NetworkTransfer();
 
   ~NetworkTransfer() override
   {
   }
 
   NetworkTransfer( const NetworkTransfer& ) = delete;
 
   NetworkTransfer& operator =( const NetworkTransfer& ) = delete;
 
   void EnsureUnique() override
   {
      // Unique by definition
   }
 
   static NetworkTransfer& Null();
 
   void SetURL( const String& url, const String& userName = String(), const String& userPassword = String() );
 
   void SetProxyURL( const String& url, const String& userName = String(), const String& userPassword = String() );
 
   void SetSSL( bool useSSL = true, bool forceSSL = false, bool verifyPeer = true, bool verifyHost = true );
 
   void SetCustomHTTPHeaders( const String& nlsHeaders );
 
   void SetConnectionTimeout( int seconds );
 
   bool Download();
 
   bool Upload( fsize_type uploadSize = 0 );
 
   bool POST( const String& fields );
 
   bool SMTP( const String& mailFrom, const StringList& mailRecipients );
 
   void CloseConnection();
 
   String URL() const;
 
   String CustomHTTPHeaders() const;
 
   String ProxyURL() const;
 
   bool PerformedOK() const;
 
   operator bool() const
   {
      return PerformedOK();
   }
 
   bool WasAborted() const;
 
   int ResponseCode() const;
 
   String ContentType() const;
 
   fsize_type BytesTransferred() const;
 
   double TotalSpeed() const;
 
   double TotalTime() const;
 
   String ErrorInformation() const;
 
   using download_event_handler = bool (Control::*)( NetworkTransfer& sender, const void* buffer, fsize_type size );
 
   using upload_event_handler = fsize_type (Control::*)( NetworkTransfer& sender, void* buffer, fsize_type maxSize );
 
   using progress_event_handler = bool (Control::*)( NetworkTransfer& sender,
                                    fsize_type downloadTotal, fsize_type downloadCurrent,
                                    fsize_type uploadTotal, fsize_type uploadCurrent );
 
   void OnDownloadDataAvailable( download_event_handler handler, Control& receiver );
 
   void OnUploadDataRequested( upload_event_handler handler, Control& receiver );
 
   void OnTransferProgress( progress_event_handler handler, Control& receiver );
 
private:
 
   download_event_handler onDownloadDataAvailable = nullptr;
   upload_event_handler   onUploadDataRequested   = nullptr;
   progress_event_handler onTransferProgress      = nullptr;
 
   NetworkTransfer( void* h ) : UIObject( h )
   {
   }
 
   void* CloneHandle() const override;
 
   friend class NetworkTransferEventDispatcher;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_NetworkTransfer_h
 
// ----------------------------------------------------------------------------
// EOF pcl/NetworkTransfer.h - Released 2024-01-13T15:47:58Z