Split a portion of BufferedResourceLoader into a separate class ActiveLoader.

webkit/media/buffered_resource_loader.h

 // Copyright (c) 2011 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 WEBKIT_MEDIA_BUFFERED_RESOURCE_LOADER_H_
 #define WEBKIT_MEDIA_BUFFERED_RESOURCE_LOADER_H_
 
 #include <string>
 
 #include "base/callback.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/timer.h"
 #include "googleurl/src/gurl.h"
 #include "media/base/seekable_buffer.h"
 #include "net/base/file_stream.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebFrame.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebURLLoader.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebURLLoaderClient.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebURLRequest.h"
+#include "webkit/media/active_loader.h"
 #include "webkit/media/web_data_source.h"
 #include "webkit/media/webmediaplayer_impl.h"
 
 namespace media {
 class MediaLog;
 }
 
 namespace webkit_media {
 
 const int64 kPositionNotSpecified = -1;
@@ skipping 46 matching lines @@
   // - net::ERR_INVALID_RESPONSE
   //   An invalid response is received from the server.
   // - (Anything else)
   //   An error code that indicates the request has failed.
   // |event_callback| is called when the response is completed, data is
   // received, the request is suspended or resumed.
   virtual void Start(net::OldCompletionCallback* callback,
                      const base::Closure& event_callback,
                      WebKit::WebFrame* frame);
 
-  // Stop this loader, cancels and request and release internal buffer.
+  // Stops everything associated with this loader, including active loaders

[Ami GONE FROM CHROMIUM, 2011/11/29 18:55:49]

"loaders", plural?  What?

[scherkus (not reviewing), 2011/11/29 21:43:51]

Done.

+  // and any pending callbacks.
+  //
+  // It is safe to delete a BufferedResourceLoader after calling Stop().
   virtual void Stop();
 
   // Reads the specified |read_size| from |position| into |buffer| and when
   // the operation is done invoke |callback| with number of bytes read or an
   // error code. If necessary, will temporarily increase forward capacity of
   // buffer to accomodate an unusually large read.
   // |callback| is called with the following values:
   // - (Anything greater than or equal 0)
   //   Read was successful with the indicated number of bytes read.
   // - net::ERR_FAILED
@@ skipping 18 matching lines @@
 
   // Returns true if the server supports byte range requests.
   virtual bool range_supported();
 
   // Returns true if the resource loader is currently downloading data.
   virtual bool is_downloading_data();
 
   // Returns resulting URL.
   virtual const GURL& url();
 
   // Used to inject a mock used for unittests.

[Ami GONE FROM CHROMIUM, 2011/11/29 18:55:49]

IWBN to doco ownership transfer.  Except AFAICT ownership transfer depends on
how far the loader gets before it's destroyed (since ActiveLoader takes
ownership, but only kicks in during Start).  Rationalize?

[scherkus (not reviewing), 2011/11/29 21:43:51]

Going to make test_loader_ a scoped_ptr<> that gets .released() + will update
docs

-  virtual void SetURLLoaderForTest(WebKit::WebURLLoader* mock_loader);
+  virtual void SetURLLoaderForTest(WebKit::WebURLLoader* test_loader);
 
   // WebKit::WebURLLoaderClient implementation.
   virtual void willSendRequest(
       WebKit::WebURLLoader* loader,
       WebKit::WebURLRequest& newRequest,
       const WebKit::WebURLResponse& redirectResponse);
   virtual void didSendData(
       WebKit::WebURLLoader* loader,
       unsigned long long bytesSent,
       unsigned long long totalBytesToBeSent);
@@ skipping 37 matching lines @@
 
  private:
   friend class BufferedDataSourceTest;
   friend class BufferedResourceLoaderTest;
 
   // Updates the |buffer_|'s forward and backward capacities.
   void UpdateBufferWindow();
 
   // Returns true if we should defer resource loading, based
   // on current buffering scheme.
-  bool ShouldEnableDefer();
+  bool ShouldEnableDefer() const;
 
   // Returns true if we should enable resource loading, based
   // on current buffering scheme.
-  bool ShouldDisableDefer();
+  bool ShouldDisableDefer() const;
 
   // Updates deferring behavior based on current buffering scheme.
   void UpdateDeferBehavior();
 
   // Set defer state to |deferred| and cease/continue downloading data
   // accordingly.
   void SetDeferred(bool deferred);
 
   // Returns true if the current read request can be fulfilled by what is in
   // the buffer.
-  bool CanFulfillRead();
+  bool CanFulfillRead() const;
 
   // Returns true if the current read request will be fulfilled in the future.
-  bool WillFulfillRead();
+  bool WillFulfillRead() const;
 
   // Method that does the actual read and calls the |read_callback_|, assuming
   // the request range is in |buffer_|.
   void ReadInternal();
 
   // If we have made a range request, verify the response from the server.
   bool VerifyPartialResponse(const WebKit::WebURLResponse& response);
 
   // Returns the value for a range request header using parameters
   // |first_byte_position| and |last_byte_position|. Negative numbers other
@@ skipping 18 matching lines @@
 
   // Helper function that returns true if a range request was specified.
   bool IsRangeRequest() const;
 
   // Log everything interesting to |media_log_|.
   void Log();
 
   // A sliding window of buffer.
   scoped_ptr<media::SeekableBuffer> buffer_;
 
-  // True if resource loading was deferred.
-  bool deferred_;
+  // Keeps track of an active WebURLLoader and associated state.
+  scoped_ptr<ActiveLoader> active_loader_;
 
   // Current buffering algorithm in place for resource loading.
   DeferStrategy defer_strategy_;
 
-  // True if resource loading has completed.
-  bool completed_;
-
   // True if a range request was made.
   bool range_requested_;
 
   // True if Range header is supported.
   bool range_supported_;
 
   // Forward capacity to reset to after an extension.
   size_t saved_forward_capacity_;
 
-  // Does the work of loading and sends data back to this client.
-  scoped_ptr<WebKit::WebURLLoader> url_loader_;
-
   GURL url_;
   int64 first_byte_position_;
   int64 last_byte_position_;
   bool single_origin_;
 
   // Callback method that listens to network events.
   base::Closure event_callback_;
 
   // Members used during request start.
   scoped_ptr<net::OldCompletionCallback> start_callback_;
   int64 offset_;
   int64 content_length_;
   int64 instance_size_;
 
   // Members used during a read operation. They should be reset after each
   // read has completed or failed.
   scoped_ptr<net::OldCompletionCallback> read_callback_;
   int64 read_position_;
   size_t read_size_;
   uint8* read_buffer_;
 
   // Offsets of the requested first byte and last byte in |buffer_|. They are
   // written by Read().
   int first_offset_;
   int last_offset_;
 
-  // Used to ensure mocks for unittests are used instead of reset in Start().
-  bool keep_test_loader_;
+  // Used to inject a mocks WebURLLoader for tests during Start().
+  WebKit::WebURLLoader* test_loader_;
 
   // Bitrate of the media. Set to 0 if unknown.
   int bitrate_;
 
   // Playback rate of the media.
   float playback_rate_;
 
   scoped_refptr<media::MediaLog> media_log_;
 
   DISALLOW_COPY_AND_ASSIGN(BufferedResourceLoader);
 };
 
 }  // namespace webkit_media
 
 #endif  // WEBKIT_MEDIA_BUFFERED_RESOURCE_LOADER_H_