public interface ProbeContext
TelemetryProbe.fillTelemetryData(ProbeContext, int[]),
the derived InterceptorContext is passed to the interception methods of
interceptor probes.
The help topic on custom probes in the bundled documentation explains how to develop custom probes.
| Modifier and Type | Method and Description |
|---|---|
void |
addEvent(ProbeEvent probeEvent)
Publishes an event.
|
ProbeEvent |
createCloseEvent(java.lang.String description,
java.lang.Object controlObject)
Creates an event for closing a control object.
|
ProbeEvent |
createCustomEvent(java.lang.String description,
int type,
java.lang.Object controlObject)
Creates a custom event.
|
ProbeEvent |
createOpenEvent(java.lang.String description,
java.lang.Object controlObject)
Creates an event for opening a control object.
|
ProbeEvent |
createOpenEvent(java.lang.String description,
java.lang.Object controlObject,
java.lang.Object[] controlObjectData)
Creates an event for opening a control object with additional control object data.
|
java.util.Map |
getMap()
Returns a map for storing arbitrary data.
|
boolean |
isRecording()
Return whether the probe is recording data.
|
java.util.Map getMap()
ProbeEvent createOpenEvent(java.lang.String description, java.lang.Object controlObject)
ProbeMetaData.controlObjectView(boolean) has to be called with the argument true
in the meta data configuration method.
Note that the returned event must be published with addEvent(ProbeEvent), otherwise
the event will be discarded.
description - the description for the eventcontrolObject - the control object that is being openedProbeEvent createOpenEvent(java.lang.String description, java.lang.Object controlObject, java.lang.Object[] controlObjectData)
createOpenEvent(String, Object) only with additional control object data
as defined by calls to ProbeMetaData.addAdditionalControlObjectData(String, DataType, boolean).
The array must has the same length as the number of calls to that method during the meta data
configuration.
Note that the returned event must be published with addEvent(ProbeEvent), otherwise
the event will be discarded.
description - the description for the eventcontrolObject - the control object that is being openedcontrolObjectData - the additional data for the control objectProbeEvent createCloseEvent(java.lang.String description, java.lang.Object controlObject)
createOpenEvent(String, Object) or createOpenEvent(String, Object, Object[]) method.
Note that the returned event must be published with addEvent(ProbeEvent), otherwise
the event will be discarded.
description - the description for the eventcontrolObject - the control object that is being closedProbeEvent createCustomEvent(java.lang.String description, int type, java.lang.Object controlObject)
ProbeMetaData.customTypeNames(String[]) in the
meta data configuration method.
Note that the returned event must be published with addEvent(ProbeEvent), otherwise
the event will be discarded.
description - the description for the eventtype - the type corresponds to the index of the desired custom event in the the call to
ProbeMetaData.customTypeNames(String[])controlObject - the control object that is associated with this event. May be null.void addEvent(ProbeEvent probeEvent)
probeEvent - the probe event that should be publishedboolean isRecording()
ProbeMetaData.recordOnStartup(boolean) with the argument false in the
meta data configuration method. Furthermore, the
user can start and stop recording the JProfiler GUI.