StackSamplingRequestBuilder


@RequiresApi(api = 35)
class StackSamplingRequestBuilder : ProfilingRequestBuilder


Request builder to create a request for stack sampling from ProfilingManager.

val listener =
    Consumer<ProfilingResult> { profilingResult ->
        if (profilingResult.errorCode == ProfilingResult.ERROR_NONE) {
            doSomethingWithMyFile(profilingResult.resultFilePath)
        } else {
            doSomethingWithFailure(profilingResult.errorCode, profilingResult.errorMessage)
        }
    }

val cancellationSignal = CancellationSignal()

requestProfiling(
    context,
    StackSamplingRequestBuilder()
        .setBufferSizeKb(1000 /* Requested buffer size in KB */)
        .setDurationMs(10 * 1000 /* Requested profiling duration in millisconds */)
        .setSamplingFrequencyHz(100 /* Requested sampling frequency */)
        .setTag("tag" /* Caller supplied tag for identification */)
        .setCancellationSignal(cancellationSignal)
        .build(),
    Dispatchers.IO.asExecutor(), // Your choice of executor for the callback to occur on.
    listener
)

// Optionally, wait for something interesting to happen and then stop the profiling to receive
// the result as is.
cancellationSignal.cancel()

Summary

Public constructors

Public functions

StackSamplingRequestBuilder
setBufferSizeKb(bufferSizeKb: Int)

Set the buffer size in kilobytes for this profiling request.

StackSamplingRequestBuilder
setDurationMs(durationMs: Int)

Set the duration in milliseconds for this profiling request.

StackSamplingRequestBuilder
setSamplingFrequencyHz(samplingFrequencyHz: Int)

Set the cpu sampling frequency.

Inherited functions

From androidx.core.os.ProfilingRequestBuilder
ProfilingRequest

Build the ProfilingRequest object which can be used with requestProfiling to request profiling.

StackSamplingRequestBuilder

Set a CancellationSignal to request cancellation of the requested trace.

StackSamplingRequestBuilder
setTag(tag: String)

Add data to help identify the output.

Public constructors

StackSamplingRequestBuilder

Added in 1.15.0
StackSamplingRequestBuilder()

Public functions

setBufferSizeKb

Added in 1.15.0
fun setBufferSizeKb(bufferSizeKb: Int): StackSamplingRequestBuilder

Set the buffer size in kilobytes for this profiling request.

setDurationMs

Added in 1.15.0
fun setDurationMs(durationMs: Int): StackSamplingRequestBuilder

Set the duration in milliseconds for this profiling request.

setSamplingFrequencyHz

Added in 1.15.0
fun setSamplingFrequencyHz(samplingFrequencyHz: Int): StackSamplingRequestBuilder

Set the cpu sampling frequency.