Added Net logging to FileStream.

net/base/file_stream.h

 // Copyright (c) 2011 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 defines FileStream, a basic interface for reading and writing files
 // synchronously or asynchronously with support for seeking to an offset.
 // Note that even when used asynchronously, only one operation is supported at
 // a time.
 
 #ifndef NET_BASE_FILE_STREAM_H_
 #define NET_BASE_FILE_STREAM_H_
 #pragma once
 
 #include "base/memory/scoped_ptr.h"
 #include "base/platform_file.h"
 #include "net/base/completion_callback.h"
 #include "net/base/net_export.h"
+#include "net/base/net_log.h"
 
 class FilePath;
 
 namespace net {
 
 // TODO(darin): Move this to a more generic location.
 // This explicit mapping matches both FILE_ on Windows and SEEK_ on Linux.
 enum Whence {
   FROM_BEGIN   = 0,
   FROM_CURRENT = 1,
   FROM_END     = 2
 };
 
 class NET_EXPORT FileStream {
  public:
   FileStream();
 
+  // Create a new BoundNetLog and attach it to the stream.

[Randy Smith (Not in Mondays), 2012/01/30 21:27:41]

The primary thing a constructor does is construct an object of the type, so I'd
phrase this as "Construct a file stream with a BoundNetLog attached to the
passed NetLog."

[ahendrickson, 2012/01/30 22:30:53]

Done.

+  FileStream(net::NetLog* log);
+
   // Construct a FileStream with an existing file handle and opening flags.
   // |file| is valid file handle.
   // |flags| is a bitfield of base::PlatformFileFlags when the file handle was
   // opened.
   // The already opened file will not be automatically closed when FileStream
   // is destructed.
   FileStream(base::PlatformFile file, int flags);
 
   virtual ~FileStream();
 
@@ skipping 84 matching lines @@
   // calling.
   //
   /// Returns an error code if the operation could not be performed.
   //
   // This method should not be called if the stream was opened READ_ONLY.
   virtual int Flush();
 
   // Turns on UMA error statistics gathering.
   void EnableErrorStatistics();
 
+  // Sets the source reference for net-internals logging.

[Randy Smith (Not in Mondays), 2012/01/30 21:27:41]

If this has restrictions with regard to how the FileStream was constructed, they
should be spelled out in the comment.  (I.e. if this is only valid to call if
the FileStream was constructed with a net::NetLog*, or behaves differently in
that case, it should be spelled out in the comment).

[ahendrickson, 2012/01/30 22:30:53]

The only difference is that if |net_log_| is invalid, nothing happens.
Commented.

+  void SetBoundNetLogSource(const net::BoundNetLog& log);
+
  private:
   class AsyncContext;
   friend class AsyncContext;
   friend class FileStreamTest;
 
   // This member is used to support asynchronous reads.  It is non-null when
   // the FileStream was opened with PLATFORM_FILE_ASYNC.
   scoped_ptr<AsyncContext> async_context_;
 
   base::PlatformFile file_;
   int open_flags_;
   bool auto_closed_;
   bool record_uma_;
+  net::BoundNetLog net_log_;

[Randy Smith (Not in Mondays), 2012/01/30 21:27:41]

I'm uncomfortable calling a BoundNetLog a net_log_, given that we've got NetLogs
wandering around as well.  I'd suggest you regularize naming so that you always
use the same string (or a variation of it) for BoundNetLogs and NetLogs. 
(Suggestion, not requirement.)

[ahendrickson, 2012/01/30 22:30:53]

Done.

 
   DISALLOW_COPY_AND_ASSIGN(FileStream);
 };
 
 }  // namespace net
 
 #endif  // NET_BASE_FILE_STREAM_H_