Java Doc for ItsNatTimer.java in  » Ajax » ItsNat » org » itsnat » core » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The ItsNatTimer features and API are inspired in java.util.Timer but the main differences are that timer events are sent by the client and the server does not use any special thread to schedule the event sequence.

Note: big documentation parts of this interface are copied from java.util.Timer.

The default synchronous mode is used.

Current implementation does the following:

          
 int syncMode = getItsNatDocument().getDefaultSyncMode(); 
 long ajaxTimeout = getItsNatDocument().getAJAXTimeout();         
 return schedule(target,task,delay,syncMode,null,null,ajaxTimeout);
 

Note that calling this method from within the EventListener.handleEvent(Event) method of a timer task that was invoked by this timer absolutely guarantees that the ongoing task execution is the last task execution that will ever be performed by this timer.

This method may be called repeatedly; the second and subsequent calls have no effect.

When the scheduled task is fully finished or cancelled is automatically unregistered.

The default synchronous mode is used.

Current implementation does the following:

          
 int syncMode = getItsNatDocument().getDefaultSyncMode();  
 long ajaxTimeout = getItsNatDocument().getAJAXTimeout();
 return schedule(target,task,time,syncMode,null,null,ajaxTimeout);
 

In fixed-delay execution, each execution is scheduled relative to the actual execution time of the previous execution. If an execution is delayed for any reason, subsequent executions will be delayed as well. In the long run, the frequency of execution will generally be slightly lower than the reciprocal of the specified period.

Fixed-delay execution is appropriate for recurring activities that require "smoothness." In other words, it is appropriate for activities where it is more important to keep the frequency accurate in the short run than in the long run. This includes most animation tasks, such as blinking a cursor at regular intervals. It also includes tasks wherein regular activity is performed in response to human input, such as automatically repeating a character as long as a key is held down.

When the scheduled task is fully finished or cancelled is automatically unregistered.

The default synchronous mode is used.

Current implementation does the following:

          
 int syncMode = getItsNatDocument().getDefaultSyncMode();
 long ajaxTimeout = getItsNatDocument().getAJAXTimeout();        
 return schedule(target,task,firstTime,period,syncMode,null,null,ajaxTimeout);        
 

The default synchronous mode is used.

Current implementation does the following:

          
 int syncMode = getItsNatDocument().getDefaultSyncMode(); 
 long ajaxTimeout = getItsNatDocument().getAJAXTimeout();         
 return schedule(target,task,delay,syncMode,null,null,ajaxTimeout);
 

In fixed-delay execution, each execution is scheduled relative to the actual execution time of the previous execution. If an execution is delayed for any reason, subsequent executions will be delayed as well. In the long run, the frequency of execution will generally be slightly lower than the reciprocal of the specified period.

Fixed-delay execution is appropriate for recurring activities that require "smoothness." In other words, it is appropriate for activities where it is more important to keep the frequency accurate in the short run than in the long run. This includes most animation tasks, such as blinking a cursor at regular intervals. It also includes tasks wherein regular activity is performed in response to human input, such as automatically repeating a character as long as a key is held down.

When the scheduled task is fully finished or cancelled is automatically unregistered.

The default synchronous mode is used.

Current implementation does the following:

          
 int syncMode = getItsNatDocument().getDefaultSyncMode();  
 long ajaxTimeout = getItsNatDocument().getAJAXTimeout();         
 return schedule(target,task,delay,period,syncMode,null,null,ajaxTimeout);
 

In fixed-rate execution, each execution is scheduled relative to the scheduled execution time of the initial execution. If an execution is delayed for any reason, two or more executions will occur in rapid succession to "catch up." In the long run, the frequency of execution will be exactly the reciprocal of the specified period.

Fixed-rate execution is appropriate for recurring activities that are sensitive to absolute time, such as ringing a chime every hour on the hour, or running scheduled maintenance every day at a particular time. It is also appropriate for recurring activities where the total time to perform a fixed number of executions is important, such as a countdown timer that ticks once every second for ten seconds. Finally, fixed-rate execution is appropriate for scheduling multiple repeating timer tasks that must remain synchronized with respect to one another.

When the scheduled task is fully finished or cancelled is automatically unregistered.

The default synchronous mode is used.

Current implementation does the following:

          
 int syncMode = getItsNatDocument().getDefaultSyncMode();        
 long ajaxTimeout = getItsNatDocument().getAJAXTimeout();        
 return scheduleAtFixedRate(target,task,firstTime,period,syncMode,null,null,ajaxTimeout);   
 

In fixed-rate execution, each execution is scheduled relative to the scheduled execution time of the initial execution. If an execution is delayed for any reason, two or more executions will occur in rapid succession to "catch up." In the long run, the frequency of execution will be exactly the reciprocal of the specified period.

Fixed-rate execution is appropriate for recurring activities that are sensitive to absolute time, such as ringing a chime every hour on the hour, or running scheduled maintenance every day at a particular time. It is also appropriate for recurring activities where the total time to perform a fixed number of executions is important, such as a countdown timer that ticks once every second for ten seconds. Finally, fixed-rate execution is appropriate for scheduling multiple repeating timer tasks that must remain synchronized with respect to one another.

When the scheduled task is fully finished or cancelled is automatically unregistered.

The default synchronous mode is used.

Current implementation does the following:

          
 int syncMode = getItsNatDocument().getDefaultSyncMode();        
 long ajaxTimeout = getItsNatDocument().getAJAXTimeout();         
 return scheduleAtFixedRate(target,task,delay,period,syncMode,null,null,ajaxTimeout);