Changeset 189

Timestamp:

02/03/08 15:34:06 (4 years ago)

Author:

uncle_fungus

Message:

doxygenated httpDownloader

Files:

• branches/2.3.2beta3/src/httpDownloader.cpp (modified) (3 diffs)
• branches/2.3.2beta3/src/include/httpDownloader.h (modified) (2 diffs)

branches/2.3.2beta3/src/httpDownloader.cpp

@@ -31 +31 @@
-
-
-/**
-* Create a temporary file and download the remote resource to this file
-*
-* The path to the temporary file is stored in the parameter localFileName, empty string if it could not be created
-* This file must be deleted by the caller, if this is needed, regardless of the return value
-*
-* Use the defined proxy in preferences, if any
-*
-* Using wxURL would have been a lot easier, but wxURL::SetProxy() doesn't work, and I can't ask
-* users to patch their version of wxWindows to compile this app
-**/
-HTTPDownloader::DownloadStatus HTTPDownloader::DownloadFile(const wxString& host, wxUint32 port, const wxString& resource, wxString& localFileName, ProgressManager& progressManager)
-{
@@ -197 +186 @@
-
-
-/**
-* Return the value of the content-length field, if found
-* Return 0 otherwise
-*
-* ! buffer will be modified !
-**/
-wxUint32 HTTPDownloader::ExtractContentSize(wxByte* buffer, wxUint32 bufferSize)
-{
@@ -239 +222 @@
-}
-
-
-
-
-
+
-HTTPDownloader::DownloadStatus HTTPDownloader::Url(const wxString& url, wxString& localFileName, ProgressManager& progressManager)
-{

branches/2.3.2beta3/src/include/httpDownloader.h

@@ -15 +15 @@
-*/
-
+/**
+ * \file httpDownloader
+ * Create a class to download files over http.
+ * \author François Ingelrest
+ * \author Andrew Schofield
+ **/
+
-#ifndef _HTTPDOWNLOADER_H
-#define _HTTPDOWNLOADER_H
@@ -23 +30 @@
-
-
-
-
-
-
-
+
+
-
-
-
+ /**< Preference setting for proxy address */
+ /**< Default value for proxy address */
-
-
-
+ /**< Preference setting for proxy port */
+ /**< Default value for proxy port */
-
-
-
+ /**< Preference setting for whether proxy authentication should be used */
+ /**< Default value for proxy authentication */
-
-
-
+ /**< Preference setting for proxy username */
+ /**< Default value for proxy username */
-
-
-
+ /**< Preference setting for proxy password */
+ /**< Default value for proxy password */
-
-
-
+ /**< Preference setting for use of alternate update source */
+ /**< Default value for alternate update source */
-
-
-
+ /**< Preference setting for use of a local file as update source */
+ /**< Default value for local file */
-
-
-
+ /**< Preference setting for local file location */
+ /**< Default value for local file location */
-
-
-
+ /**< Preference setting for alternate update address */
+ /**< Default value for alternate update address */
-
-
-
-
+
+
+
+
-class HTTPDownloader
-{
-        public:
+                /**
+                 * Download Status definition.
+                 **/
-                typedef enum _DOWNLOAD_STATUS
-                {
-
-
-
-
-
-
+ /**< Temporary file creation error */
+ /**< Temporary file opening error */
+ /**< Connection error */
+ /**< Send request error */
+ /**< Connection aborted */
+ /**< Connection successful */
-                } DownloadStatus;
-
-
-        protected:
+                /**
+                 * Get the size of the downloaded content.
+                 * Uses the content-size field.
+                 * If no field is found, value is 0.
+                 * ! buffer will be modified by this function!
+                 * @param buffer The downloaded content buffer.
+                 * @param bufferSize The size of the downloaded content buffer.
+                 * @return The content size.
+                 **/
-                static wxUint32 ExtractContentSize(wxByte* buffer, wxUint32 bufferSize);
-
-        public:
+                /**
+                 * Create a temporary file and download the remote resource to this file.
+                 *
+                 * The path to the temporary file is stored in the parameter localFileName, empty string if it could not be created
+                 * This file must be deleted by the caller, if this is needed, regardless of the return value
+                 *
+                 * Use the defined proxy in preferences, if any
+                 *
+                 * Using wxURL would have been a lot easier, but wxURL::SetProxy() doesn't work, and I can't ask
+                 * users to patch their version of wxWindows to compile this app
+                 * @param host host part of the url
+                 * @param port port part of url (default is 80)
+                 * @param resource location of file on host
+                 * @param locaFileName Location to download file to
+                 * @param progressManager The progressManager object
+                 * @return A download status object.
+                 **/
-                static DownloadStatus DownloadFile(const wxString& host, wxUint32 port, const wxString& resource, wxString& localFileName, ProgressManager& progressManager);
+
+                /**
+                 * Decontructs a "real" url into its Server, Port and Resource fields.
+                 * This is a wrapper around the DownloadFile method to allow access by a readable url.
+                 * @param url The real url like 'http://fah-web.stanford.edu/psummary.html'
+                 * @param localFileName Location to download file to
+                 * @param progressManager The progressManager object
+                 * @return A download status object.
+                 **/
-                static DownloadStatus Url(const wxString& url, wxString& localFileName, ProgressManager& progressManager);
-};