OLD | NEW |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CHROME_TEST_BASE_TRACING_H_ | 5 #ifndef CHROME_TEST_BASE_TRACING_H_ |
6 #define CHROME_TEST_BASE_TRACING_H_ | 6 #define CHROME_TEST_BASE_TRACING_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "base/compiler_specific.h" | 10 #include "base/compiler_specific.h" |
11 #include "base/time.h" | 11 #include "base/time.h" |
12 | 12 |
13 namespace tracing { | 13 namespace tracing { |
14 | 14 |
15 // Called from UI thread. | 15 // Called from UI thread. |
16 // Begin tracing specified categories on the browser. | 16 // Begin tracing specified category_patterns on the browser. |
17 // |categories| is a comma-delimited list of category wildcards. A category can | 17 // |category_patterns| is a comma-delimited list of category wildcards. |
18 // have an optional '-' prefix to make it an excluded category. Either all | 18 // A category pattern can have an optional '-' prefix to make categories with |
19 // categories must be included or all must be excluded. | 19 // matching categorys excluded. Either all category_patterns must be included |
| 20 // or all must be excluded. |
20 // | 21 // |
21 // Example: BeginTracing("test_MyTest*"); | 22 // Example: BeginTracing("test_MyTest*"); |
22 // Example: BeginTracing("test_MyTest*,test_OtherStuff"); | 23 // Example: BeginTracing("test_MyTest*,test_OtherStuff"); |
23 // Example: BeginTracing("-excluded_category1,-excluded_category2"); | 24 // Example: BeginTracing("-excluded_category1,-excluded_category2"); |
24 // | 25 // |
25 // See base/debug/trace_event.h for documentation of included and excluded | 26 // See base/debug/trace_event.h for documentation of included and excluded |
26 // categories. | 27 // category_patterns. |
27 bool BeginTracing(const std::string& categories) WARN_UNUSED_RESULT; | 28 bool BeginTracing(const std::string& category_patterns) WARN_UNUSED_RESULT; |
28 | 29 |
29 // Called from UI thread. | 30 // Called from UI thread. |
30 // Specify a watch event in order to use the WaitForWatchEvent function. | 31 // Specify a watch event in order to use the WaitForWatchEvent function. |
31 // After |num_occurrences| of the given event have been seen on a particular | 32 // After |num_occurrences| of the given event have been seen on a particular |
32 // process, WaitForWatchEvent will return. | 33 // process, WaitForWatchEvent will return. |
33 bool BeginTracingWithWatch(const std::string& categories, | 34 bool BeginTracingWithWatch(const std::string& category_patterns, |
34 const std::string& category_name, | 35 const std::string& category_name, |
35 const std::string& event_name, | 36 const std::string& event_name, |
36 int num_occurrences) WARN_UNUSED_RESULT; | 37 int num_occurrences) WARN_UNUSED_RESULT; |
37 | 38 |
38 // Called from UI thread. | 39 // Called from UI thread. |
39 // Wait on the event set with BeginTracingWithWatch. If non-zero, return after | 40 // Wait on the event set with BeginTracingWithWatch. If non-zero, return after |
40 // |timeout| regardless of watch event notification. Returns true if watch event | 41 // |timeout| regardless of watch event notification. Returns true if watch event |
41 // occurred, false if it timed out. | 42 // occurred, false if it timed out. |
42 bool WaitForWatchEvent(base::TimeDelta timeout) WARN_UNUSED_RESULT; | 43 bool WaitForWatchEvent(base::TimeDelta timeout) WARN_UNUSED_RESULT; |
43 | 44 |
44 // Called from UI thread. | 45 // Called from UI thread. |
45 // End trace and collect the trace output as a json string. | 46 // End trace and collect the trace output as a json string. |
46 bool EndTracing(std::string* json_trace_output) WARN_UNUSED_RESULT; | 47 bool EndTracing(std::string* json_trace_output) WARN_UNUSED_RESULT; |
47 | 48 |
48 } // namespace tracing | 49 } // namespace tracing |
49 | 50 |
50 #endif // CHROME_TEST_BASE_TRACING_H_ | 51 #endif // CHROME_TEST_BASE_TRACING_H_ |
OLD | NEW |