diff options
Diffstat (limited to 'include/capi/cef_trace_capi.h')
| -rw-r--r-- | include/capi/cef_trace_capi.h | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/include/capi/cef_trace_capi.h b/include/capi/cef_trace_capi.h new file mode 100644 index 00000000..183ccdad --- /dev/null +++ b/include/capi/cef_trace_capi.h @@ -0,0 +1,118 @@ +// Copyright (c) 2023 Marshall A. Greenblatt. All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the name Chromium Embedded +// Framework nor the names of its contributors may be used to endorse +// or promote products derived from this software without specific prior +// written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +// +// --------------------------------------------------------------------------- +// +// This file was generated by the CEF translator tool and should not edited +// by hand. See the translator.README.txt file in the tools directory for +// more information. +// +// $hash=8d275bd73854b2b8d5a7a5bc55fa737e020705ee$ +// + +#ifndef CEF_INCLUDE_CAPI_CEF_TRACE_CAPI_H_ +#define CEF_INCLUDE_CAPI_CEF_TRACE_CAPI_H_ +#pragma once + +#include "include/capi/cef_base_capi.h" +#include "include/capi/cef_callback_capi.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/// +/// Implement this structure to receive notification when tracing has completed. +/// The functions of this structure will be called on the browser process UI +/// thread. +/// +typedef struct _cef_end_tracing_callback_t { + /// + /// Base structure. + /// + cef_base_ref_counted_t base; + + /// + /// Called after all processes have sent their trace data. |tracing_file| is + /// the path at which tracing data was written. The client is responsible for + /// deleting |tracing_file|. + /// + void(CEF_CALLBACK* on_end_tracing_complete)( + struct _cef_end_tracing_callback_t* self, + const cef_string_t* tracing_file); +} cef_end_tracing_callback_t; + +/// +/// Start tracing events on all processes. Tracing is initialized asynchronously +/// and |callback| will be executed on the UI thread after initialization is +/// complete. +/// +/// If CefBeginTracing was called previously, or if a CefEndTracingAsync call is +/// pending, CefBeginTracing will fail and return false (0). +/// +/// |categories| is a comma-delimited list of category wildcards. A category can +/// have an optional '-' prefix to make it an excluded category. Having both +/// included and excluded categories in the same list is not supported. +/// +/// Examples: - "test_MyTest*" - "test_MyTest*,test_OtherStuff" - +/// "-excluded_category1,-excluded_category2" +/// +/// This function must be called on the browser process UI thread. +/// +CEF_EXPORT int cef_begin_tracing(const cef_string_t* categories, + struct _cef_completion_callback_t* callback); + +/// +/// Stop tracing events on all processes. +/// +/// This function will fail and return false (0) if a previous call to +/// CefEndTracingAsync is already pending or if CefBeginTracing was not called. +/// +/// |tracing_file| is the path at which tracing data will be written and +/// |callback| is the callback that will be executed once all processes have +/// sent their trace data. If |tracing_file| is NULL a new temporary file path +/// will be used. If |callback| is NULL no trace data will be written. +/// +/// This function must be called on the browser process UI thread. +/// +CEF_EXPORT int cef_end_tracing(const cef_string_t* tracing_file, + cef_end_tracing_callback_t* callback); + +/// +/// Returns the current system trace time or, if none is defined, the current +/// high-res time. Can be used by clients to synchronize with the time +/// information in trace events. +/// +CEF_EXPORT int64 cef_now_from_system_trace_time(void); + +#ifdef __cplusplus +} +#endif + +#endif // CEF_INCLUDE_CAPI_CEF_TRACE_CAPI_H_ |