[Resumption 6/11] Add a RESUMING_INTERNAL state to DownloadItem.

content/browser/download/download_item_impl.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_IMPL_H_
 #define CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_IMPL_H_
 
 #include <string>
 
 #include "base/basictypes.h"
@@ skipping 198 matching lines @@
   // should be considered complete.
   virtual void MarkAsComplete();
 
  private:
   // Fine grained states of a download.
   enum DownloadInternalState {
     // Unless otherwise specified, state transitions are linear forward
     // in this list.
 
     // Includes both before and after file name determination.
     // TODO(rdsmith): Put in state variable for file name determination.

[Randy Smith (Not in Mondays), 2013/05/09 01:00:57]

Add a note that RESUMING_INTERNAL can transition into this state?

[asanka, 2013/05/09 16:54:33]

Done.

     IN_PROGRESS_INTERNAL,
 
     // Between commit point (dispatch of download file release) and completed.
     // Embedder may be opening the file in this state.  Note that the
     // DownloadItem may be deleted (by shutdown) or interrupted (e.g. due to a
     // failure during AnnotateWithSourceInformation()) in this state.
     COMPLETING_INTERNAL,
 
     // After embedder has had a chance to auto-open.  User may now open
     // or auto-open based on extension.
     COMPLETE_INTERNAL,
 
     // User has cancelled the download.
     // Only incoming transition IN_PROGRESS->

[Randy Smith (Not in Mondays), 2013/05/09 01:00:57]

This is wrong; we can cancel interrupted downloads as well.  Willing to fix it?

[asanka, 2013/05/09 16:54:33]

Done.

     CANCELLED_INTERNAL,
 
     // An error has interrupted the download.
-    // Only incoming transition IN_PROGRESS->
+    // Only incoming transitions IN_PROGRESS-> and RESUMING_INTERNAL.

[Randy Smith (Not in Mondays), 2013/05/09 01:00:57]

I don't actually remember how I was thinking of the transition syntax I used
here (which means you're welcome to change it to something else if you think
it's confusing), but this looks inconsistent.  If you keep this syntax, either
add a --> after the RESUMING_INTERNAL, or put the RESUMING_INTERNAL next to the
IN_PROGRESS so that the existing arrow can do double duty?

Alternatively, you could do a transition summary at the beginning of this enum
in either transition table form, or just listing all possible transitions.

[asanka, 2013/05/09 16:54:33]

I added notes listing all the transitions. Let me know if it's not clear.

The transitions weren't linear enough for a single comment at the top. :-/

     INTERRUPTED_INTERNAL,
 
+    // A request to resume this interrupted download is in progress.
+    // Only incoming transition INTERRUPTED_INTERNAL.
+    RESUMING_INTERNAL,
+
     MAX_DOWNLOAD_INTERNAL_STATE,
   };
 
   // DownloadDestinationObserver
   virtual void DestinationUpdate(int64 bytes_so_far,
                                  int64 bytes_per_sec,
                                  const std::string& hash_state) OVERRIDE;
   virtual void DestinationError(DownloadInterruptReason reason) OVERRIDE;
   virtual void DestinationCompleted(const std::string& final_hash) OVERRIDE;
 
@@ skipping 40 matching lines @@
                                     const base::FilePath& full_path);
 
   // Called if the embedder took over opening a download, to indicate that
   // the download has been opened.
   void DelayedDownloadOpened(bool auto_opened);
 
   // Called when the entire download operation (including renaming etc)
   // is completed.
   void Completed();
 
+  // Callback invoked when the URLRequest for a download resumption has started.
+  void OnResumeRequestStarted(DownloadItem* item, net::Error error);
+
   // Helper routines -----------------------------------------------------------
 
   // Indicate that an error has occurred on the download.
   void Interrupt(DownloadInterruptReason reason);
 
   // Destroy the DownloadFile object.  If |destroy_file| is true, the file is
   // destroyed with it.  Otherwise, DownloadFile::Detach() is called before
   // object destruction to prevent file destruction. Destroying the file also
   // resets |current_path_|.
   void ReleaseDownloadFile(bool destroy_file);
@@ skipping 185 matching lines @@
   const net::BoundNetLog bound_net_log_;
 
   base::WeakPtrFactory<DownloadItemImpl> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(DownloadItemImpl);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_IMPL_H_