PlatformTracingController class abstract
Manages tracing of WebViews.
In particular provides functionality for the app to enable/disable tracing of parts of code and to collect tracing data.
This is useful for profiling performance issues, debugging and memory usage analysis in production and real life scenarios.
The resulting trace data is sent back as a byte sequence in json format. This file can be loaded in "chrome://tracing" for further analysis.
- Inheritance
-
- Object
- PlatformInterface
- PlatformTracingController
- Annotations
-
- @SupportedPlatforms.new(platforms: [AndroidPlatform(apiName: 'TracingController', apiUrl: 'https://developer.android.com/reference/androidx/webkit/TracingController')])
Constructors
- PlatformTracingController(PlatformTracingControllerCreationParams params)
-
Creates a new PlatformTracingController
factory
- PlatformTracingController.implementation(PlatformTracingControllerCreationParams params)
- Used by the platform implementation to create a new PlatformTracingController.
- PlatformTracingController.static()
-
Creates a new PlatformTracingController
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- params → PlatformTracingControllerCreationParams
-
The parameters used to initialize the PlatformTracingController.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
isClassSupported(
{TargetPlatform? platform}) → bool -
Check if the current class is supported by the defaultTargetPlatform or a specific
platform. -
isMethodSupported(
PlatformTracingControllerMethod method, {TargetPlatform? platform}) → bool -
Check if the given
methodis supported by the defaultTargetPlatform or a specificplatform. -
isTracing(
) → Future< bool> - Returns whether the WebView framework is tracing.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
start(
{required TracingSettings settings}) → Future< void> -
Starts tracing all
WebViews. Depending on the trace mode in trace config specifies how the trace events are recorded. For tracing modes TracingMode.RECORD_UNTIL_FULL and TracingMode.RECORD_CONTINUOUSLY the events are recorded using an internal buffer and flushed to the outputStream when stop is called. -
stop(
{String? filePath}) → Future< bool> - Stops tracing and flushes tracing data to the specified output stream. The data is sent to the specified output stream in json format typically in chunks.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited