Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Tarassov2013-04-03 12:17:13 -0400
committerEugene Tarassov2013-04-03 12:17:13 -0400
commitc8c9b5bb485ffbe446e429108ae374e5d1087d70 (patch)
tree3f7c9b4c07d635b9bb7ceeddf6c5b8cf7adab433 /plugins
parenta69c9d0f02036ba48e941562c2505eee146e1822 (diff)
downloadorg.eclipse.tcf-c8c9b5bb485ffbe446e429108ae374e5d1087d70.tar.gz
org.eclipse.tcf-c8c9b5bb485ffbe446e429108ae374e5d1087d70.tar.xz
org.eclipse.tcf-c8c9b5bb485ffbe446e429108ae374e5d1087d70.zip
TCF Core: more comments for Profiler service API
Diffstat (limited to 'plugins')
-rw-r--r--plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IProfiler.java10
1 files changed, 10 insertions, 0 deletions
diff --git a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IProfiler.java b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IProfiler.java
index aa3513688..915580d5d 100644
--- a/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IProfiler.java
+++ b/plugins/org.eclipse.tcf.core/src/org/eclipse/tcf/services/IProfiler.java
@@ -17,6 +17,16 @@ import org.eclipse.tcf.protocol.IToken;
/**
* TCF Profiler service interface.
+ *
+ * The service itself does not implement profiling, it manages creation/disposal of
+ * profiler instances and communications between clients and profilers.
+ * The service API is generic and it is supposed to support any kind of profiling and tracing.
+ * A TCF agent can optionally include a profiler. The profiler would register itself with the service.
+ * A client starts profiling by sending profiler configuration data for a debug context.
+ * Multiple different profilers can be active at same debug context at same time.
+ * If a client has started profiling, it is expected to read and process profiling data periodically.
+ * Profiling data format is a contract between the profiler and its clients,
+ * the service does not try to interpret the data.
*/
public interface IProfiler extends IService {

Back to the top