Interface MarkerMessage
-
- All Superinterfaces:
Message<MarkerMessage>
- All Known Implementing Classes:
NullMarkerMessageImpl
public interface MarkerMessage extends Message<MarkerMessage>
Methods to set message fields specific to Markers.
A MarkerMessage is a message sent to SAS to provide context about a trail. The marker may be used for correlating multiple trails into a trace or branch. It may also be used for searching for a trace in the SAS UI.
Some markers have special meaning to the SAS server, the START, END and FLUSH markers indicate when a trail is started, when one is ended, and when no more data is expected in the next few seconds.
- Since:
- Rhino 2.6.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description MarkerMessageassociationScope(Scope scope)Sets the scope of the marker.MarkerMessagebranchScope()MarkerMessagenoneScope()MarkerMessagenoReactivation()MarkerMessagesetReactivationFlag(boolean reactivate)Sets the reactivation flag of the marker.MarkerMessagetraceScope()-
Methods inherited from interface com.opencloud.rhino.facilities.sas.Message
instance, isEnabled, report, staticParam, staticParam, staticParam, threadSafeParam, varParam, varParams, varParams
-
-
-
-
Method Detail
-
associationScope
MarkerMessage associationScope(Scope scope)
Sets the scope of the marker.
- Parameters:
scope- whether the marker should associate on the branch or trace scope- Returns:
- this to allow method chaining
-
traceScope
MarkerMessage traceScope()
-
branchScope
MarkerMessage branchScope()
-
noneScope
MarkerMessage noneScope()
-
setReactivationFlag
MarkerMessage setReactivationFlag(boolean reactivate)
Sets the reactivation flag of the marker.
- Parameters:
reactivate- whether the trail should be reactivated after the marker is sent- Returns:
- this to allow method chaining
-
noReactivation
MarkerMessage noReactivation()
-
-