class ConsumerEndpoint

Defined at line 164 of file ../../third_party/perfetto/include/perfetto/ext/tracing/core/tracing_service.h

The API for the Consumer port of the Service.

Subclassed by:

1. The tracing_service_impl.cc business logic when returning it in response

to

the ConnectConsumer() method.

2. The transport layer (e.g., src/ipc) when the consumer and

the service don't talk locally but via some IPC mechanism.

Public Methods

void ~ConsumerEndpoint ()
void EnableTracing (const TraceConfig & , base::ScopedFile )

Enables tracing with the given TraceConfig. The ScopedFile argument is

used only when TraceConfig.write_into_file == true.

If TraceConfig.deferred_start == true data sources are configured via

SetupDataSource() but are not started until StartTracing() is called.

This is to support pre-initialization and fast triggering of traces.

The ScopedFile argument is used only when TraceConfig.write_into_file

== true.

void ChangeTraceConfig (const TraceConfig & )

Update the trace config of an existing tracing session; only a subset

of options can be changed mid-session. Currently the only

supported functionality is expanding the list of producer_name_filters()

(or removing the filter entirely) for existing data sources.

void StartTracing ()

Starts all data sources configured in the trace config. This is used only

after calling EnableTracing() with TraceConfig.deferred_start=true.

It's a no-op if called after a regular EnableTracing(), without setting

deferred_start.

void DisableTracing ()
void CloneSession (CloneSessionArgs )
void Flush (uint32_t timeout_ms, FlushCallback callback, FlushFlags )
void Flush (uint32_t timeout_ms, FlushCallback callback)

This is required for legacy out-of-repo clients like arctraceservice which

use the 2-version parameter.

Defined at line 251 of file ../../third_party/perfetto/include/perfetto/ext/tracing/core/tracing_service.h

void ReadBuffers ()

Tracing data will be delivered invoking Consumer::OnTraceData().

void FreeBuffers ()
void Detach (const std::string & key)

Will call OnDetach().

void Attach (const std::string & key)

Will call OnAttach().

void GetTraceStats ()

Will call OnTraceStats().

void ObserveEvents (uint32_t events_mask)

Start or stop observing events of selected types. |events_mask| specifies

the types of events to observe in a bitmask of ObservableEvents::Type.

To disable observing, pass 0.

Will call OnObservableEvents() repeatedly whenever an event of an enabled

ObservableEventType occurs.

TODO(eseckler): Extend this to support producers

&

data sources.

void QueryServiceState (QueryServiceStateArgs , QueryServiceStateCallback )
void QueryCapabilities (QueryCapabilitiesCallback )
void SaveTraceForBugreport (SaveTraceForBugreportCallback )

Records