Protobuf for Traffic Annotation and first use by a URLFetcher.

net/url_request/url_fetcher.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.
 
 #ifndef NET_URL_REQUEST_URL_FETCHER_H_
 #define NET_URL_REQUEST_URL_FETCHER_H_
 
 #include <stdint.h>
 
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "base/callback_forward.h"
 #include "base/memory/ref_counted.h"
 #include "base/supports_user_data.h"
 #include "net/base/net_export.h"
+#include "net/traffic_annotation/network_traffic_annotation.h"
 #include "net/url_request/url_request.h"
 
 class GURL;
 
 namespace base {
 class FilePath;
 class SequencedTaskRunner;
 class TaskRunner;
 class TimeDelta;
 }
@@ skipping 70 matching lines @@
   // Used by SetUploadStreamFactory. The callback should assign a fresh upload
   // data stream every time it's called.
   typedef base::Callback<std::unique_ptr<UploadDataStream>()>
       CreateUploadStreamCallback;
 
   virtual ~URLFetcher();
 
   // |url| is the URL to send the request to. It must be valid.
   // |request_type| is the type of request to make.
   // |d| the object that will receive the callback on fetch completion.
+  // This function should not be used in Chromium, please use the version with
+  // NetworkTrafficAnnotationTag below instead.
   static std::unique_ptr<URLFetcher> Create(
       const GURL& url,
       URLFetcher::RequestType request_type,
       URLFetcherDelegate* d);
 
   // Like above, but if there's a URLFetcherFactory registered with the
   // implementation it will be used. |id| may be used during testing to identify
   // who is creating the URLFetcher.
+  // This function should not be used in Chromium, please use the version with
+  // NetworkTrafficAnnotationTag below instead.
+  static std::unique_ptr<URLFetcher> Create(
+      int id,
+      const GURL& url,
+      URLFetcher::RequestType request_type,
+      URLFetcherDelegate* d);
+
+  // |url| is the URL to send the request to. It must be valid.
+  // |request_type| is the type of request to make.
+  // |d| the object that will receive the callback on fetch completion.
+  // |traffic_annotation| metadata about the network traffic send via this
+  // URLFetcher, see net::DefineNetworkTrafficAnnotation. Note that:
+  // - net provides the API for tagging requests with an opaque identifier.
+  // - tools/traffic_annotation/traffic_annotation.proto contains the Chrome
+  // specific .proto describing the verbose annotation format that Chrome's
+  // callsites are expected to follow.
+  // - tools/traffic_annotation/ contains sample and template for annotation and
+  // tools will be added for verification following crbug.com/690323.
+  static std::unique_ptr<URLFetcher> Create(
+      const GURL& url,
+      URLFetcher::RequestType request_type,
+      URLFetcherDelegate* d,
+      NetworkTrafficAnnotationTag traffic_annotation);
+
+  // Like above, but if there's a URLFetcherFactory registered with the
+  // implementation it will be used. |id| may be used during testing to identify
+  // who is creating the URLFetcher.
   static std::unique_ptr<URLFetcher> Create(
       int id,
       const GURL& url,
       URLFetcher::RequestType request_type,
-      URLFetcherDelegate* d);
+      URLFetcherDelegate* d,
+      NetworkTrafficAnnotationTag traffic_annotation);
 
   // Cancels all existing URLFetchers.  Will notify the URLFetcherDelegates.
   // Note that any new URLFetchers created while this is running will not be
   // cancelled.  Typically, one would call this in the CleanUp() method of an IO
   // thread, so that no new URLRequests would be able to start on the IO thread
   // anyway.  This doesn't prevent new URLFetchers from trying to post to the IO
   // thread though, even though the task won't ever run.
   static void CancelAll();
 
   // Normally, URLFetcher will abort loads that request SSL client certificate
@@ skipping 198 matching lines @@
   // be removed once the URLFetcher is destroyed.  User should not take
   // ownership more than once, or call this method after taking ownership.
   virtual bool GetResponseAsFilePath(
       bool take_ownership,
       base::FilePath* out_response_path) const = 0;
 };
 
 }  // namespace net
 
 #endif  // NET_URL_REQUEST_URL_FETCHER_H_