Add support for redirecting ResourceHandlers to a blob: URL

content/browser/streams/chrome_stream.h

+// Copyright (c) 2013 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_STREAMS_CHROME_STREAM_H_
+#define CONTENT_BROWSER_STREAMS_CHROME_STREAM_H_
+
+#include <deque>
+
+#include "base/basictypes.h"
+#include "base/memory/ref_counted.h"
+#include "base/observer_list.h"
+#include "googleurl/src/gurl.h"
+
+namespace net {
+class IOBuffer;
+}
+
+namespace content {
+
+class ChromeStream;
+
+class ChromeStreamObserver {

[darin (slow to review), 2013/02/13 09:18:12]

nit: We don't usually name classes with a Chrome* prefix.  I realize this was
probably to match the "chrome-stream:" URL scheme we had discussed.

nit: I recommend creating a separate header file for the *Observer class.  There
will be cases where someone will only need to include the Observer interface
definition in their header file.

[Zachary Kuznia, 2013/02/13 16:37:14]

Done.

+ public:
+  // Sent when there is data available to be read from the stream.
+  virtual void OnDataAvailable(ChromeStream* stream) = 0;
+
+  // Sent when the stream has been fully read, and will not be recieving more
+  // data.
+  virtual void OnStreamComplete(ChromeStream* stream) = 0;
+
+  // Sent when space becomes available in the stream, and the source should
+  // resume reading.
+  virtual void OnBufferAvailable(ChromeStream* stream) = 0;
+
+ protected:
+  virtual ~ChromeStreamObserver() {}
+};
+
+// A stream that sends data from an existing ResourceHandler to an internal URL
+// that can be read by an internal consumer.
+class ChromeStream
+    : public base::RefCountedThreadSafe<ChromeStream> {
+ public:
+  // Create a stream useable from the |security_origin|
+  ChromeStream(const GURL& security_origin);
+
+  void AddObserver(ChromeStreamObserver* observer);

[darin (slow to review), 2013/02/13 09:18:12]

It seems like the observer interface is used both to notify the producer of data
that they can add more data as well as to notify the consumer(s) of data that
they can get more data.  But, given the signature of ReadRawData, I'm not sure
that this class really supports multiple readers.  Plus, I remember in our
discussions you said the stream would only have one reader because it was
intended to be temporary.

It'd be good to document the intended processing model in this header file.

I might look at separating the consumer notifications from the producer
notifications.  It seems potentially awkward to have those notifications merged
into a single interface.

[Zachary Kuznia, 2013/02/13 16:37:14]

Split the observers into StreamReadObserver and StreamWriteObserver.
Moved observers into separate files
Added comments to describe this class

+  void RemoveObserver(ChromeStreamObserver* observer);
+
+  // Add the data in |buffer| to the stream.  Takes ownership of |buffer|
+  void AddData(scoped_refptr<net::IOBuffer> buffer, size_t size);
+
+  // Indicate that this stream will not be receiving any more data.
+  void MarkComplete();
+
+  // Read a maximum of |buf_size| from the stream into |buf|.  Sets
+  // |*bytes_read| to the number of bytes actually read.
+  // returns false if there is no data available, but the stream is not closed.
+  bool ReadRawData(net::IOBuffer* buf, int buf_size, int* bytes_read);
+
+  // Indicates that the stream's buffer is getting full, and future reads from
+  // the source should be deferred.
+  bool should_defer() const { return should_defer_; }
+
+  void SetStreamUrl(GURL url) { stream_url_ = url; }
+  GURL stream_url() { return stream_url_; }
+
+  GURL& security_origin() { return security_origin_; }
+
+ private:
+  friend class base::RefCountedThreadSafe<ChromeStream>;
+
+  typedef std::deque<std::pair<scoped_refptr<net::IOBuffer>,
+                               size_t> > ContentVector;
+
+  // Notify observers if the stream is fully read.
+  void MaybeNotifyComplete();
+
+  ~ChromeStream();
+
+  ContentVector buffer_;
+  size_t current_size_;
+  size_t bytes_read_;
+  bool complete_;
+
+  bool should_defer_;
+
+  GURL security_origin_;
+
+  GURL stream_url_;
+
+  ObserverList<ChromeStreamObserver> observers_;
+
+  DISALLOW_COPY_AND_ASSIGN(ChromeStream);
+};
+
+}  // namespace content
+
+#endif  // CONTENT_BROWSER_STREAMS_CHROME_STREAM_H_