|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The AbleEventQueueRemoteManager interface provides methods to remotely manage a thread for asynchronously processing events placed on an event quene and for managing timer events.
If asynchronous events are enabled and the asynchronous thread of
control is started, the bean will awaken whenever an
asynchronous event is placed on the bean's internal event queue
and call AbleEventQueueProcessor.processAbleEvent(com.ibm.able.AbleEvent)
.
If processing timer events is enabled and the asynchronous
thread of control is started, the bean will awaken at periodic
intervals as specified in the "sleep time" variable, and call
AbleEventQueueProcessor.processTimerEvent()
.
Method Summary | |
---|---|
void |
flushAbleEventQueue()
Remove all events from the event queue. |
int |
getAbleEventProcessingEnabled()
Returns the state of asynchronous ABLE event processing. |
int |
getAbleEventQueueSize()
Returns the number of events on the event queue. |
long |
getSleepTime()
Returns the current sleep time setting. |
boolean |
isTimerEventProcessingEnabled()
Indicates if automatic periodic processing is enabled or disabled. |
void |
quitEnabledEventProcessing()
Stop the bean's asynchronous thread of control. |
void |
restartEnabledEventProcessing()
Restart the bean's asynchronous thread of control after the bean has moved from one system to another. |
void |
resumeEnabledEventProcessing()
Resume the bean's suspended asynchronous thread of control. |
void |
setAbleEventProcessingEnabled(int theEnabledFlag)
Sets whether asynchronous ABLE event processing is enabled or disabled. |
void |
setSleepTime(long theSleepTime)
Sets the sleep time interval for the asynchronous timed processing loop. |
void |
setTimerEventProcessingEnabled(boolean theEnabledFlag)
Specify whether automatic periodic processing is enabled or disabled. |
void |
startEnabledEventProcessing()
Start the bean's asynchronous thread of control. |
void |
suspendEnabledEventProcessing()
Temporarily suspend the bean's asynchronous thread of control. |
Method Detail |
public void setSleepTime(long theSleepTime) throws java.rmi.RemoteException
theSleepTime
- The number of milliseconds for which the process is to
sleep before it awakes and calls
AbleEventQueueProcessor.processTimerEvent()
.java.rmi.RemoteException
- If an error occurs.public long getSleepTime() throws java.rmi.RemoteException
java.rmi.RemoteException
- If an error occurs.public void setTimerEventProcessingEnabled(boolean theEnabledFlag) throws java.rmi.RemoteException
theEnabledFlag
- Specify true if the bean is to awaken every N
milliseconds and call
AbleEventQueueProcessor.processTimerEvent()
;
specify false if no automatic periodic processing
is to take place while the asynchronous thread of control is
running.java.rmi.RemoteException
- If an error occurs.public boolean isTimerEventProcessingEnabled() throws java.rmi.RemoteException
java.rmi.RemoteException
- If an error occurs.public void setAbleEventProcessingEnabled(int theEnabledFlag) throws java.rmi.RemoteException
theEnabledFlag
- Specify one of the following values:
Able.ProcessingEnabled_PostingEnabled
Able.ProcessingEnabled_PostingDisabled
Able.ProcessingDisabled_PostingEnabled
Able.ProcessingDisabled_PostingDisabled
java.rmi.RemoteException
- If an error occurs or
if the parameter is not a valid value.public int getAbleEventProcessingEnabled() throws java.rmi.RemoteException
Able.ProcessingEnabled_PostingEnabled
Able.ProcessingEnabled_PostingDisabled
Able.ProcessingDisabled_PostingEnabled
Able.ProcessingDisabled_PostingDisabled
java.rmi.RemoteException
- If an error occurs.public void flushAbleEventQueue() throws java.rmi.RemoteException
Note that unless event Posting is disabled before clearing the event queue, new events may arrive on the queue as soon as it has been cleared!
java.rmi.RemoteException
- If an error occurs.public int getAbleEventQueueSize() throws java.rmi.RemoteException
Note that unless both event Posting and event Processing are disabled, the number may be invalid as soon as it is returned.
java.rmi.RemoteException
- If an error occurs.public void startEnabledEventProcessing() throws java.rmi.RemoteException
AbleState.Waiting
.
In this thread, the bean can perform one, both, or none of these actions, depending on what is enabled:
AbleEventQueueProcessor.processTimerEvent()
.
AbleEventQueueProcessor.processAbleEvent(com.ibm.able.AbleEvent)
.
java.rmi.RemoteException
- If an error occurs.public void quitEnabledEventProcessing() throws java.rmi.RemoteException
AbleState.Unknown
.
Timer event processing and ABLE event processing cease, but if event Posting is still enabled, events may still be placed on the internal event queue by other processes.
java.rmi.RemoteException
- If an error occurs.public void suspendEnabledEventProcessing() throws java.rmi.RemoteException
AbleState.Unknown
.
Timer event processing and ABLE event processing cease, but if event Posting is still enabled, events may still be placed on the internal event queue by other processes.
java.rmi.RemoteException
- If an error occurs.public void resumeEnabledEventProcessing() throws java.rmi.RemoteException
AbleState.Waiting
.
Timer event processing and ABLE event processing resume if these actions are enabled.
java.rmi.RemoteException
- If an error occurs.public void restartEnabledEventProcessing() throws java.rmi.RemoteException
AbleState.Waiting
.
Timer event processing and ABLE event processing resume if these actions are enabled.
java.rmi.RemoteException
- If an error occurs.
|
ABLE 2.0.0 07/02/2003 10:25:01 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |