OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CONTENT_BROWSER_LOADER_STREAM_WRITER_H_ | 5 #ifndef CONTENT_BROWSER_LOADER_STREAM_WRITER_H_ |
6 #define CONTENT_BROWSER_LOADER_STREAM_WRITER_H_ | 6 #define CONTENT_BROWSER_LOADER_STREAM_WRITER_H_ |
7 | 7 |
| 8 #include "base/callback.h" |
8 #include "base/macros.h" | 9 #include "base/macros.h" |
9 #include "base/memory/ref_counted.h" | 10 #include "base/memory/ref_counted.h" |
10 #include "content/browser/streams/stream_write_observer.h" | 11 #include "content/browser/streams/stream_write_observer.h" |
11 | 12 |
12 class GURL; | 13 class GURL; |
13 | 14 |
14 namespace net { | 15 namespace net { |
15 class IOBuffer; | 16 class IOBuffer; |
16 } | 17 } |
17 | 18 |
18 namespace content { | 19 namespace content { |
19 | 20 |
20 class ResourceController; | |
21 class Stream; | 21 class Stream; |
22 class StreamRegistry; | 22 class StreamRegistry; |
23 | 23 |
24 // StreamWriter is a helper class for ResourceHandlers which route their output | 24 // StreamWriter is a helper class for ResourceHandlers which route their output |
25 // into a Stream. It manages an internal buffer and handles back-pressure from | 25 // into a Stream. It manages an internal buffer and handles back-pressure from |
26 // the Stream's reader. | 26 // the Stream's reader. |
27 class StreamWriter : public StreamWriteObserver { | 27 class StreamWriter : public StreamWriteObserver { |
28 public: | 28 public: |
29 // Creates a new StreamWriter without an initialized Stream or controller. The | 29 // Creates a new StreamWriter without an initialized Stream or controller. The |
30 // controller must be set before the writer is used. | 30 // controller must be set before the writer is used. |
31 StreamWriter(); | 31 StreamWriter(); |
32 ~StreamWriter() override; | 32 ~StreamWriter() override; |
33 | 33 |
34 Stream* stream() { return stream_.get(); } | 34 Stream* stream() { return stream_.get(); } |
35 | 35 |
36 void set_controller(ResourceController* controller) { | |
37 controller_ = controller; | |
38 } | |
39 | |
40 // When immediate mode is enabled, the |stream_| is flushed every time new | 36 // When immediate mode is enabled, the |stream_| is flushed every time new |
41 // data is made available by calls to OnReadCompleted. | 37 // data is made available by calls to OnReadCompleted. |
42 void set_immediate_mode(bool enabled) { immediate_mode_ = enabled; } | 38 void set_immediate_mode(bool enabled) { immediate_mode_ = enabled; } |
43 | 39 |
44 // Initializes the writer with a new Stream in |registry|. |origin| will be | 40 // Initializes the writer with a new Stream in |registry|. |origin| will be |
45 // used to construct the URL for the Stream. See WebCore::BlobURL and and | 41 // used to construct the URL for the Stream. See WebCore::BlobURL and and |
46 // WebCore::SecurityOrigin in Blink to understand how origin check is done on | 42 // WebCore::SecurityOrigin in Blink to understand how origin check is done on |
47 // resource loading. | 43 // resource loading. |cancel_callback| must be called if the StreamWriter |
| 44 // closes the stream. |
48 void InitializeStream(StreamRegistry* registry, | 45 void InitializeStream(StreamRegistry* registry, |
49 const GURL& origin); | 46 const GURL& origin, |
| 47 const base::Closure& cancel_callback); |
50 | 48 |
51 // Prepares a buffer to read data from the request. This call will be followed | 49 // Prepares a buffer to read data from the request. This call will be followed |
52 // by either OnReadCompleted (on successful read or EOF) or destruction. The | 50 // by either OnReadCompleted (on successful read or EOF) or destruction. The |
53 // buffer may not be recycled until OnReadCompleted is called. If |min_size| | 51 // buffer may not be recycled until OnReadCompleted is called. If |min_size| |
54 // is not -1, it is the minimum size of the returned buffer. | 52 // is not -1, it is the minimum size of the returned buffer. |
55 // | 53 // |
56 // OnWillRead may be called before the stream is initialized. This is to | 54 // OnWillRead may be called before the stream is initialized. This is to |
57 // support MimeTypeResourceHandler which reads the initial chunk of data | 55 // support MimeTypeResourceHandler which reads the initial chunk of data |
58 // early. | 56 // early. |
59 void OnWillRead(scoped_refptr<net::IOBuffer>* buf, | 57 void OnWillRead(scoped_refptr<net::IOBuffer>* buf, |
60 int* buf_size, | 58 int* buf_size, |
61 int min_size); | 59 int min_size); |
62 | 60 |
63 // A read was completed, forward the data to the Stream. If |*defer| is set to | 61 // A read was completed, forward the data to the Stream. |
64 // true, the implementation must not continue to process the request until | 62 // |need_more_data_callback| must be called (synchronously or asynchronously) |
65 // Resume is called on |controller_|. | 63 // once the writer is ready for more data. Invoking the callback may result |
| 64 // in more data being received recursively. |
66 // | 65 // |
67 // InitializeStream must have been called before calling OnReadCompleted. | 66 // InitializeStream must have been called before calling OnReadCompleted. |
68 void OnReadCompleted(int bytes_read, bool* defer); | 67 void OnReadCompleted(int bytes_read, |
| 68 const base::Closure& need_more_data_callback); |
69 | 69 |
70 // Called when there is no more data to read to the stream. | 70 // Called when there is no more data to read to the stream. |
71 void Finalize(int status); | 71 void Finalize(int status); |
72 | 72 |
73 private: | 73 private: |
74 // StreamWriteObserver implementation. | 74 // StreamWriteObserver implementation. |
75 void OnSpaceAvailable(Stream* stream) override; | 75 void OnSpaceAvailable(Stream* stream) override; |
76 void OnClose(Stream* stream) override; | 76 void OnClose(Stream* stream) override; |
77 | 77 |
78 ResourceController* controller_; | |
79 scoped_refptr<Stream> stream_; | 78 scoped_refptr<Stream> stream_; |
80 scoped_refptr<net::IOBuffer> read_buffer_; | 79 scoped_refptr<net::IOBuffer> read_buffer_; |
81 bool immediate_mode_; | 80 bool immediate_mode_; |
82 | 81 |
| 82 base::Closure cancel_callback_; |
| 83 base::Closure need_more_data_callback_; |
| 84 |
83 DISALLOW_COPY_AND_ASSIGN(StreamWriter); | 85 DISALLOW_COPY_AND_ASSIGN(StreamWriter); |
84 }; | 86 }; |
85 | 87 |
86 } // namespace content | 88 } // namespace content |
87 | 89 |
88 #endif // CONTENT_BROWSER_LOADER_STREAM_WRITER_H_ | 90 #endif // CONTENT_BROWSER_LOADER_STREAM_WRITER_H_ |
OLD | NEW |