com.cs.software.api

Interface TransportIntf

All Superinterfaces:

FrameworkIntf, Serializable

All Known Subinterfaces:

DataStoreIntf

All Known Implementing Classes:

KafkaReader, KafkaTransport, KafkaWriter, QueueReader, QueueTransport, QueueWriter

public interface TransportIntf
extends FrameworkIntf

This class Queue is used for internal memory queue.

Author:

Steve Crombie

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	addMsg(MessageIntf aMsg) Synchronized - Add a new Message object to the queue
void	addTransport(TransportIntf aTransport) 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	getTransportName() Returns the Queue Reference Name
int	getUserHashCode()
void	init(MessageIntf Msg)
void	initTransport(Map<String,String> aDataMap, ServicesIntf aService) This method will initialize the internal parameters.
boolean	isListener()
boolean	isReader()
boolean	isWriter()
boolean	processMsgListner(MessageIntf aMsg)
MessageIntf	readMsg()
MessageIntf	readMsg(long aTimeout)
void	removeTransport(TransportIntf aTransport) Synchronized - Will remove a Reader from the Queue
void	setListener(boolean aFlag)
void	setReader(boolean aFlag)
void	setWriter(boolean aFlag)
int	size() Synchronized - Will return the number of messages left in the Queue

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

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

Method Detail

initTransport

void initTransport(Map<String,String> aDataMap,
                   ServicesIntf aService)

This method will initialize the internal parameters.

Parameters:

aDataMap - data

aService - service

init

void init(MessageIntf Msg)

getUserHashCode

int getUserHashCode()

getTransportName

String getTransportName()

Returns the Queue Reference Name

Returns:

String Queue Reference Name

addMsg

void addMsg(MessageIntf aMsg)
     throws Exception

Synchronized - Add a new Message object to the queue

Parameters:

aMsg - Object new message

Throws:

Exception - ex

getMsg

MessageIntf getMsg()
            throws Exception

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

Returns:

Object next new message

Throws:

Exception - ex

getMsgNoWait

MessageIntf getMsgNoWait()
                  throws Exception

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

Returns:

Object next new message

Throws:

Exception - ex

readMsg

MessageIntf readMsg()
             throws Exception

Throws:

Exception

readMsg

MessageIntf readMsg(long aTimeout)
             throws Exception

Throws:

Exception

size

int size()

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

Returns:

int number of messages

close

void close()

Will remove all messages from the queue and remove the queue

addTransport

void addTransport(TransportIntf aTransport)

Synchronized - Will add a new Writer to the Queue

Parameters:

aTransport - QueueWriter New queue writer object

removeTransport

void removeTransport(TransportIntf aTransport)

Synchronized - Will remove a Reader from the Queue

Parameters:

aTransport - QueueReader Queue reader object

processMsgListner

boolean processMsgListner(MessageIntf aMsg)

isReader

boolean isReader()

setReader

void setReader(boolean aFlag)

isWriter

boolean isWriter()

setWriter

void setWriter(boolean aFlag)

isListener

boolean isListener()

setListener

void setListener(boolean aFlag)