ABLE, Version 1.1b

com.ibm.able
Interface AbleEventQueueProcessor

All Known Subinterfaces:
AbleAgent, AbleBean, FipaAccAgent, FipaAgent, FipaAmsAgent, FipaDfAgent
All Known Implementing Classes:
PlatformAgentProxyEventHandler

public abstract interface AbleEventQueueProcessor
extends java.rmi.Remote

The methods in this interface must be implemented by all objects wishing to interface with the AbleEventQueue object; the methods provide a way for the event queue to hand off processing of timer and asynchronous AbleEvents.

A default implementation of these methods can be found in the AbleObject class.

Version:
$Revision: 1.1 $, $Date: 2000/01/24 14:52:09 $
See Also:
AbleObject

Method Summary
 com.ibm.logging.Logger getLogger()
          Retrieve a logger object from the event queue's container.
 void processAbleEvent(AbleEvent theAbleEvent)
          Process an Able event synchronously; that is, on the same thread as the caller.
 void processNoEventProcessingEnabledSituation()
          Process the situation where neither timer nor Able event processing is enabled in the event queue, but the event queue's asynchronous thread of control has been started.
 void processTimerEvent()
          Process a timer expiration event synchronously; that is, on the same thread as the caller.
 void setState(int theState)
          Set the state of the event queue's container.
 

Method Detail

processAbleEvent

public void processAbleEvent(AbleEvent theAbleEvent)
                      throws java.rmi.RemoteException
Process an Able event synchronously; that is, on the same thread as the caller.

This method is called by an AbleEventQueue when the queue gets around to processing an asynchronous event. Note that this method also can be called directly from the handleAbleEvent() method described in the AbleEventListener interface when that method is given a synchronous event to handle.

Parameters:
theAbleEvent - The event to process.


processTimerEvent

public void processTimerEvent()
                       throws java.rmi.RemoteException
Process a timer expiration event synchronously; that is, on the same thread as the caller.

This method is called by an AbleEventQueue when the queue's sleep timer goes off.


processNoEventProcessingEnabledSituation

public void processNoEventProcessingEnabledSituation()
                                              throws java.rmi.RemoteException
Process the situation where neither timer nor Able event processing is enabled in the event queue, but the event queue's asynchronous thread of control has been started.

This method is called by an AbleEventQueue when the queue is neither enabled for timer processing nor Able event processing. When neither type of processing is enabled, the queue is in a tight processing loop, consuming CPU cycles. This method is called so that the event queue's container can do something about the situation or perform some other type of asynchronous processing.


setState

public void setState(int theState)
              throws java.rmi.RemoteException
Set the state of the event queue's container.

This method is called by an AbleEventQueue when the queue's run time loop changes state; for example, from Waiting to Active.

Parameters:
theState - An AbleState. value.


getLogger

public com.ibm.logging.Logger getLogger()
                                 throws java.rmi.RemoteException
Retrieve a logger object from the event queue's container.
Returns:
a Logger object; null is permitted to be returned.

ABLE, Version 1.1b

ABLE: Produced by Joe, Don, and Jeff who say, 'Thanks for your support.'