OLD | NEW |
| (Empty) |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 #ifndef NET_LOG_NET_LOG_LOGGER_H_ | |
6 #define NET_LOG_NET_LOG_LOGGER_H_ | |
7 | |
8 #include <stdio.h> | |
9 | |
10 #include "base/files/scoped_file.h" | |
11 #include "base/macros.h" | |
12 #include "base/memory/ref_counted.h" | |
13 #include "net/log/net_log.h" | |
14 | |
15 namespace base { | |
16 class DictionaryValue; | |
17 class FilePath; | |
18 class Value; | |
19 } | |
20 | |
21 namespace net { | |
22 | |
23 class URLRequestContext; | |
24 | |
25 // NetLogLogger watches the NetLog event stream, and sends all entries to | |
26 // a file specified on creation. | |
27 // | |
28 // The text file will contain a single JSON object. | |
29 class NET_EXPORT NetLogLogger : public NetLog::ThreadSafeObserver { | |
30 public: | |
31 NetLogLogger(); | |
32 ~NetLogLogger() override; | |
33 | |
34 // Sets the log level to log at. Must be called before StartObserving. | |
35 void set_log_level(NetLog::LogLevel log_level); | |
36 | |
37 // Starts observing |net_log| and writes output to |file|. Must not already | |
38 // be watching a NetLog. Separate from constructor to enforce thread safety. | |
39 // | |
40 // |file| must be a non-NULL empty file that's open for writing. | |
41 // | |
42 // |constants| is an optional legend for decoding constant values used in the | |
43 // log. It should generally be a modified version of GetNetConstants(). If | |
44 // not present, the output of GetNetConstants() will be used. | |
45 // | |
46 // |url_request_context| is an optional URLRequestContext that will be used to | |
47 // pre-populate the log with information about in-progress events. | |
48 // If the context is non-NULL, this must be called on the context's thread. | |
49 void StartObserving(NetLog* net_log, | |
50 base::ScopedFILE file, | |
51 base::Value* constants, | |
52 net::URLRequestContext* url_request_context); | |
53 | |
54 // Stops observing net_log(). Must already be watching. Must be called | |
55 // before destruction of the NetLogLogger and the NetLog. | |
56 // | |
57 // |url_request_context| is an optional argument used to added additional | |
58 // network stack state to the log. If the context is non-NULL, this must be | |
59 // called on the context's thread. | |
60 void StopObserving(net::URLRequestContext* url_request_context); | |
61 | |
62 // net::NetLog::ThreadSafeObserver implementation: | |
63 void OnAddEntry(const NetLog::Entry& entry) override; | |
64 | |
65 private: | |
66 base::ScopedFILE file_; | |
67 | |
68 // The LogLevel to log at. | |
69 NetLog::LogLevel log_level_; | |
70 | |
71 // True if OnAddEntry() has been called at least once. | |
72 bool added_events_; | |
73 | |
74 DISALLOW_COPY_AND_ASSIGN(NetLogLogger); | |
75 }; | |
76 | |
77 } // namespace net | |
78 | |
79 #endif // NET_LOG_NET_LOG_LOGGER_H_ | |
OLD | NEW |