MarkerMessage (Rhino Extensions 3.2 API)

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
`MarkerMessage`	`associationScope(Scope scope)`	Sets the scope of the marker.
`MarkerMessage`	`branchScope()`	The marker is an association marker whose scope is this branch only.
`MarkerMessage`	`noneScope()`	The marker is not an association marker.
`MarkerMessage`	`noReactivation()`
`MarkerMessage`	`setReactivationFlag(boolean reactivate)`	Sets the reactivation flag of the marker.
`MarkerMessage`	`traceScope()`	The marker is an association marker whose scope is the entire trace.

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, or not associate.
    
    Returns:
    
    this to allow method chaining
  - traceScope
```
MarkerMessage traceScope()
```
    The marker is an association marker whose scope is the entire trace.
    
    Returns:
    
    this to allow method chaining
  - branchScope
```
MarkerMessage branchScope()
```
    The marker is an association marker whose scope is this branch only.
    
    Returns:
    
    this to allow method chaining
  - noneScope
```
MarkerMessage noneScope()
```
    The marker is not an association marker.
    
    Returns:
    
    this to allow method chaining
  - 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()
```