org.jlab.coda.cMsg.common

Class cMsgCallbackThread

java.lang.Object

java.lang.Thread

org.jlab.coda.cMsg.common.cMsgCallbackThread

All Implemented Interfaces:

java.lang.Runnable, cMsgSubscriptionHandle

public class cMsgCallbackThread
extends java.lang.Thread
implements cMsgSubscriptionHandle

This class is used to run a message callback in its own thread. The thread is self-starting and waits to execute the callback. All it needs is a notify.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	cMsgCallbackThread.WorkerThread Class defining threads (which can be run in parallel) that will run the callback.

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
(package private) cMsgCallbackInterface	callback Callback to be run.
(package private) java.lang.String	domain Subscription's domain.
(package private) cMsgMessageFull	message Place to temporarily store the returned message from a get.
(package private) long	msgCount Number of messages passed to the callback.
(package private) java.lang.String	subject Subscription's subject.
(package private) java.lang.String	type Subscription's type.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
cMsgCallbackThread(cMsgCallbackInterface callback, java.lang.Object arg, java.lang.String domain, java.lang.String subject, java.lang.String type) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearQueue() Clears the queue of all messages.
void	dieNow(boolean callInterrupt) This method kills this thread as soon as possible.
cMsgCallbackInterface	getCallback() Gets the callback object.
int	getCount() Gets the number of identical subscriptions.
java.lang.String	getDomain() Gets the domain in which this subscription lives.
long	getMsgCount() Gets the number of messages passed to the callback.
int	getQueueSize() Gets the number of messages in the queue.
java.lang.String	getSubject() Gets the subject of this subscription.
java.lang.String	getType() Gets the type of this subscription.
java.lang.Object	getUserObject() Gets the subscription's user object argument.
boolean	isQueueFull() Returns true if queue is full.
void	pause() This method stops any further calling of the callback.
void	restart() This method (re)starts any calling of the callback delayed by the pause method.
void	run() This method is executed as a thread which starts up the right number of worker threads
void	sendMessage(cMsgMessageFull message) Put message on a queue of messages waiting to be taken by the callback.
void	setCount(int count) Sets the number of identical subscriptions.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

domain

java.lang.String domain

Subscription's domain.

subject

java.lang.String subject

Subscription's subject.

type

java.lang.String type

Subscription's type.

callback

cMsgCallbackInterface callback

Callback to be run.

message

cMsgMessageFull message

Place to temporarily store the returned message from a get.

msgCount

long msgCount

Number of messages passed to the callback.

Constructor Detail

cMsgCallbackThread

public cMsgCallbackThread(cMsgCallbackInterface callback,
                          java.lang.Object arg,
                          java.lang.String domain,
                          java.lang.String subject,
                          java.lang.String type)

Constructor.

Parameters:

callback - callback to be run when message arrives

arg - user-supplied argument for callback

domain - subscription's domain

subject - subscription's subject

type - subscription's tyoe

Method Detail

dieNow

public void dieNow(boolean callInterrupt)

This method kills this thread as soon as possible. If unsubscribe or disconnect is called in a callback using the same connection, then the unsubscribe or disconnect will interrupt the callback currently calling them. To avoid this, set the argument to false.

Parameters:

callInterrupt - if true interrupt is called on callback thread, else interrupt is not called.

pause

public void pause()

This method stops any further calling of the callback. Any threads currently running the callback continue normally. Messages are still being delivered to this callback's queue.

Specified by:

pause in interface cMsgSubscriptionHandle

restart

public void restart()

This method (re)starts any calling of the callback delayed by the pause method. Would like to call this method "resume", but that name is taken by the "Thread" class.

Specified by:

restart in interface cMsgSubscriptionHandle

getMsgCount

public long getMsgCount()

Gets the number of messages passed to the callback.

Specified by:

getMsgCount in interface cMsgSubscriptionHandle

Returns:

number of messages passed to the callback

getDomain

public java.lang.String getDomain()

Gets the domain in which this subscription lives.

Specified by:

getDomain in interface cMsgSubscriptionHandle

Returns:

the domain in which this subscription lives

getSubject

public java.lang.String getSubject()

Gets the subject of this subscription.

Specified by:

getSubject in interface cMsgSubscriptionHandle

Returns:

the subject of this subscription

getType

public java.lang.String getType()

Gets the type of this subscription.

Specified by:

getType in interface cMsgSubscriptionHandle

Returns:

the type of this subscription

getQueueSize

public int getQueueSize()

Gets the number of messages in the queue.

Specified by:

getQueueSize in interface cMsgSubscriptionHandle

Returns:

number of messages in the queue

isQueueFull

public boolean isQueueFull()

Returns true if queue is full.

Specified by:

isQueueFull in interface cMsgSubscriptionHandle

Returns:

true if queue is full

clearQueue

public void clearQueue()

Clears the queue of all messages.

Specified by:

clearQueue in interface cMsgSubscriptionHandle

getCallback

public cMsgCallbackInterface getCallback()

Gets the callback object.

Specified by:

getCallback in interface cMsgSubscriptionHandle

Returns:

user callback object

getUserObject

public java.lang.Object getUserObject()

Gets the subscription's user object argument.

Specified by:

getUserObject in interface cMsgSubscriptionHandle

Returns:

subscription's user object argument

getCount

public int getCount()

Gets the number of identical subscriptions.

Returns:

the number of identical subscriptions

setCount

public void setCount(int count)

Sets the number of identical subscriptions.

Parameters:

count - the number of identical subscriptions

sendMessage

public void sendMessage(cMsgMessageFull message)

Put message on a queue of messages waiting to be taken by the callback.

Parameters:

message - message to be passed to callback

run

public void run()

This method is executed as a thread which starts up the right number of worker threads

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread