IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.kernel.engine
Interface IDispatcher

All Superinterfaces:
IControllable, ICountable

public interface IDispatcher
extends IControllable, ICountable

Dispatchers are used to manage the process of enqueuing actions onto queues.

After a queue has been created, it can be added to a dispatcher. The dispatcher will manage the process of enqueuing actions to the queues given to it in an orderly fashion.

Multiple dispatchers can be created to ensure that proper queue throughput can be achieved.


Method Summary
 void add(IQueue queue)
          Add a queue to this dispatcher.
 void dispatch(IKAction action)
          Dispatch an action to an appropriate queue.
 void dispatch(IKAction action, IQueue queue)
          Dispatch an action to a particular queue.
 IQueue getQueue()
           
 IQueue[] getQueues()
          Get a list of the queues about which this dispatcher knows.
 void remove(IQueue queue)
          Remove a queue from a dispatcher.
 void setQueue(IQueue queue)
           
 void step()
           
 
Methods inherited from interface com.ibm.rational.test.lt.kernel.engine.IControllable
drain, isPaused, isRunning, pause, resume, shutdown
 
Methods inherited from interface com.ibm.rational.test.lt.kernel.ICountable
addCounter, getCounter, getCounters, resetCounters
 

Method Detail

dispatch

void dispatch(IKAction action)
Dispatch an action to an appropriate queue.

Parameters:
action - the kernel action
Throws:
QueueException - if there are no operational queues for this action

dispatch

void dispatch(IKAction action,
              IQueue queue)
Dispatch an action to a particular queue.

Parameters:
action - the kernel action
queue - the queue
Throws:
QueueException - if the queue is not operational or not found

add

void add(IQueue queue)
Add a queue to this dispatcher.

Parameters:
queue -

remove

void remove(IQueue queue)
Remove a queue from a dispatcher.

Parameters:
queue -
Throws:
QueueException - if the queue is not found

getQueues

IQueue[] getQueues()
Get a list of the queues about which this dispatcher knows.

Returns:
an array of queues or null if none are found

getQueue

IQueue getQueue()

setQueue

void setQueue(IQueue queue)

step

void step()

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.