[net] Better StopCaching() handling for HttpCache::Transaction.

net/http/http_cache_transaction.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.
 
 // This file declares HttpCache::Transaction, a private class of HttpCache so
 // it should only be included by http_cache.cc
 
 #ifndef NET_HTTP_HTTP_CACHE_TRANSACTION_H_
 #define NET_HTTP_HTTP_CACHE_TRANSACTION_H_
 
@@ skipping 357 matching lines @@
   int WriteResponseInfoToEntry(bool truncated);
 
   // Helper function, should be called with result of WriteResponseInfoToEntry
   // (or the result of the callback, when WriteResponseInfoToEntry returns
   // ERR_IO_PENDING). Calls DoneWritingToEntry if |result| is not the right
   // number of bytes. It is expected that the state that calls this will
   // return whatever net error code this function returns, which currently
   // is always "OK".
   int OnWriteResponseInfoToEntryComplete(int result);
 
+  // Called when the entire request has successfully finished reading. May start

[hubbe, 2015/07/16 15:56:12]

Please specify if you mean that the client has finished reading from us, or if
we have finished reading from the network.  I think it means the first, I just
want to make it explicit.

[asanka, 2015/07/16 17:57:00]

Done.

+  // the state machine again. Hence should only be called when there are no more
+  // pending operations.
+  int DoneWithRequest();
+
   // Called when we are done writing to the cache entry.
   void DoneWritingToEntry(bool success);
 
+  // Called when we are done with the cache entry.
+  void DoneWithEntry(bool cancel);
+
   // Returns an error to signal the caller that the current read failed. The
   // current operation |result| is also logged. If |restart| is true, the
   // transaction should be restarted.
   int OnCacheReadError(int result, bool restart);
 
   // Called when the cache lock timeout fires.
   void OnAddToEntryTimeout(base::TimeTicks start_time);
 
   // Deletes the current partial cache entry (sparse), and optionally removes
   // the control object (partial_).
@@ skipping 44 matching lines @@
   HttpCache::ActiveEntry* entry_;
   HttpCache::ActiveEntry* new_entry_;
   scoped_ptr<HttpTransaction> network_trans_;
   CompletionCallback callback_;  // Consumer's callback.
   HttpResponseInfo response_;
   HttpResponseInfo auth_response_;
   const HttpResponseInfo* new_response_;
   std::string cache_key_;
   Mode mode_;
   bool reading_;  // We are already reading. Never reverts to false once set.
-  bool invalid_range_;  // We may bypass the cache for this request.
-  bool truncated_;  // We don't have all the response data.
-  bool is_sparse_;  // The data is stored in sparse byte ranges.
+  bool invalid_range_;    // We may bypass the cache for this request.
+  bool truncated_;        // We don't have all the response data.
+  bool is_sparse_;        // The data is stored in sparse byte ranges.
   bool range_requested_;  // The user requested a byte range.
-  bool handling_206_;  // We must deal with this 206 response.
-  bool cache_pending_;  // We are waiting for the HttpCache.
-  bool done_reading_;  // All available data was read.
-  bool vary_mismatch_;  // The request doesn't match the stored vary data.
+  bool handling_206_;     // We must deal with this 206 response.
+  bool cache_pending_;    // We are waiting for the HttpCache.
+  bool done_writing_;     // All available data was written to the cache entry.
+  bool vary_mismatch_;    // The request doesn't match the stored vary data.
   bool couldnt_conditionalize_request_;
+  bool stopped_caching_;       // Avoid further writes to the cache.
   bool bypass_lock_for_test_;  // A test is exercising the cache lock.
   bool fail_conditionalization_for_test_;  // Fail ConditionalizeRequest.
   scoped_refptr<IOBuffer> read_buf_;
   int io_buf_len_;
   int read_offset_;
   int effective_load_flags_;
   int write_len_;
   scoped_ptr<PartialData> partial_;  // We are dealing with range requests.
   UploadProgress final_upload_progress_;
   CompletionCallback io_callback_;
@@ skipping 24 matching lines @@
   BeforeProxyHeadersSentCallback before_proxy_headers_sent_callback_;
 
   base::WeakPtrFactory<Transaction> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(Transaction);
 };
 
 }  // namespace net
 
 #endif  // NET_HTTP_HTTP_CACHE_TRANSACTION_H_