Cleanup and minor refactoring of LogDnsClient

components/certificate_transparency/log_dns_client.h

 // Copyright 2016 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 COMPONENTS_CERTIFICATE_TRANSPARENCY_LOG_DNS_CLIENT_H_
 #define COMPONENTS_CERTIFICATE_TRANSPARENCY_LOG_DNS_CLIENT_H_
 
 #include <stdint.h>
 
 #include <list>
@@ skipping 51 matching lines @@
   // net::ERR_TEMPORARILY_THROTTLED.
   void NotifyWhenNotThrottled(const base::Closure& callback);
 
   // Queries a CT log to retrieve an audit proof for the leaf with |leaf_hash|.
   // The log is identified by |domain_for_log|, which is the DNS name used as a
   // suffix for all queries.
   // The |leaf_hash| is the SHA-256 Merkle leaf hash (see RFC6962, section 2.1).
   // The size of the CT log tree, for which the proof is requested, must be
   // provided in |tree_size|.
   // The leaf index and audit proof obtained from the CT log will be placed in
-  // |proof|.
+  // |out_proof|.
   // If the proof cannot be obtained synchronously, this method will return
   // net::ERR_IO_PENDING and invoke |callback| once the query is complete.
   // Returns:
   // - net::OK if the query was successful.
   // - net::ERR_IO_PENDING if the query was successfully started and is
   //   continuing asynchronously.
   // - net::ERR_TEMPORARILY_THROTTLED if the maximum number of concurrent
   //   queries are already in progress. Try again later.
-  //   TODO(robpercival): Provide a mechanism to notify the caller when no
-  //   longer throttled.
   // - net::ERR_NAME_RESOLUTION_FAILED if DNS queries are not possible.
   //   Check that the DnsConfig returned by NetworkChangeNotifier is valid.
   // - net::ERR_INVALID_ARGUMENT if an argument is invalid, e.g. |leaf_hash| is
   //   not a SHA-256 hash.
   net::Error QueryAuditProof(base::StringPiece domain_for_log,
                              std::string leaf_hash,
                              uint64_t tree_size,
-                             net::ct::MerkleAuditProof* proof,
+                             net::ct::MerkleAuditProof* out_proof,
                              const net::CompletionCallback& callback);
 
  private:
   class AuditProofQuery;
 
   // Invoked when an audit proof query completes.
   // |query| is the query that has completed.
   // |callback| is the user-provided callback that should be notified.
   // |net_error| is a net::Error indicating success or failure.
   void QueryAuditProofComplete(AuditProofQuery* query,
@@ skipping 21 matching lines @@
   // Callbacks to invoke when the number of concurrent queries is at its limit.
   std::list<base::Closure> not_throttled_callbacks_;
   // Creates weak_ptrs to this, for callback purposes.
   base::WeakPtrFactory<LogDnsClient> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(LogDnsClient);
 };
 
 }  // namespace certificate_transparency
 #endif  // COMPONENTS_CERTIFICATE_TRANSPARENCY_LOG_DNS_CLIENT_H_