org.gradle.profiler

Interface ProfilerController

public interface ProfilerController

Field Summary

Fields

Modifier and Type	Field and Description
static ProfilerController	EMPTY

Method Summary

Modifier and Type	Method and Description
void	startRecording() Tells the profiler to start collecting data (again).
void	startSession() Connects the profiler to the daemon and does any other one-time setup work.
void	stopRecording(java.lang.String pid) Tells the profiler to stop collecting data for now, e.g.
void	stopSession() Ends the profiling session, writing the collected results to disk and disconnecting the profiler from the daemon.

Field Detail

EMPTY

static final ProfilerController EMPTY

Method Detail

startSession

void startSession()
           throws java.io.IOException,
                  java.lang.InterruptedException

Connects the profiler to the daemon and does any other one-time setup work. The profiler should not start collecting data yet. If the profiler cannot connect without starting data collection, it should defer startup to startRecording() instead.

Throws:

java.io.IOException

java.lang.InterruptedException

startRecording

void startRecording()
             throws java.io.IOException,
                    java.lang.InterruptedException

Tells the profiler to start collecting data (again). Profilers may chose to throw an exception if they don't support multiple start/stop operations.

Throws:

java.io.IOException

java.lang.InterruptedException

stopRecording

void stopRecording(java.lang.String pid)
            throws java.io.IOException,
                   java.lang.InterruptedException

Tells the profiler to stop collecting data for now, e.g. so it doesn't profile cleanup tasks. If the data collection can only be stopped by stopping the session, the profiler should implement this as a no-op and throw an exception when startRecording() is called another time.

Throws:

java.io.IOException

java.lang.InterruptedException

stopSession

void stopSession()
          throws java.io.IOException,
                 java.lang.InterruptedException

Ends the profiling session, writing the collected results to disk and disconnecting the profiler from the daemon.

Throws:

java.io.IOException

java.lang.InterruptedException