| 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_PUBLIC_CHILD_REQUEST_PEER_H_ | 5 #ifndef CONTENT_PUBLIC_CHILD_REQUEST_PEER_H_ |
| 6 #define CONTENT_PUBLIC_CHILD_REQUEST_PEER_H_ | 6 #define CONTENT_PUBLIC_CHILD_REQUEST_PEER_H_ |
| 7 | 7 |
| 8 #include <string> | 8 #include <string> |
| 9 | 9 |
| 10 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
| 11 #include "base/memory/scoped_ptr.h" |
| 11 #include "content/common/content_export.h" | 12 #include "content/common/content_export.h" |
| 12 | 13 |
| 13 class GURL; | 14 class GURL; |
| 14 | 15 |
| 15 namespace base { | 16 namespace base { |
| 16 class TimeTicks; | 17 class TimeTicks; |
| 17 } | 18 } |
| 18 | 19 |
| 19 namespace net { | 20 namespace net { |
| 20 struct RedirectInfo; | 21 struct RedirectInfo; |
| 21 } | 22 } |
| 22 | 23 |
| 23 namespace content { | 24 namespace content { |
| 24 | 25 |
| 25 struct ResourceResponseInfo; | 26 struct ResourceResponseInfo; |
| 26 | 27 |
| 27 // This is implemented by our custom resource loader within content. The Peer | 28 // This is implemented by our custom resource loader within content. The Peer |
| 28 // and it's bridge should have identical lifetimes as they represent each end of | 29 // and it's bridge should have identical lifetimes as they represent each end of |
| 29 // a communication channel. | 30 // a communication channel. |
| 30 // | 31 // |
| 31 // These callbacks mirror net::URLRequest::Delegate and the order and | 32 // These callbacks mirror net::URLRequest::Delegate and the order and |
| 32 // conditions in which they will be called are identical. See url_request.h | 33 // conditions in which they will be called are identical. See url_request.h |
| 33 // for more information. | 34 // for more information. |
| 34 class CONTENT_EXPORT RequestPeer { | 35 class CONTENT_EXPORT RequestPeer { |
| 35 public: | 36 public: |
| 37 // This class represents data gotten from the Browser process. Each data |
| 38 // consists of |payload|, |length| and |encoded_length|. The payload is |
| 39 // valid only when the data instance is valid. |
| 40 // In order to work with Chrome resource loading IPC, it is desirable to |
| 41 // reclaim data in FIFO order in a RequestPeer in terms of performance. |
| 42 // |payload|, |length| and |encoded_length| functions are thread-safe, but |
| 43 // the data object itself must be destroyed on the original thread. |
| 44 class CONTENT_EXPORT ReceivedData { |
| 45 public: |
| 46 virtual ~ReceivedData() {} |
| 47 virtual const char* payload() const = 0; |
| 48 virtual int length() const = 0; |
| 49 // The encoded_length is the length of the encoded data transferred |
| 50 // over the network, which could be different from data length (e.g. for |
| 51 // gzipped content). |
| 52 virtual int encoded_length() const = 0; |
| 53 }; |
| 54 |
| 36 // Called as upload progress is made. | 55 // Called as upload progress is made. |
| 37 // note: only for requests with upload progress enabled. | 56 // note: only for requests with upload progress enabled. |
| 38 virtual void OnUploadProgress(uint64 position, uint64 size) = 0; | 57 virtual void OnUploadProgress(uint64 position, uint64 size) = 0; |
| 39 | 58 |
| 40 // Called when a redirect occurs. The implementation may return false to | 59 // Called when a redirect occurs. The implementation may return false to |
| 41 // suppress the redirect. The ResourceResponseInfo provides information about | 60 // suppress the redirect. The ResourceResponseInfo provides information about |
| 42 // the redirect response and the RedirectInfo includes information about the | 61 // the redirect response and the RedirectInfo includes information about the |
| 43 // request to be made if the method returns true. | 62 // request to be made if the method returns true. |
| 44 virtual bool OnReceivedRedirect(const net::RedirectInfo& redirect_info, | 63 virtual bool OnReceivedRedirect(const net::RedirectInfo& redirect_info, |
| 45 const ResourceResponseInfo& info) = 0; | 64 const ResourceResponseInfo& info) = 0; |
| 46 | 65 |
| 47 // Called when response headers are available (after all redirects have | 66 // Called when response headers are available (after all redirects have |
| 48 // been followed). | 67 // been followed). |
| 49 virtual void OnReceivedResponse(const ResourceResponseInfo& info) = 0; | 68 virtual void OnReceivedResponse(const ResourceResponseInfo& info) = 0; |
| 50 | 69 |
| 51 // Called when a chunk of response data is downloaded. This method may be | 70 // Called when a chunk of response data is downloaded. This method may be |
| 52 // called multiple times or not at all if an error occurs. This method is | 71 // called multiple times or not at all if an error occurs. This method is |
| 53 // only called if RequestInfo::download_to_file was set to true, and in | 72 // only called if RequestInfo::download_to_file was set to true, and in |
| 54 // that case, OnReceivedData will not be called. | 73 // that case, OnReceivedData will not be called. |
| 55 // The encoded_data_length is the length of the encoded data transferred | 74 // The encoded_data_length is the length of the encoded data transferred |
| 56 // over the network, which could be different from data length (e.g. for | 75 // over the network, which could be different from data length (e.g. for |
| 57 // gzipped content). | 76 // gzipped content). |
| 58 virtual void OnDownloadedData(int len, int encoded_data_length) = 0; | 77 virtual void OnDownloadedData(int len, int encoded_data_length) = 0; |
| 59 | 78 |
| 60 // Called when a chunk of response data is available. This method may | 79 // Called when a chunk of response data is available. This method may |
| 61 // be called multiple times or not at all if an error occurs. | 80 // be called multiple times or not at all if an error occurs. |
| 62 // The encoded_data_length is the length of the encoded data transferred | 81 virtual void OnReceivedData(scoped_ptr<ReceivedData> data) = 0; |
| 63 // over the network, which could be different from data length (e.g. for | |
| 64 // gzipped content). | |
| 65 virtual void OnReceivedData(const char* data, | |
| 66 int data_length, | |
| 67 int encoded_data_length) = 0; | |
| 68 | 82 |
| 69 // Called when metadata generated by the renderer is retrieved from the | 83 // Called when metadata generated by the renderer is retrieved from the |
| 70 // cache. This method may be called zero or one times. | 84 // cache. This method may be called zero or one times. |
| 71 virtual void OnReceivedCachedMetadata(const char* data, int len) {} | 85 virtual void OnReceivedCachedMetadata(const char* data, int len) {} |
| 72 | 86 |
| 73 // Called when the response is complete. This method signals completion of | 87 // Called when the response is complete. This method signals completion of |
| 74 // the resource load. | 88 // the resource load. |
| 75 virtual void OnCompletedRequest(int error_code, | 89 virtual void OnCompletedRequest(int error_code, |
| 76 bool was_ignored_by_handler, | 90 bool was_ignored_by_handler, |
| 77 bool stale_copy_in_cache, | 91 bool stale_copy_in_cache, |
| 78 const std::string& security_info, | 92 const std::string& security_info, |
| 79 const base::TimeTicks& completion_time, | 93 const base::TimeTicks& completion_time, |
| 80 int64 total_transfer_size) = 0; | 94 int64 total_transfer_size) = 0; |
| 81 | 95 |
| 82 protected: | 96 protected: |
| 83 virtual ~RequestPeer() {} | 97 virtual ~RequestPeer() {} |
| 84 }; | 98 }; |
| 85 | 99 |
| 86 } // namespace content | 100 } // namespace content |
| 87 | 101 |
| 88 #endif // CONTENT_PUBLIC_CHILD_REQUEST_PEER_H_ | 102 #endif // CONTENT_PUBLIC_CHILD_REQUEST_PEER_H_ |
| OLD | NEW |