TracingController.xml

<Type Name="TracingController" FullName="Android.Webkit.TracingController">
  <TypeSignature Language="C#" Value="public abstract class TracingController : Java.Lang.Object" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit TracingController extends Java.Lang.Object" />
  <TypeSignature Language="DocId" Value="T:Android.Webkit.TracingController" />
  <TypeSignature Language="F#" Value="type TracingController = class&#xA;    inherit Object" />
  <AssemblyInfo>
    <AssemblyName>Mono.Android</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Java.Lang.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[Android.Runtime.Register("android/webkit/TracingController", ApiSince=28, DoNotGenerateAcw=true)]</AttributeName>
      <AttributeName Language="F#">[&lt;Android.Runtime.Register("android/webkit/TracingController", ApiSince=28, DoNotGenerateAcw=true)&gt;]</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android28.0")]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android28.0")&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Manages tracing of WebViews.</summary>
    <remarks>
      <para>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.</para>
      <para>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.</para>
      <para>Example usage:</para>
      <code lang="text/java">TracingController tracingController = TracingController.getInstance();
            tracingController.start(new TracingConfig.Builder()
                             .addCategories(TracingConfig.CATEGORIES_WEB_DEVELOPER).build());
            ...
            tracingController.stop(new FileOutputStream("trace.json"),
                                   Executors.newSingleThreadExecutor());
            </code>
      <para>&lt;/p&gt;</para>
      <para>
        <format type="text/html">
          <a href="https://developer.android.com/reference/android/webkit/TracingController" title="Reference documentation">Java documentation for <code>android.webkit.TracingController</code>.</a>
        </format>
      </para>
      <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public TracingController ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.Webkit.TracingController.#ctor" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register(".ctor", "()V", "", ApiSince=28)]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register(".ctor", "()V", "", ApiSince=28)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.ObsoletedOSPlatform("android29.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.ObsoletedOSPlatform("android29.0")&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android28.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android28.0")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters />
      <Docs>
        <summary>This member is deprecated.</summary>
        <remarks>
          <para>This member is deprecated. This class should not be constructed by applications, use <c>#getInstance</c>
            instead to fetch the singleton instance.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/webkit/TracingController#TracingController()" title="Reference documentation">Java documentation for <code>android.webkit.TracingController.TracingController()</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected TracingController (IntPtr javaReference, Android.Runtime.JniHandleOwnership transfer);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(native int javaReference, valuetype Android.Runtime.JniHandleOwnership transfer) cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.Webkit.TracingController.#ctor(System.IntPtr,Android.Runtime.JniHandleOwnership)" />
      <MemberSignature Language="F#" Value="new Android.Webkit.TracingController : nativeint * Android.Runtime.JniHandleOwnership -&gt; Android.Webkit.TracingController" Usage="new Android.Webkit.TracingController (javaReference, transfer)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="javaReference" Type="System.IntPtr" />
        <Parameter Name="transfer" Type="Android.Runtime.JniHandleOwnership" />
      </Parameters>
      <Docs>
        <param name="javaReference">To be added.</param>
        <param name="transfer">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Instance">
      <MemberSignature Language="C#" Value="public static Android.Webkit.TracingController Instance { get; }" />
      <MemberSignature Language="ILAsm" Value=".property class Android.Webkit.TracingController Instance" />
      <MemberSignature Language="DocId" Value="P:Android.Webkit.TracingController.Instance" />
      <MemberSignature Language="F#" Value="static member Instance : Android.Webkit.TracingController" Usage="Android.Webkit.TracingController.Instance" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android28.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android28.0")&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[get: Android.Runtime.Register("getInstance", "()Landroid/webkit/TracingController;", "", ApiSince=28)]</AttributeName>
          <AttributeName Language="F#">[&lt;get: Android.Runtime.Register("getInstance", "()Landroid/webkit/TracingController;", "", ApiSince=28)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Android.Webkit.TracingController</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Returns the default TracingController instance.</summary>
        <value>The default TracingController instance.</value>
        <remarks>
          <para>Returns the default TracingController instance. At present there is
            only one TracingController instance for all WebView instances,
            however this restriction may be relaxed in a future Android release.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/webkit/TracingController#getInstance()" title="Reference documentation">Java documentation for <code>android.webkit.TracingController.getInstance()</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="IsTracing">
      <MemberSignature Language="C#" Value="public abstract bool IsTracing { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool IsTracing" />
      <MemberSignature Language="DocId" Value="P:Android.Webkit.TracingController.IsTracing" />
      <MemberSignature Language="F#" Value="member this.IsTracing : bool" Usage="Android.Webkit.TracingController.IsTracing" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[get: Android.Runtime.Register("isTracing", "()Z", "GetIsTracingHandler", ApiSince=28)]</AttributeName>
          <AttributeName Language="F#">[&lt;get: Android.Runtime.Register("isTracing", "()Z", "GetIsTracingHandler", ApiSince=28)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[get: System.Runtime.Versioning.SupportedOSPlatform("android28.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.Versioning.SupportedOSPlatform("android28.0")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="JniPeerMembers">
      <MemberSignature Language="C#" Value="public override Java.Interop.JniPeerMembers JniPeerMembers { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Java.Interop.JniPeerMembers JniPeerMembers" />
      <MemberSignature Language="DocId" Value="P:Android.Webkit.TracingController.JniPeerMembers" />
      <MemberSignature Language="F#" Value="member this.JniPeerMembers : Java.Interop.JniPeerMembers" Usage="Android.Webkit.TracingController.JniPeerMembers" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Java.Interop.JniPeerMembers</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Start">
      <MemberSignature Language="C#" Value="public abstract void Start (Android.Webkit.TracingConfig tracingConfig);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Start(class Android.Webkit.TracingConfig tracingConfig) cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.Webkit.TracingController.Start(Android.Webkit.TracingConfig)" />
      <MemberSignature Language="F#" Value="abstract member Start : Android.Webkit.TracingConfig -&gt; unit" Usage="tracingController.Start tracingConfig" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("start", "(Landroid/webkit/TracingConfig;)V", "GetStart_Landroid_webkit_TracingConfig_Handler", ApiSince=28)]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("start", "(Landroid/webkit/TracingConfig;)V", "GetStart_Landroid_webkit_TracingConfig_Handler", ApiSince=28)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android28.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android28.0")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tracingConfig" Type="Android.Webkit.TracingConfig" />
      </Parameters>
      <Docs>
        <param name="tracingConfig">Configuration options to use for tracing.</param>
        <summary>Starts tracing all webviews.</summary>
        <remarks>
          <para>Starts tracing all webviews. Depending on the trace mode in traceConfig
            specifies how the trace events are recorded.
            
            For tracing modes <c>TracingConfig#RECORD_UNTIL_FULL</c> and
            <c>TracingConfig#RECORD_CONTINUOUSLY</c> the events are recorded
            using an internal buffer and flushed to the outputStream when
            <c>#stop(OutputStream, Executor)</c> is called.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/webkit/TracingController#start(android.webkit.TracingConfig)" title="Reference documentation">Java documentation for <code>android.webkit.TracingController.start(android.webkit.TracingConfig)</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Stop">
      <MemberSignature Language="C#" Value="public abstract bool Stop (System.IO.Stream? outputStream, Java.Util.Concurrent.IExecutor executor);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Stop(class System.IO.Stream outputStream, class Java.Util.Concurrent.IExecutor executor) cil managed" />
      <MemberSignature Language="DocId" Value="M:Android.Webkit.TracingController.Stop(System.IO.Stream,Java.Util.Concurrent.IExecutor)" />
      <MemberSignature Language="F#" Value="abstract member Stop : System.IO.Stream * Java.Util.Concurrent.IExecutor -&gt; bool" Usage="tracingController.Stop (outputStream, executor)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("stop", "(Ljava/io/OutputStream;Ljava/util/concurrent/Executor;)Z", "GetStop_Ljava_io_OutputStream_Ljava_util_concurrent_Executor_Handler", ApiSince=28)]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("stop", "(Ljava/io/OutputStream;Ljava/util/concurrent/Executor;)Z", "GetStop_Ljava_io_OutputStream_Ljava_util_concurrent_Executor_Handler", ApiSince=28)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android28.0")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android28.0")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="outputStream" Type="System.IO.Stream" />
        <Parameter Name="executor" Type="Java.Util.Concurrent.IExecutor" />
      </Parameters>
      <Docs>
        <param name="outputStream">The output stream the tracing data will be sent to. If null
                                the tracing data will be discarded.</param>
        <param name="executor">The <c>java.util.concurrent.Executor</c> on which the
                   outputStream <c>java.io.OutputStream#write(byte[])</c> and
                   <c>java.io.OutputStream#close()</c> methods will be invoked.</param>
        <summary>Stops tracing and flushes tracing data to the specified outputStream.</summary>
        <returns>False if the WebView framework was not tracing at the time of the call,
                    true otherwise.</returns>
        <remarks>
          <para>Stops tracing and flushes tracing data to the specified outputStream.
            
            The data is sent to the specified output stream in json format typically
            in chunks by invoking <c>java.io.OutputStream#write(byte[])</c>. On completion
            the <c>java.io.OutputStream#close()</c> method is called.</para>
          <para>
            <format type="text/html">
              <a href="https://developer.android.com/reference/android/webkit/TracingController#stop(java.io.OutputStream,%20java.util.concurrent.Executor)" title="Reference documentation">Java documentation for <code>android.webkit.TracingController.stop(java.io.OutputStream, java.util.concurrent.Executor)</code>.</a>
            </format>
          </para>
          <para>
                    Portions of this page are modifications based on work created and shared by the 
                    <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
                     and used according to terms described in the 
                    <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="ThresholdClass">
      <MemberSignature Language="C#" Value="protected override IntPtr ThresholdClass { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance native int ThresholdClass" />
      <MemberSignature Language="DocId" Value="P:Android.Webkit.TracingController.ThresholdClass" />
      <MemberSignature Language="F#" Value="member this.ThresholdClass : nativeint" Usage="Android.Webkit.TracingController.ThresholdClass" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.IntPtr</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ThresholdType">
      <MemberSignature Language="C#" Value="protected override Type ThresholdType { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Type ThresholdType" />
      <MemberSignature Language="DocId" Value="P:Android.Webkit.TracingController.ThresholdType" />
      <MemberSignature Language="F#" Value="member this.ThresholdType : Type" Usage="Android.Webkit.TracingController.ThresholdType" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Type</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>