github.com/ckxng/wakeup@v0.0.0-20190105202853-90356a5f5a15/include/capi/cef_trace_capi.h (about)

     1  // Copyright (c) 2014 Marshall A. Greenblatt. All rights reserved.
     2  //
     3  // Redistribution and use in source and binary forms, with or without
     4  // modification, are permitted provided that the following conditions are
     5  // met:
     6  //
     7  //    * Redistributions of source code must retain the above copyright
     8  // notice, this list of conditions and the following disclaimer.
     9  //    * Redistributions in binary form must reproduce the above
    10  // copyright notice, this list of conditions and the following disclaimer
    11  // in the documentation and/or other materials provided with the
    12  // distribution.
    13  //    * Neither the name of Google Inc. nor the name Chromium Embedded
    14  // Framework nor the names of its contributors may be used to endorse
    15  // or promote products derived from this software without specific prior
    16  // written permission.
    17  //
    18  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    19  // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    20  // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    21  // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    22  // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    23  // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    24  // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    25  // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    26  // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    27  // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    28  // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    29  //
    30  // ---------------------------------------------------------------------------
    31  //
    32  // This file was generated by the CEF translator tool and should not edited
    33  // by hand. See the translator.README.txt file in the tools directory for
    34  // more information.
    35  //
    36  
    37  #ifndef CEF_INCLUDE_CAPI_CEF_TRACE_CAPI_H_
    38  #define CEF_INCLUDE_CAPI_CEF_TRACE_CAPI_H_
    39  #pragma once
    40  
    41  #ifdef __cplusplus
    42  extern "C" {
    43  #endif
    44  
    45  #include "include/capi/cef_base_capi.h"
    46  
    47  
    48  ///
    49  // Implement this structure to receive notification when tracing has completed.
    50  // The functions of this structure will be called on the browser process UI
    51  // thread.
    52  ///
    53  typedef struct _cef_end_tracing_callback_t {
    54    ///
    55    // Base structure.
    56    ///
    57    cef_base_t base;
    58  
    59    ///
    60    // Called after all processes have sent their trace data. |tracing_file| is
    61    // the path at which tracing data was written. The client is responsible for
    62    // deleting |tracing_file|.
    63    ///
    64    void (CEF_CALLBACK *on_end_tracing_complete)(
    65        struct _cef_end_tracing_callback_t* self,
    66        const cef_string_t* tracing_file);
    67  } cef_end_tracing_callback_t;
    68  
    69  
    70  ///
    71  // Start tracing events on all processes. Tracing begins immediately locally,
    72  // and asynchronously on child processes as soon as they receive the
    73  // BeginTracing request.
    74  //
    75  // If CefBeginTracing was called previously, or if a CefEndTracingAsync call is
    76  // pending, CefBeginTracing will fail and return false (0).
    77  //
    78  // |categories| is a comma-delimited list of category wildcards. A category can
    79  // have an optional '-' prefix to make it an excluded category. Having both
    80  // included and excluded categories in the same list is not supported.
    81  //
    82  // Example: "test_MyTest*" Example: "test_MyTest*,test_OtherStuff" Example:
    83  // "-excluded_category1,-excluded_category2"
    84  //
    85  // This function must be called on the browser process UI thread.
    86  ///
    87  CEF_EXPORT int cef_begin_tracing(const cef_string_t* categories);
    88  
    89  ///
    90  // Stop tracing events on all processes.
    91  //
    92  // This function will fail and return false (0) if a previous call to
    93  // CefEndTracingAsync is already pending or if CefBeginTracing was not called.
    94  //
    95  // |tracing_file| is the path at which tracing data will be written and
    96  // |callback| is the callback that will be executed once all processes have sent
    97  // their trace data. If |tracing_file| is NULL a new temporary file path will be
    98  // used. If |callback| is NULL no trace data will be written.
    99  //
   100  // This function must be called on the browser process UI thread.
   101  ///
   102  CEF_EXPORT int cef_end_tracing_async(const cef_string_t* tracing_file,
   103      cef_end_tracing_callback_t* callback);
   104  
   105  ///
   106  // Returns the current system trace time or, if none is defined, the current
   107  // high-res time. Can be used by clients to synchronize with the time
   108  // information in trace events.
   109  ///
   110  CEF_EXPORT int64 cef_now_from_system_trace_time();
   111  
   112  #ifdef __cplusplus
   113  }
   114  #endif
   115  
   116  #endif  // CEF_INCLUDE_CAPI_CEF_TRACE_CAPI_H_