1 /* 2 * Copyright (C) 2023 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package android.tracing.perfetto; 18 19 /** 20 * The interface for the trace function called from native on a trace call with a context. 21 * 22 * @param <DataSourceInstanceType> The type of DataSource this tracing context is for. 23 * @param <TlsStateType> The type of the custom TLS state, if any is used. 24 * @param <IncrementalStateType> The type of the custom incremental state, if any is used. 25 * 26 * @hide 27 */ 28 public interface TraceFunction<DataSourceInstanceType extends DataSourceInstance, 29 TlsStateType, IncrementalStateType> { 30 31 /** 32 * This function will be called synchronously (i.e., always before trace() returns) only if 33 * tracing is enabled and the data source has been enabled in the tracing config. 34 * It can be called more than once per trace() call, in the case of concurrent tracing sessions 35 * (or even if the data source is instantiated twice within the same trace config). 36 * 37 * @param ctx the tracing context to trace for in the trace function. 38 */ trace(TracingContext<DataSourceInstanceType, TlsStateType, IncrementalStateType> ctx)39 void trace(TracingContext<DataSourceInstanceType, TlsStateType, IncrementalStateType> ctx); 40 } 41