com.cs.software.engine.queue

Class Queue

java.lang.Object

com.cs.software.engine.FrameworkBase

com.cs.software.engine.queue.Queue

All Implemented Interfaces:

FrameworkIntf, Serializable

public class Queue
extends FrameworkBase

This class Queue is used for internal memory queue.

Author:

Steve Crombie

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicInteger	count
protected ConcurrentLinkedQueue<MessageIntf>	list

Fields inherited from class com.cs.software.engine.FrameworkBase

active, initMessage, inProcess, jvmService, running, serviceData, totalErrors, totalMessages, totalProcessed

Fields inherited from interface com.cs.software.api.FrameworkIntf

CATEGROY_ADAPTER, CATEGROY_APP, CATEGROY_DB_CON, CATEGROY_DB_POOL, CATEGROY_ENGINE, CATEGROY_MODULE, CATEGROY_POOL_MGR, CATEGROY_QUEUE, CATEGROY_THREAD_MGR, CATEGROY_WORKER, COMMAND_DEREGISTER_KEY, COMMAND_PAUSE, COMMAND_REGISTER_KEY, COMMAND_RESTART, COMMAND_SHUTDOWN, COMMAND_START, COMMAND_STOP, FLAG_FALSE, FLAG_TRUE, PARAM_JVM_STR, PARAM_JVMID_STR, PARAM_SERVERNAME_STR, PARAM_SERVICEACTIVE_STR, PARAM_SERVICECATAGORY_STR, PARAM_SERVICENAME_STR, PARAM_SERVICERUNNING_STR, TYPE_CLUSTER, TYPE_DISPLAY_STR, TYPE_EVENT, TYPE_JVM, TYPE_JVM_STR, TYPE_MAX, TYPE_SERVER, TYPE_SERVICE

Constructor Summary

Constructors

Constructor and Description
Queue(QueueMgr aMgr, String aName)
Queue(String aName) Constructor - Create a new queue reference by name

Method Summary

Modifier and Type	Method and Description
void	addMsg(MessageIntf aMsg) Synchronized - Add a new Message object to the queue
void	addReader(QueueReader aReader) Synchronized - Will add a new Reader to the Queue
void	addWriter(QueueWriter aWriter) Synchronized - Will add a new Writer to the Queue
void	close() Will remove all messages from the queue and remove the queue
MessageIntf	getMsg() Synchronized - Will retrieve the next message from the queue note: This call will block until a message is received
MessageIntf	getMsgNoWait() Will retrieve the next message from the queue note: This call will NOT BLOCK if not message returns null
String	getQueueName() Returns the Queue Reference Name
MessageIntf	getServiceData() This method will return the ServiceData (QueueData) associated with this object instance.
void	init() This method will initialize the internal parameters.
protected MessageIntf	readMsg() Internal - Will retrieve the next message from the queue
void	remove(QueueTransport aTransport)
void	removeReader(QueueReader aReader) Synchronized - Will remove a Reader from the Queue
void	removeWriter(QueueWriter aWriter) Synchronized - Will remove a Writer from the Queue
int	size() Synchronized - Will return the number of messages left in the Queue

Methods inherited from class com.cs.software.engine.FrameworkBase

addInProcess, addTotalErrorNumber, addTotalMsgNumber, addTotalProcessed, deRegister, deRegister, doEventMessage, doMessage, getDefError, getInProcess, getJvmId, getJvmService, getName, getService, getServiceName, getStats, getTotalErrorNumber, getTotalMsgNumber, getTotalProcessed, initMessage, isActive, isRunning, register, register, resetTotals, setActive, setRunning, setServiceData, subtractInProcess

Methods inherited from class java.lang.Object

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

Field Detail

list

protected ConcurrentLinkedQueue<MessageIntf> list

count

protected AtomicInteger count

Constructor Detail

Queue

public Queue(String aName)

Constructor - Create a new queue reference by name

Parameters:

aName - String Queue Reference Name

Queue

public Queue(QueueMgr aMgr,
             String aName)

Method Detail

init

public void init()

This method will initialize the internal parameters.

getQueueName

public String getQueueName()

Returns the Queue Reference Name

Returns:

String Queue Reference Name

addMsg

public void addMsg(MessageIntf aMsg)

Synchronized - Add a new Message object to the queue

Parameters:

aMsg - Object new message

getMsg

public MessageIntf getMsg()

Synchronized - Will retrieve the next message from the queue note: This call will block until a message is received

Returns:

Object next new message

readMsg

protected MessageIntf readMsg()

Internal - Will retrieve the next message from the queue

Returns:

Object next new message

getMsgNoWait

public MessageIntf getMsgNoWait()

Will retrieve the next message from the queue note: This call will NOT BLOCK if not message returns null

Returns:

Object next new message

size

public int size()

Synchronized - Will return the number of messages left in the Queue

Returns:

int number of messages

close

public void close()

Will remove all messages from the queue and remove the queue

addReader

public void addReader(QueueReader aReader)

Synchronized - Will add a new Reader to the Queue

Parameters:

aReader - QueueReader New queue reader object

remove

public void remove(QueueTransport aTransport)

removeReader

public void removeReader(QueueReader aReader)

Synchronized - Will remove a Reader from the Queue

Parameters:

aReader - QueueReader Queue reader object

addWriter

public void addWriter(QueueWriter aWriter)

Synchronized - Will add a new Writer to the Queue

Parameters:

aWriter - QueueWriter New queue writer object

removeWriter

public void removeWriter(QueueWriter aWriter)

Synchronized - Will remove a Writer from the Queue

Parameters:

aWriter - QueueWriter Queue writer object

getServiceData

public MessageIntf getServiceData()

This method will return the ServiceData (QueueData) associated with this object instance.

Overrides:

getServiceData in class FrameworkBase

Returns:

ServiceDataIntf Queue Data associated with this object instance