Package org.apache.activemq.artemis.api.core

Class RefCountMessage

java.lang.Object

org.apache.activemq.artemis.api.core.RefCountMessage

public class RefCountMessage
extends Object

RefCountMessage is a base-class for any message intending to do reference counting. Currently it is used for large message removal. Additional validation on reference counting will be done If you set a system property named "ARTEMIS_REF_DEBUG" and enable logging on this class. Additional logging output will be written when reference counting is broken and these debug options are applied.

Constructor Summary

Constructors

Constructor	Description
RefCountMessage()

Method Summary

Modifier and Type	Method	Description
protected String	counterString()
String	debugLocations()
void	deferredDebug(String message)	Deferred debug, that will be used in case certain conditions apply to the RefCountMessage
static void	deferredDebug(Message message, String debugMessage, Object... args)
static void	deferredDebug(RefCountMessage message, String debugMessage, Object... args)
void	disableErrorCheck()
int	durableDown()
int	durableUp()
int	getDurableCount()
RefCountMessage	getParentRef()
int	getRefCount()
int	getUsage()
Object	getUserContext(Object key)
static boolean	isRefDebugEnabled()
static boolean	isRefTraceEnabled()
boolean	isReleased()	has the refCount fired the action already?
protected void	onDown()
protected void	onUp()
int	refDown()
int	refUp()
protected void	registerDebug()	Sub classes constructors willing to debug reference counts, can register the objectCleaner through this method.
protected void	releaseComplete()
protected void	released()
void	setParentRef(RefCountMessage origin)
void	setUserContext(Object key, Object value)
int	usageDown()
int	usageUp()

Methods inherited from class java.lang.Object

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

Constructor Detail

RefCountMessage

public RefCountMessage()

Method Detail

isRefDebugEnabled

public static boolean isRefDebugEnabled()

isRefTraceEnabled

public static boolean isRefTraceEnabled()

registerDebug

protected void registerDebug()

Sub classes constructors willing to debug reference counts, can register the objectCleaner through this method.

isReleased

public boolean isReleased()

has the refCount fired the action already?

debugLocations

public String debugLocations()

deferredDebug

public static void deferredDebug(Message message,
                                 String debugMessage,
                                 Object... args)

deferredDebug

public static void deferredDebug(RefCountMessage message,
                                 String debugMessage,
                                 Object... args)

deferredDebug

public void deferredDebug(String message)

Deferred debug, that will be used in case certain conditions apply to the RefCountMessage

getRefCount

public int getRefCount()

getUsage

public int getUsage()

getDurableCount

public int getDurableCount()

getParentRef

public RefCountMessage getParentRef()

onUp

protected void onUp()

released

protected void released()

disableErrorCheck

public void disableErrorCheck()

onDown

protected void onDown()

counterString

protected String counterString()

setParentRef

public void setParentRef(RefCountMessage origin)

releaseComplete

protected void releaseComplete()

usageUp

public int usageUp()

usageDown

public int usageDown()

durableUp

public int durableUp()

durableDown

public int durableDown()

refDown

public int refDown()

refUp

public int refUp()

getUserContext

public Object getUserContext(Object key)

setUserContext

public void setUserContext(Object key,
                           Object value)