Package org.apache.cassandra.tracing

Class TraceState

java.lang.Object

org.apache.cassandra.tracing.TraceState

All Implemented Interfaces:

ProgressEventNotifier

Direct Known Subclasses:

TraceStateImpl

public abstract class TraceState
extends Object
implements ProgressEventNotifier

ThreadLocal state for a tracing session. The presence of an instance of this class as a ThreadLocal denotes that an operation is being traced.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TraceState.Status

Field Summary

Fields

Modifier and Type	Field	Description
final InetAddressAndPort	coordinator
final TimeUUID	sessionId
final ByteBuffer	sessionIdBytes
final Tracing.TraceType	traceType
final int	ttl
final com.google.common.base.Stopwatch	watch

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TraceState(InetAddressAndPort coordinator, TimeUUID sessionId, Tracing.TraceType traceType)

Method Summary

Modifier and Type	Method	Description
boolean	acquireReference()
void	addProgressListener(ProgressListener listener)	Register progress listener to this publisher.
int	elapsed()
void	enableActivityNotification(String tag)	Activate notification with provided tag name.
protected void	notifyActivity()
int	releaseReference()
void	removeProgressListener(ProgressListener listener)	Remove progress listener from this publisher.
void	stop()
void	trace(String message)
void	trace(String format, Object arg)
void	trace(String format, Object... args)
void	trace(String format, Object arg1, Object arg2)
protected abstract void	traceImpl(String message)
TraceState.Status	waitActivity(long timeout)
protected void	waitForPendingEvents()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

sessionId

public final TimeUUID sessionId

coordinator

public final InetAddressAndPort coordinator

watch

public final com.google.common.base.Stopwatch watch

sessionIdBytes

public final ByteBuffer sessionIdBytes

traceType

public final Tracing.TraceType traceType

ttl

public final int ttl

Constructor Details

TraceState

protected TraceState(InetAddressAndPort coordinator,
 TimeUUID sessionId,
 Tracing.TraceType traceType)

Method Details

enableActivityNotification

public void enableActivityNotification(String tag)

Activate notification with provided tag name.

Parameters:

tag - Tag name to add when emitting notification

addProgressListener

public void addProgressListener(ProgressListener listener)

Description copied from interface: ProgressEventNotifier

Register progress listener to this publisher.

Specified by:

addProgressListener in interface ProgressEventNotifier

Parameters:

listener - listener to register.

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Description copied from interface: ProgressEventNotifier

Remove progress listener from this publisher.

Specified by:

removeProgressListener in interface ProgressEventNotifier

Parameters:

listener - listener to remove

elapsed

public int elapsed()

stop

public void stop()

waitActivity

public TraceState.Status waitActivity(long timeout)

notifyActivity

protected void notifyActivity()

trace

public void trace(String format,
 Object arg)

trace

public void trace(String format,
 Object arg1,
 Object arg2)

trace

public void trace(String format,
 Object... args)

trace

public void trace(String message)

traceImpl

protected abstract void traceImpl(String message)

waitForPendingEvents

protected void waitForPendingEvents()

acquireReference

public boolean acquireReference()

releaseReference

public int releaseReference()